The request is denied because of missing access permissions. Check your permissions and retry your request.
* @public */ export declare class AccessDeniedException extends __BaseException { readonly name: "AccessDeniedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeContains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
* @public */ export type ActionGroupExecutor = ActionGroupExecutor.CustomControlMember | ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember; /** * @public */ export declare namespace ActionGroupExecutor { /** *The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
* @public */ interface LambdaMember { lambda: string; customControl?: never; $unknown?: never; } /** * To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
A parameter for the API request or function.
* @public */ export interface Parameter { /** *The name of the parameter.
* @public */ name?: string | undefined; /** *The type of the parameter.
* @public */ type?: string | undefined; /** *The value of the parameter.
* @public */ value?: string | undefined; } /** *The parameters in the API request body.
* @public */ export interface RequestBody { /** *The content in the request body.
* @public */ content?: RecordContains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.
* @public */ export interface ActionGroupInvocationInput { /** *The name of the action group.
* @public */ actionGroupName?: string | undefined; /** *The API method being used, based off the action group.
* @public */ verb?: string | undefined; /** *The path to the API to call, based off the action group.
* @public */ apiPath?: string | undefined; /** *The parameters in the Lambda input event.
* @public */ parameters?: Parameter[] | undefined; /** *The parameters in the request body for the Lambda input event.
* @public */ requestBody?: RequestBody | undefined; /** *The function in the action group to call.
* @public */ function?: string | undefined; /** *How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
* @public */ executionType?: ExecutionType | undefined; /** *The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.
Contains information of the usage of the foundation model.
* @public */ export interface Usage { /** *Contains information about the input tokens from the foundation model usage.
* @public */ inputTokens?: number | undefined; /** *Contains information about the output tokens from the foundation model usage.
* @public */ outputTokens?: number | undefined; } /** *Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
* @public */ export interface Metadata { /** *In the final response, startTime is the start time of the agent invocation operation.
In the final response, endTime is the end time of the agent invocation operation.
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
* @public */ totalTimeMs?: number | undefined; /** *The total time it took for the agent to complete execution. This field is only set for the final response.
* @public */ operationTotalTimeMs?: number | undefined; /** *A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
* @public */ clientRequestId?: string | undefined; /** *Specific to model invocation and contains details about the usage of a foundation model.
* @public */ usage?: Usage | undefined; } /** *Contains the JSON-formatted string returned by the API invoked by the action group.
* @public */ export interface ActionGroupInvocationOutput { /** *The JSON-formatted string returned by the API invoked by the action group.
* @public */ text?: string | undefined; /** *Contains information about the action group output.
* @public */ metadata?: Metadata | undefined; } /** * @public * @enum */ export declare const ActionGroupSignature: { readonly AMAZON_CODEINTERPRETER: "AMAZON.CodeInterpreter"; readonly AMAZON_USERINPUT: "AMAZON.UserInput"; readonly ANTHROPIC_BASH: "ANTHROPIC.Bash"; readonly ANTHROPIC_COMPUTER: "ANTHROPIC.Computer"; readonly ANTHROPIC_TEXTEDITOR: "ANTHROPIC.TextEditor"; }; /** * @public */ export type ActionGroupSignature = (typeof ActionGroupSignature)[keyof typeof ActionGroupSignature]; /** * @public * @enum */ export declare const ActionInvocationType: { readonly RESULT: "RESULT"; readonly USER_CONFIRMATION: "USER_CONFIRMATION"; readonly USER_CONFIRMATION_AND_RESULT: "USER_CONFIRMATION_AND_RESULT"; }; /** * @public */ export type ActionInvocationType = (typeof ActionInvocationType)[keyof typeof ActionInvocationType]; /** *The identifier information for an Amazon S3 bucket.
* @public */ export interface S3Identifier { /** *The name of the S3 bucket.
* @public */ s3BucketName?: string | undefined; /** *The S3 object key for the S3 resource.
* @public */ s3ObjectKey?: string | undefined; } /** *Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
* @public */ export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema.$UnknownMember; /** * @public */ export declare namespace APISchema { /** *Contains details about the S3 object containing the OpenAPI schema for the action group.
* @public */ interface S3Member { s3: S3Identifier; payload?: never; $unknown?: never; } /** *The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
* @public */ interface PayloadMember { s3?: never; payload: string; $unknown?: never; } /** * @public */ interface $UnknownMember { s3?: never; payload?: never; $unknown: [string, any]; } interface VisitorContains details about a parameter in a function for an action group.
* @public */ export interface ParameterDetail { /** *A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
* @public */ description?: string | undefined; /** *The data type of the parameter.
* @public */ type: ParameterType | undefined; /** *Whether the parameter is required for the agent to complete the function for action group invocation.
* @public */ required?: boolean | undefined; } /** * @public * @enum */ export declare const RequireConfirmation: { readonly DISABLED: "DISABLED"; readonly ENABLED: "ENABLED"; }; /** * @public */ export type RequireConfirmation = (typeof RequireConfirmation)[keyof typeof RequireConfirmation]; /** *Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
* @public */ export interface FunctionDefinition { /** *A name for the function.
* @public */ name: string | undefined; /** *A description of the function and its purpose.
* @public */ description?: string | undefined; /** *The parameters that the agent elicits from the user to fulfill the function.
* @public */ parameters?: RecordContains information if user confirmation is required to invoke the function.
* @public */ requireConfirmation?: RequireConfirmation | undefined; } /** *Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
* @public */ export type FunctionSchema = FunctionSchema.FunctionsMember | FunctionSchema.$UnknownMember; /** * @public */ export declare namespace FunctionSchema { /** *A list of functions that each define an action in the action group.
* @public */ interface FunctionsMember { functions: FunctionDefinition[]; $unknown?: never; } /** * @public */ interface $UnknownMember { functions?: never; $unknown: [string, any]; } interface VisitorContains details of the inline agent's action group.
* @public */ export interface AgentActionGroup { /** *The name of the action group.
* @public */ actionGroupName: string | undefined; /** *A description of the action group.
* @public */ description?: string | undefined; /** *Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.
ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
* @public */ actionGroupExecutor?: ActionGroupExecutor | undefined; /** *Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
* @public */ apiSchema?: APISchema | undefined; /** *Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
* @public */ functionSchema?: FunctionSchema | undefined; /** *The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Details about the source of an input image in the result from a function in the action group invocation.
* @public */ export type ImageInputSource = ImageInputSource.BytesMember | ImageInputSource.$UnknownMember; /** * @public */ export declare namespace ImageInputSource { /** *The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.
* @public */ interface BytesMember { bytes: Uint8Array; $unknown?: never; } /** * @public */ interface $UnknownMember { bytes?: never; $unknown: [string, any]; } interface VisitorDetails about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
* @public */ export interface ImageInput { /** *The type of image in the result.
* @public */ format: ImageInputFormat | undefined; /** *The source of the image in the result.
* @public */ source: ImageInputSource | undefined; } /** *Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the InvokeAgent request
The body of the API response.
* @public */ body?: string | undefined; /** *Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the returnControlInvocationResults must be a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The action group that the API operation belongs to.
* @public */ actionGroup: string | undefined; /** *The HTTP method for the API operation.
* @public */ httpMethod?: string | undefined; /** *The path to the API operation.
* @public */ apiPath?: string | undefined; /** *Controls the API operations or functions to invoke based on the user confirmation.
* @public */ confirmationState?: ConfirmationState | undefined; /** *Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
* @public */ responseState?: ResponseState | undefined; /** *http status code from API execution response (for example: 200, 400, 500).
* @public */ httpStatusCode?: number | undefined; /** *The response body from the API operation. The key of the object is the content type (currently, only TEXT is supported). The response may be returned directly or from the Lambda function.
The agent's ID.
* @public */ agentId?: string | undefined; } /** *Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
The action group that the function belongs to.
* @public */ actionGroup: string | undefined; /** *Contains the user confirmation information about the function that was called.
* @public */ confirmationState?: ConfirmationState | undefined; /** *The name of the function that was called.
* @public */ function?: string | undefined; /** *The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify TEXT or IMAGES. The key of the object is the content type. You can only specify one type. If you specify IMAGES, you can specify only one image. You can specify images only when the function in the returnControlInvocationResults is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
* @public */ responseState?: ResponseState | undefined; /** *The agent's ID.
* @public */ agentId?: string | undefined; } /** *A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
This data type is used in the following API operations:
* @public */ export type InvocationResultMember = InvocationResultMember.ApiResultMember | InvocationResultMember.FunctionResultMember | InvocationResultMember.$UnknownMember; /** * @public */ export declare namespace InvocationResultMember { /** *The result from the API response from the action group invocation.
* @public */ interface ApiResultMember { apiResult: ApiResult; functionResult?: never; $unknown?: never; } /** *The result from the function from the action group invocation.
* @public */ interface FunctionResultMember { apiResult?: never; functionResult: FunctionResult; $unknown?: never; } /** * @public */ interface $UnknownMember { apiResult?: never; functionResult?: never; $unknown: [string, any]; } interface VisitorAn action invocation result.
* @public */ export interface ReturnControlResults { /** *The action's invocation ID.
* @public */ invocationId?: string | undefined; /** *The action invocation result.
* @public */ returnControlInvocationResults?: InvocationResultMember[] | undefined; } /** * @public * @enum */ export declare const PayloadType: { readonly RETURN_CONTROL: "RETURN_CONTROL"; readonly TEXT: "TEXT"; }; /** * @public */ export type PayloadType = (typeof PayloadType)[keyof typeof PayloadType]; /** *Input for an agent collaborator. The input can be text or an action invocation result.
* @public */ export interface AgentCollaboratorInputPayload { /** *The input type.
* @public */ type?: PayloadType | undefined; /** *Input text.
* @public */ text?: string | undefined; /** *An action invocation result.
* @public */ returnControlResults?: ReturnControlResults | undefined; } /** *An agent collaborator invocation input.
* @public */ export interface AgentCollaboratorInvocationInput { /** *The collaborator's name.
* @public */ agentCollaboratorName?: string | undefined; /** *The collaborator's alias ARN.
* @public */ agentCollaboratorAliasArn?: string | undefined; /** *Text or action invocation result input for the collaborator.
* @public */ input?: AgentCollaboratorInputPayload | undefined; } /** *Information about a parameter to provide to the API request.
This data type is used in the following API operations:
* @public */ export interface ApiParameter { /** *The name of the parameter.
* @public */ name?: string | undefined; /** *The data type for the parameter.
* @public */ type?: string | undefined; /** *The value of the parameter.
* @public */ value?: string | undefined; } /** *Contains the parameters in the request body.
* @public */ export interface PropertyParameters { /** *A list of parameters in the request body.
* @public */ properties?: Parameter[] | undefined; } /** *The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
* @public */ export interface ApiRequestBody { /** *The content of the request body. The key of the object in this field is a media type defining the format of the request body.
* @public */ content?: RecordContains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The action group that the API operation belongs to.
* @public */ actionGroup: string | undefined; /** *The HTTP method of the API operation.
* @public */ httpMethod?: string | undefined; /** *The path to the API operation.
* @public */ apiPath?: string | undefined; /** *The parameters to provide for the API request, as the agent elicited from the user.
* @public */ parameters?: ApiParameter[] | undefined; /** *The request body to provide for the API request, as the agent elicited from the user.
* @public */ requestBody?: ApiRequestBody | undefined; /** *Contains information about the API operation to invoke.
* @public */ actionInvocationType?: ActionInvocationType | undefined; /** *The agent's ID.
* @public */ agentId?: string | undefined; /** *The agent collaborator's name.
* @public */ collaboratorName?: string | undefined; } /** *Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The name of the parameter.
* @public */ name?: string | undefined; /** *The data type of the parameter.
* @public */ type?: string | undefined; /** *The value of the parameter.
* @public */ value?: string | undefined; } /** *Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The action group that the function belongs to.
* @public */ actionGroup: string | undefined; /** *A list of parameters of the function.
* @public */ parameters?: FunctionParameter[] | undefined; /** *The name of the function.
* @public */ function?: string | undefined; /** *Contains information about the function to invoke,
* @public */ actionInvocationType?: ActionInvocationType | undefined; /** *The agent's ID.
* @public */ agentId?: string | undefined; /** *The collaborator's name.
* @public */ collaboratorName?: string | undefined; } /** *Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about the API operation that the agent predicts should be called.
* @public */ interface ApiInvocationInputMember { apiInvocationInput: ApiInvocationInput; functionInvocationInput?: never; $unknown?: never; } /** *Contains information about the function that the agent predicts should be called.
* @public */ interface FunctionInvocationInputMember { apiInvocationInput?: never; functionInvocationInput: FunctionInvocationInput; $unknown?: never; } /** * @public */ interface $UnknownMember { apiInvocationInput?: never; functionInvocationInput?: never; $unknown: [string, any]; } interface VisitorContains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
* @public */ export interface ReturnControlPayload { /** *A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
* @public */ invocationInputs?: InvocationInputMember[] | undefined; /** *The identifier of the action group invocation.
* @public */ invocationId?: string | undefined; } /** *Output from an agent collaborator. The output can be text or an action invocation result.
* @public */ export interface AgentCollaboratorOutputPayload { /** *The type of output.
* @public */ type?: PayloadType | undefined; /** *Text output.
* @public */ text?: string | undefined; /** *An action invocation result.
* @public */ returnControlPayload?: ReturnControlPayload | undefined; } /** *Output from an agent collaborator.
* @public */ export interface AgentCollaboratorInvocationOutput { /** *The output's agent collaborator name.
* @public */ agentCollaboratorName?: string | undefined; /** *The output's agent collaborator alias ARN.
* @public */ agentCollaboratorAliasArn?: string | undefined; /** *The output's output.
* @public */ output?: AgentCollaboratorOutputPayload | undefined; /** *Contains information about the output from the agent collaborator.
* @public */ metadata?: Metadata | undefined; } /** * @public */ export interface GetExecutionFlowSnapshotRequest { /** *The unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias used for the flow execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The unique identifier of the flow execution.
* @public */ executionIdentifier: string | undefined; } /** * @public */ export interface GetExecutionFlowSnapshotResponse { /** *The unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias used for the flow execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The version of the flow used for the flow execution.
* @public */ flowVersion: string | undefined; /** *The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.
* @public */ executionRoleArn: string | undefined; /** *The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a FlowDefinition object.
* @public */ definition: string | undefined; /** *The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
* @public */ customerEncryptionKeyArn?: string | undefined; } /** *An internal server error occurred. Retry your request.
* @public */ export declare class InternalServerException extends __BaseException { readonly name: "InternalServerException"; readonly $fault: "server"; /** *The reason for the exception. If the reason is BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE, the model invocation service is unavailable. Retry your request.
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
* @public */ export declare class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe number of requests exceeds the limit. Resubmit your request later.
* @public */ export declare class ThrottlingException extends __BaseException { readonly name: "ThrottlingException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeInput validation failed. Check your request parameters and retry the request.
* @public */ export declare class ValidationException extends __BaseException { readonly name: "ValidationException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias used for the execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The unique identifier of the flow execution to retrieve.
* @public */ executionIdentifier: string | undefined; } /** * @public * @enum */ export declare const FlowExecutionErrorType: { readonly TIMED_OUT: "ExecutionTimedOut"; }; /** * @public */ export type FlowExecutionErrorType = (typeof FlowExecutionErrorType)[keyof typeof FlowExecutionErrorType]; /** *Contains information about an error that occurred during an flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node in the flow where the error occurred (if applicable).
* @public */ nodeName?: string | undefined; /** *The error code for the type of error that occurred.
* @public */ error?: FlowExecutionErrorType | undefined; /** *A descriptive message that provides details about the error.
* @public */ message?: string | undefined; } /** * @public * @enum */ export declare const FlowExecutionStatus: { readonly ABORTED: "Aborted"; readonly FAILED: "Failed"; readonly RUNNING: "Running"; readonly SUCCEEDED: "Succeeded"; readonly TIMED_OUT: "TimedOut"; }; /** * @public */ export type FlowExecutionStatus = (typeof FlowExecutionStatus)[keyof typeof FlowExecutionStatus]; /** * @public */ export interface GetFlowExecutionResponse { /** *The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
* @public */ executionArn: string | undefined; /** *The current status of the flow execution.
Flow executions time out after 24 hours.
* @public */ status: FlowExecutionStatus | undefined; /** *The timestamp when the flow execution started.
* @public */ startedAt: Date | undefined; /** *The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
* @public */ endedAt?: Date | undefined; /** *A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
* @public */ errors?: FlowExecutionError[] | undefined; /** *The unique identifier of the flow alias used for the execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The version of the flow used for the execution.
* @public */ flowVersion: string | undefined; } /** * @public * @enum */ export declare const FlowExecutionEventType: { readonly FLOW: "Flow"; readonly NODE: "Node"; }; /** * @public */ export type FlowExecutionEventType = (typeof FlowExecutionEventType)[keyof typeof FlowExecutionEventType]; /** * @public */ export interface ListFlowExecutionEventsRequest { /** *The unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias used for the execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The unique identifier of the flow execution.
* @public */ executionIdentifier: string | undefined; /** *The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
* @public */ maxResults?: number | undefined; /** *A token to retrieve the next set of results. This value is returned in the response if more results are available.
* @public */ nextToken?: string | undefined; /** *The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.
Represents a condition that was satisfied during a condition node evaluation in a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the condition that was satisfied.
* @public */ conditionName: string | undefined; } /** *Contains information about a condition evaluation result during a flow execution. This event is generated when a condition node in the flow evaluates its conditions.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the condition node that evaluated the conditions.
* @public */ nodeName: string | undefined; /** *The timestamp when the condition evaluation occurred.
* @public */ timestamp: Date | undefined; /** *A list of conditions that were satisfied during the evaluation.
* @public */ satisfiedConditions: SatisfiedCondition[] | undefined; } /** * @public * @enum */ export declare const FlowErrorCode: { readonly INTERNAL_SERVER: "INTERNAL_SERVER"; readonly NODE_EXECUTION_FAILED: "NODE_EXECUTION_FAILED"; readonly VALIDATION: "VALIDATION"; }; /** * @public */ export type FlowErrorCode = (typeof FlowErrorCode)[keyof typeof FlowErrorCode]; /** *Contains information about a failure that occurred at the flow level during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The timestamp when the failure occurred.
* @public */ timestamp: Date | undefined; /** *The error code that identifies the type of failure that occurred.
* @public */ errorCode: FlowErrorCode | undefined; /** *A descriptive message that provides details about the failure.
* @public */ errorMessage: string | undefined; } /** *Contains the content of an flow execution input or output field.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The document content of the field, which can contain text or structured data.
* @public */ interface DocumentMember { document: __DocumentType; $unknown?: never; } /** * @public */ interface $UnknownMember { document?: never; $unknown: [string, any]; } interface VisitorRepresents an input field provided to a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the input field as defined in the flow's input schema.
* @public */ name: string | undefined; /** *The content of the input field, which can contain text or structured data.
* @public */ content: FlowExecutionContent | undefined; } /** *Contains information about the inputs provided to the flow at the start of a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node that receives the inputs.
* @public */ nodeName: string | undefined; /** *The timestamp when the inputs are provided.
* @public */ timestamp: Date | undefined; /** *A list of input fields provided to the flow.
* @public */ fields: FlowInputField[] | undefined; } /** *Represents an output field produced by a flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the output field as defined in the flow's output schema.
* @public */ name: string | undefined; /** *The content of the output field, which can contain text or structured data.
* @public */ content: FlowExecutionContent | undefined; } /** *Contains information about the outputs produced by the flow during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node that produces the outputs.
* @public */ nodeName: string | undefined; /** *The timestamp when the outputs are produced.
* @public */ timestamp: Date | undefined; /** *A list of output fields produced by the flow.
* @public */ fields: FlowOutputField[] | undefined; } /** * @public * @enum */ export declare const NodeErrorCode: { readonly BAD_GATEWAY: "BAD_GATEWAY"; readonly DEPENDENCY_FAILED: "DEPENDENCY_FAILED"; readonly INTERNAL_SERVER: "INTERNAL_SERVER"; readonly VALIDATION: "VALIDATION"; }; /** * @public */ export type NodeErrorCode = (typeof NodeErrorCode)[keyof typeof NodeErrorCode]; /** *Contains information about a failure that occurred at a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node where the failure occurred.
* @public */ nodeName: string | undefined; /** *The timestamp when the node failure occurred.
* @public */ timestamp: Date | undefined; /** *The error code that identifies the type of failure that occurred at the node.
* @public */ errorCode: NodeErrorCode | undefined; /** *A descriptive message that provides details about the node failure.
* @public */ errorMessage: string | undefined; } /** *Contains the content of a flow node's input or output field for a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The document content of the field, which can contain text or structured data.
* @public */ interface DocumentMember { document: __DocumentType; $unknown?: never; } /** * @public */ interface $UnknownMember { document?: never; $unknown: [string, any]; } interface VisitorRepresents an input field provided to a node during a flow execution.
* @public */ export interface NodeInputField { /** *The name of the input field as defined in the node's input schema.
* @public */ name: string | undefined; /** *The content of the input field, which can contain text or structured data.
* @public */ content: NodeExecutionContent | undefined; } /** *Contains information about the inputs provided to a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node that received the inputs.
* @public */ nodeName: string | undefined; /** *The timestamp when the inputs were provided to the node.
* @public */ timestamp: Date | undefined; /** *A list of input fields provided to the node.
* @public */ fields: NodeInputField[] | undefined; } /** *Represents an output field produced by a node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the output field as defined in the node's output schema.
* @public */ name: string | undefined; /** *The content of the output field, which can contain text or structured data.
* @public */ content: NodeExecutionContent | undefined; } /** *Contains information about the outputs produced by a specific node during a flow execution.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The name of the node that produced the outputs.
* @public */ nodeName: string | undefined; /** *The timestamp when the outputs were produced by the node.
* @public */ timestamp: Date | undefined; /** *A list of output fields produced by the node.
* @public */ fields: NodeOutputField[] | undefined; } /** *Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
Contains information about the inputs provided to the flow at the start of execution.
* @public */ interface FlowInputEventMember { flowInputEvent: FlowExecutionInputEvent; flowOutputEvent?: never; nodeInputEvent?: never; nodeOutputEvent?: never; conditionResultEvent?: never; nodeFailureEvent?: never; flowFailureEvent?: never; $unknown?: never; } /** *Contains information about the outputs produced by the flow at the end of execution.
* @public */ interface FlowOutputEventMember { flowInputEvent?: never; flowOutputEvent: FlowExecutionOutputEvent; nodeInputEvent?: never; nodeOutputEvent?: never; conditionResultEvent?: never; nodeFailureEvent?: never; flowFailureEvent?: never; $unknown?: never; } /** *Contains information about the inputs provided to a specific node during execution.
* @public */ interface NodeInputEventMember { flowInputEvent?: never; flowOutputEvent?: never; nodeInputEvent: NodeInputEvent; nodeOutputEvent?: never; conditionResultEvent?: never; nodeFailureEvent?: never; flowFailureEvent?: never; $unknown?: never; } /** *Contains information about the outputs produced by a specific node during execution.
* @public */ interface NodeOutputEventMember { flowInputEvent?: never; flowOutputEvent?: never; nodeInputEvent?: never; nodeOutputEvent: NodeOutputEvent; conditionResultEvent?: never; nodeFailureEvent?: never; flowFailureEvent?: never; $unknown?: never; } /** *Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.
* @public */ interface ConditionResultEventMember { flowInputEvent?: never; flowOutputEvent?: never; nodeInputEvent?: never; nodeOutputEvent?: never; conditionResultEvent: ConditionResultEvent; nodeFailureEvent?: never; flowFailureEvent?: never; $unknown?: never; } /** *Contains information about a failure that occurred at a specific node during execution.
* @public */ interface NodeFailureEventMember { flowInputEvent?: never; flowOutputEvent?: never; nodeInputEvent?: never; nodeOutputEvent?: never; conditionResultEvent?: never; nodeFailureEvent: NodeFailureEvent; flowFailureEvent?: never; $unknown?: never; } /** *Contains information about a failure that occurred at the flow level during execution.
* @public */ interface FlowFailureEventMember { flowInputEvent?: never; flowOutputEvent?: never; nodeInputEvent?: never; nodeOutputEvent?: never; conditionResultEvent?: never; nodeFailureEvent?: never; flowFailureEvent: FlowFailureEvent; $unknown?: never; } /** * @public */ interface $UnknownMember { flowInputEvent?: never; flowOutputEvent?: never; nodeInputEvent?: never; nodeOutputEvent?: never; conditionResultEvent?: never; nodeFailureEvent?: never; flowFailureEvent?: never; $unknown: [string, any]; } interface VisitorA list of events that occurred during the flow execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.
* @public */ flowExecutionEvents: FlowExecutionEvent[] | undefined; /** *A token to retrieve the next set of results. This value is returned if more results are available.
* @public */ nextToken?: string | undefined; } /** * @public */ export interface ListFlowExecutionsRequest { /** *The unique identifier of the flow to list executions for.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias to list executions for.
* @public */ flowAliasIdentifier?: string | undefined; /** *The maximum number of flow executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
A token to retrieve the next set of results. This value is returned in the response if more results are available.
* @public */ nextToken?: string | undefined; } /** *Contains summary information about a flow execution, including its status, timestamps, and identifiers.
Flow executions is in preview release for Amazon Bedrock and is subject to change.
The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
* @public */ executionArn: string | undefined; /** *The unique identifier of the flow alias used for the execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The version of the flow used for the execution.
* @public */ flowVersion: string | undefined; /** *The current status of the flow execution.
Flow executions time out after 24 hours.
* @public */ status: FlowExecutionStatus | undefined; /** *The timestamp when the flow execution was created.
* @public */ createdAt: Date | undefined; /** *The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
* @public */ endedAt?: Date | undefined; } /** * @public */ export interface ListFlowExecutionsResponse { /** *A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
* @public */ flowExecutionSummaries: FlowExecutionSummary[] | undefined; /** *A token to retrieve the next set of results. This value is returned if more results are available.
* @public */ nextToken?: string | undefined; } /** *There was an issue with a dependency due to a server issue. Retry your request.
* @public */ export declare class BadGatewayException extends __BaseException { readonly name: "BadGatewayException"; readonly $fault: "server"; /** *The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
* @public */ resourceName?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeThere was a conflict performing an operation. Resolve the conflict and retry your request.
* @public */ export declare class ConflictException extends __BaseException { readonly name: "ConflictException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeThere was an issue with a dependency. Check the resource configurations and retry the request.
* @public */ export declare class DependencyFailedException extends __BaseException { readonly name: "DependencyFailedException"; readonly $fault: "client"; /** *The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
* @public */ resourceName?: string | undefined; /** * @internal */ constructor(opts: __ExceptionOptionTypeThe number of requests exceeds the service quota. Resubmit your request later.
* @public */ export declare class ServiceQuotaExceededException extends __BaseException { readonly name: "ServiceQuotaExceededException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeContains information about an input into the flow.
* @public */ export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputContent.$UnknownMember; /** * @public */ export declare namespace FlowInputContent { /** *The input to send to the prompt flow input node.
* @public */ interface DocumentMember { document: __DocumentType; $unknown?: never; } /** * @public */ interface $UnknownMember { document?: never; $unknown: [string, any]; } interface VisitorContains information about an input into the prompt flow and where to send it.
* @public */ export interface FlowInput { /** *The name of the flow input node that begins the prompt flow.
* @public */ nodeName: string | undefined; /** *The name of the output from the flow input node that begins the prompt flow.
* @public */ nodeOutputName?: string | undefined; /** *Contains information about an input into the prompt flow.
* @public */ content: FlowInputContent | undefined; /** *The name of the input from the flow input node.
* @public */ nodeInputName?: string | undefined; } /** * @public * @enum */ export declare const PerformanceConfigLatency: { readonly OPTIMIZED: "optimized"; readonly STANDARD: "standard"; }; /** * @public */ export type PerformanceConfigLatency = (typeof PerformanceConfigLatency)[keyof typeof PerformanceConfigLatency]; /** *Performance settings for a model.
* @public */ export interface PerformanceConfiguration { /** *To use a latency-optimized version of the model, set to optimized.
The performance configuration for a model called with InvokeFlow.
* @public */ export interface ModelPerformanceConfiguration { /** *The latency configuration for the model.
* @public */ performanceConfig?: PerformanceConfiguration | undefined; } /** * @public */ export interface StartFlowExecutionRequest { /** *The unique identifier of the flow to execute.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias to use for the flow execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The unique name for the flow execution. If you don't provide one, a system-generated name is used.
* @public */ flowExecutionName?: string | undefined; /** *The input data required for the flow execution. This must match the input schema defined in the flow.
* @public */ inputs: FlowInput[] | undefined; /** *The performance settings for the foundation model used in the flow execution.
* @public */ modelPerformanceConfiguration?: ModelPerformanceConfiguration | undefined; } /** * @public */ export interface StartFlowExecutionResponse { /** *The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
* @public */ executionArn?: string | undefined; } /** * @public */ export interface StopFlowExecutionRequest { /** *The unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias used for the execution.
* @public */ flowAliasIdentifier: string | undefined; /** *The unique identifier of the flow execution to stop.
* @public */ executionIdentifier: string | undefined; } /** * @public */ export interface StopFlowExecutionResponse { /** *The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.
* @public */ executionArn?: string | undefined; /** *The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
* @public */ status: FlowExecutionStatus | undefined; } /** * @public */ export interface InvokeFlowRequest { /** *The unique identifier of the flow.
* @public */ flowIdentifier: string | undefined; /** *The unique identifier of the flow alias.
* @public */ flowAliasIdentifier: string | undefined; /** *A list of objects, each containing information about an input into the flow.
* @public */ inputs: FlowInput[] | undefined; /** *Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ enableTrace?: boolean | undefined; /** *Model performance settings for the request.
* @public */ modelPerformanceConfiguration?: ModelPerformanceConfiguration | undefined; /** *The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
* @public */ executionId?: string | undefined; } /** * @public * @enum */ export declare const FlowCompletionReason: { readonly INPUT_REQUIRED: "INPUT_REQUIRED"; readonly SUCCESS: "SUCCESS"; }; /** * @public */ export type FlowCompletionReason = (typeof FlowCompletionReason)[keyof typeof FlowCompletionReason]; /** *Contains information about why a flow completed.
* @public */ export interface FlowCompletionEvent { /** *The reason that the flow completed.
* @public */ completionReason: FlowCompletionReason | undefined; } /** *The content structure containing input information for multi-turn flow interactions.
* @public */ export type FlowMultiTurnInputContent = FlowMultiTurnInputContent.DocumentMember | FlowMultiTurnInputContent.$UnknownMember; /** * @public */ export declare namespace FlowMultiTurnInputContent { /** *The requested additional input to send back to the multi-turn flow node.
* @public */ interface DocumentMember { document: __DocumentType; $unknown?: never; } /** * @public */ interface $UnknownMember { document?: never; $unknown: [string, any]; } interface VisitorResponse object from the flow multi-turn node requesting additional information.
* @public */ export interface FlowMultiTurnInputRequestEvent { /** *The name of the node in the flow that is requesting the input.
* @public */ nodeName: string | undefined; /** *The type of the node in the flow that is requesting the input.
* @public */ nodeType: NodeType | undefined; /** *The content payload containing the input request details for the multi-turn interaction.
* @public */ content: FlowMultiTurnInputContent | undefined; } /** *Contains information about the content in an output from prompt flow invocation.
* @public */ export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember; /** * @public */ export declare namespace FlowOutputContent { /** *The content in the output.
* @public */ interface DocumentMember { document: __DocumentType; $unknown?: never; } /** * @public */ interface $UnknownMember { document?: never; $unknown: [string, any]; } interface VisitorContains information about an output from prompt flow invoction.
* @public */ export interface FlowOutputEvent { /** *The name of the flow output node that the output is from.
* @public */ nodeName: string | undefined; /** *The type of the node that the output is from.
* @public */ nodeType: NodeType | undefined; /** *The content in the output.
* @public */ content: FlowOutputContent | undefined; } /** *Contains information about a condition that was satisfied. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export interface FlowTraceCondition { /** *The name of the condition.
* @public */ conditionName: string | undefined; } /** *Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export interface FlowTraceConditionNodeResultEvent { /** *The name of the condition node.
* @public */ nodeName: string | undefined; /** *The date and time that the trace was returned.
* @public */ timestamp: Date | undefined; /** *An array of objects containing information about the conditions that were satisfied.
* @public */ satisfiedConditions: FlowTraceCondition[] | undefined; } /** *Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.
* @public */ export interface FlowTraceNodeActionEvent { /** *The name of the node that called the operation.
* @public */ nodeName: string | undefined; /** *The date and time that the operation was called.
* @public */ timestamp: Date | undefined; /** *The ID of the request that the node made to the operation.
* @public */ requestId: string | undefined; /** *The name of the service that the node called.
* @public */ serviceName: string | undefined; /** *The name of the operation that the node called.
* @public */ operationName: string | undefined; } /** *Contains the content of the node input. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export type FlowTraceNodeInputContent = FlowTraceNodeInputContent.DocumentMember | FlowTraceNodeInputContent.$UnknownMember; /** * @public */ export declare namespace FlowTraceNodeInputContent { /** *The content of the node input.
* @public */ interface DocumentMember { document: __DocumentType; $unknown?: never; } /** * @public */ interface $UnknownMember { document?: never; $unknown: [string, any]; } interface VisitorContains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export interface FlowTraceNodeInputField { /** *The name of the node input.
* @public */ nodeInputName: string | undefined; /** *The content of the node input.
* @public */ content: FlowTraceNodeInputContent | undefined; } /** *Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export interface FlowTraceNodeInputEvent { /** *The name of the node that received the input.
* @public */ nodeName: string | undefined; /** *The date and time that the trace was returned.
* @public */ timestamp: Date | undefined; /** *An array of objects containing information about each field in the input.
* @public */ fields: FlowTraceNodeInputField[] | undefined; } /** *Contains the content of the node output. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export type FlowTraceNodeOutputContent = FlowTraceNodeOutputContent.DocumentMember | FlowTraceNodeOutputContent.$UnknownMember; /** * @public */ export declare namespace FlowTraceNodeOutputContent { /** *The content of the node output.
* @public */ interface DocumentMember { document: __DocumentType; $unknown?: never; } /** * @public */ interface $UnknownMember { document?: never; $unknown: [string, any]; } interface VisitorContains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export interface FlowTraceNodeOutputField { /** *The name of the node output.
* @public */ nodeOutputName: string | undefined; /** *The content of the node output.
* @public */ content: FlowTraceNodeOutputContent | undefined; } /** *Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export interface FlowTraceNodeOutputEvent { /** *The name of the node that yielded the output.
* @public */ nodeName: string | undefined; /** *The date and time that the trace was returned.
* @public */ timestamp: Date | undefined; /** *An array of objects containing information about each field in the output.
* @public */ fields: FlowTraceNodeOutputField[] | undefined; } /** *Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export type FlowTrace = FlowTrace.ConditionNodeResultTraceMember | FlowTrace.NodeActionTraceMember | FlowTrace.NodeInputTraceMember | FlowTrace.NodeOutputTraceMember | FlowTrace.$UnknownMember; /** * @public */ export declare namespace FlowTrace { /** *Contains information about the input into a node.
* @public */ interface NodeInputTraceMember { nodeInputTrace: FlowTraceNodeInputEvent; nodeOutputTrace?: never; conditionNodeResultTrace?: never; nodeActionTrace?: never; $unknown?: never; } /** *Contains information about the output from a node.
* @public */ interface NodeOutputTraceMember { nodeInputTrace?: never; nodeOutputTrace: FlowTraceNodeOutputEvent; conditionNodeResultTrace?: never; nodeActionTrace?: never; $unknown?: never; } /** *Contains information about an output from a condition node.
* @public */ interface ConditionNodeResultTraceMember { nodeInputTrace?: never; nodeOutputTrace?: never; conditionNodeResultTrace: FlowTraceConditionNodeResultEvent; nodeActionTrace?: never; $unknown?: never; } /** *Contains information about an action (operation) called by a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ interface NodeActionTraceMember { nodeInputTrace?: never; nodeOutputTrace?: never; conditionNodeResultTrace?: never; nodeActionTrace: FlowTraceNodeActionEvent; $unknown?: never; } /** * @public */ interface $UnknownMember { nodeInputTrace?: never; nodeOutputTrace?: never; conditionNodeResultTrace?: never; nodeActionTrace?: never; $unknown: [string, any]; } interface VisitorContains information about a trace, which tracks an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
* @public */ export interface FlowTraceEvent { /** *The trace object containing information about an input or output for a node in the flow.
* @public */ trace: FlowTrace | undefined; } /** *The output of the flow.
* @public */ export type FlowResponseStream = FlowResponseStream.AccessDeniedExceptionMember | FlowResponseStream.BadGatewayExceptionMember | FlowResponseStream.ConflictExceptionMember | FlowResponseStream.DependencyFailedExceptionMember | FlowResponseStream.FlowCompletionEventMember | FlowResponseStream.FlowMultiTurnInputRequestEventMember | FlowResponseStream.FlowOutputEventMember | FlowResponseStream.FlowTraceEventMember | FlowResponseStream.InternalServerExceptionMember | FlowResponseStream.ResourceNotFoundExceptionMember | FlowResponseStream.ServiceQuotaExceededExceptionMember | FlowResponseStream.ThrottlingExceptionMember | FlowResponseStream.ValidationExceptionMember | FlowResponseStream.$UnknownMember; /** * @public */ export declare namespace FlowResponseStream { /** *Contains information about an output from flow invocation.
* @public */ interface FlowOutputEventMember { flowOutputEvent: FlowOutputEvent; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *Contains information about why the flow completed.
* @public */ interface FlowCompletionEventMember { flowOutputEvent?: never; flowCompletionEvent: FlowCompletionEvent; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *Contains information about a trace, which tracks an input or output for a node in the flow.
* @public */ interface FlowTraceEventMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent: FlowTraceEvent; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *An internal server error occurred. Retry your request.
* @public */ interface InternalServerExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException: InternalServerException; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *Input validation failed. Check your request parameters and retry the request.
* @public */ interface ValidationExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException: ValidationException; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
* @public */ interface ResourceNotFoundExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException: ResourceNotFoundException; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *The number of requests exceeds the service quota. Resubmit your request later.
* @public */ interface ServiceQuotaExceededExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException: ServiceQuotaExceededException; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *The number of requests exceeds the limit. Resubmit your request later.
* @public */ interface ThrottlingExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException: ThrottlingException; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *The request is denied because of missing access permissions. Check your permissions and retry your request.
* @public */ interface AccessDeniedExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException: AccessDeniedException; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *There was a conflict performing an operation. Resolve the conflict and retry your request.
* @public */ interface ConflictExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException: ConflictException; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *There was an issue with a dependency. Check the resource configurations and retry the request.
* @public */ interface DependencyFailedExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException: DependencyFailedException; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *There was an issue with a dependency due to a server issue. Retry your request.
* @public */ interface BadGatewayExceptionMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException: BadGatewayException; flowMultiTurnInputRequestEvent?: never; $unknown?: never; } /** *The event stream containing the multi-turn input request information from the flow.
* @public */ interface FlowMultiTurnInputRequestEventMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent: FlowMultiTurnInputRequestEvent; $unknown?: never; } /** * @public */ interface $UnknownMember { flowOutputEvent?: never; flowCompletionEvent?: never; flowTraceEvent?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; flowMultiTurnInputRequestEvent?: never; $unknown: [string, any]; } interface VisitorThe output of the flow, returned as a stream. If there's an error, the error is returned.
* @public */ responseStream: AsyncIterableThe unique identifier for the current flow execution.
* @public */ executionId?: string | undefined; } /** * @public * @enum */ export declare const InputQueryType: { readonly TEXT: "TEXT"; }; /** * @public */ export type InputQueryType = (typeof InputQueryType)[keyof typeof InputQueryType]; /** *Contains information about a natural language query to transform into SQL.
* @public */ export interface QueryGenerationInput { /** *The type of the query.
* @public */ type: InputQueryType | undefined; /** *The text of the query.
* @public */ text: string | undefined; } /** * @public * @enum */ export declare const QueryTransformationMode: { readonly TEXT_TO_SQL: "TEXT_TO_SQL"; }; /** * @public */ export type QueryTransformationMode = (typeof QueryTransformationMode)[keyof typeof QueryTransformationMode]; /** *Contains configurations for a knowledge base to use in transformation.
* @public */ export interface TextToSqlKnowledgeBaseConfiguration { /** *The ARN of the knowledge base
* @public */ knowledgeBaseArn: string | undefined; } /** * @public * @enum */ export declare const TextToSqlConfigurationType: { readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE"; }; /** * @public */ export type TextToSqlConfigurationType = (typeof TextToSqlConfigurationType)[keyof typeof TextToSqlConfigurationType]; /** *Contains configurations for transforming text to SQL.
* @public */ export interface TextToSqlConfiguration { /** *The type of resource to use in transformation.
* @public */ type: TextToSqlConfigurationType | undefined; /** *Specifies configurations for a knowledge base to use in transformation.
* @public */ knowledgeBaseConfiguration?: TextToSqlKnowledgeBaseConfiguration | undefined; } /** *Contains configurations for transforming the natural language query into SQL.
* @public */ export interface TransformationConfiguration { /** *The mode of the transformation.
* @public */ mode: QueryTransformationMode | undefined; /** *Specifies configurations for transforming text to SQL.
* @public */ textToSqlConfiguration?: TextToSqlConfiguration | undefined; } /** * @public */ export interface GenerateQueryRequest { /** *Specifies information about a natural language query to transform into SQL.
* @public */ queryGenerationInput: QueryGenerationInput | undefined; /** *Specifies configurations for transforming the natural language query into SQL.
* @public */ transformationConfiguration: TransformationConfiguration | undefined; } /** * @public * @enum */ export declare const GeneratedQueryType: { readonly REDSHIFT_SQL: "REDSHIFT_SQL"; }; /** * @public */ export type GeneratedQueryType = (typeof GeneratedQueryType)[keyof typeof GeneratedQueryType]; /** *Contains information about a query generated for a natural language query.
* @public */ export interface GeneratedQuery { /** *The type of transformed query.
* @public */ type?: GeneratedQueryType | undefined; /** *An SQL query that corresponds to the natural language query.
* @public */ sql?: string | undefined; } /** * @public */ export interface GenerateQueryResponse { /** *A list of objects, each of which defines a generated query that can correspond to the natural language queries.
* @public */ queries?: GeneratedQuery[] | undefined; } /** *Settings for a model called with InvokeAgent.
* @public */ export interface BedrockModelConfigurations { /** *The performance configuration for the model.
* @public */ performanceConfig?: PerformanceConfiguration | undefined; } /** *Specifies parameters that control how the service populates the agent prompt for an InvokeAgent or InvokeInlineAgent request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
The number of previous conversations from the ongoing agent session to include in the conversation history of the agent prompt, during the current invocation. This gives you more granular control over the context that the model is made aware of, and helps the model remove older context which is no longer useful during the ongoing agent session.
* @public */ previousConversationTurnsToInclude?: number | undefined; /** *If true, the service removes any content between <thinking> tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is false.
A content block.
* @public */ export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember; /** * @public */ export declare namespace ContentBlock { /** *The block's text.
* @public */ interface TextMember { text: string; $unknown?: never; } /** * @public */ interface $UnknownMember { text?: never; $unknown: [string, any]; } interface VisitorDetails about a message.
* @public */ export interface Message { /** *The message's role.
* @public */ role: ConversationRole | undefined; /** *The message's content.
* @public */ content: ContentBlock[] | undefined; } /** *A conversation history.
* @public */ export interface ConversationHistory { /** *The conversation's messages.
* @public */ messages?: Message[] | undefined; } /** *The property contains the file to chat with, along with its attributes.
* @public */ export interface ByteContentFile { /** *The MIME type of data contained in the file used for chat.
* @public */ mediaType: string | undefined; /** *The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.
* @public */ data: Uint8Array | undefined; } /** *Contains details of the s3 object where the source file is located.
* @public */ export interface S3ObjectFile { /** *The uri of the s3 object.
* @public */ uri: string | undefined; } /** * @public * @enum */ export declare const FileSourceType: { readonly BYTE_CONTENT: "BYTE_CONTENT"; readonly S3: "S3"; }; /** * @public */ export type FileSourceType = (typeof FileSourceType)[keyof typeof FileSourceType]; /** *The source file of the content contained in the wrapper object.
* @public */ export interface FileSource { /** *The source type of the files to attach.
* @public */ sourceType: FileSourceType | undefined; /** *The s3 location of the files to attach.
* @public */ s3Location?: S3ObjectFile | undefined; /** *The data and the text of the attached files.
* @public */ byteContent?: ByteContentFile | undefined; } /** * @public * @enum */ export declare const FileUseCase: { readonly CHAT: "CHAT"; readonly CODE_INTERPRETER: "CODE_INTERPRETER"; }; /** * @public */ export type FileUseCase = (typeof FileUseCase)[keyof typeof FileUseCase]; /** *Contains details of the source files.
* @public */ export interface InputFile { /** *The name of the source file.
* @public */ name: string | undefined; /** *Specifies where the files are located.
* @public */ source: FileSource | undefined; /** *Specifies how the source files will be used by the code interpreter.
* @public */ useCase: FileUseCase | undefined; } /** *Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
This data type is used in the following API operations:
* @public */ export interface FilterAttribute { /** *The name that the metadata attribute must match.
* @public */ key: string | undefined; /** *The value to whcih to compare the value of the metadata attribute.
* @public */ value: __DocumentType | undefined; } /** * @public * @enum */ export declare const AttributeType: { readonly BOOLEAN: "BOOLEAN"; readonly NUMBER: "NUMBER"; readonly STRING: "STRING"; readonly STRING_LIST: "STRING_LIST"; }; /** * @public */ export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType]; /** *Details about a metadata attribute.
* @public */ export interface MetadataAttributeSchema { /** *The attribute's key.
* @public */ key: string | undefined; /** *The attribute's type.
* @public */ type: AttributeType | undefined; /** *The attribute's description.
* @public */ description: string | undefined; } /** *Settings for implicit filtering, where a model generates a metadata filter based on the prompt.
* @public */ export interface ImplicitFilterConfiguration { /** *Metadata that can be used in a filter.
* @public */ metadataAttributes: MetadataAttributeSchema[] | undefined; /** *The model that generates the filter.
* @public */ modelArn: string | undefined; } /** * @public * @enum */ export declare const SearchType: { readonly HYBRID: "HYBRID"; readonly SEMANTIC: "SEMANTIC"; }; /** * @public */ export type SearchType = (typeof SearchType)[keyof typeof SearchType]; /** * @public * @enum */ export declare const RerankingMetadataSelectionMode: { readonly ALL: "ALL"; readonly SELECTIVE: "SELECTIVE"; }; /** * @public */ export type RerankingMetadataSelectionMode = (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode]; /** *Contains information for a metadata field to include in or exclude from consideration when reranking.
* @public */ export interface FieldForReranking { /** *The name of a metadata field to include in or exclude from consideration when reranking.
* @public */ fieldName: string | undefined; } /** *Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.
An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
* @public */ interface FieldsToIncludeMember { fieldsToInclude: FieldForReranking[]; fieldsToExclude?: never; $unknown?: never; } /** *An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
* @public */ interface FieldsToExcludeMember { fieldsToInclude?: never; fieldsToExclude: FieldForReranking[]; $unknown?: never; } /** * @public */ interface $UnknownMember { fieldsToInclude?: never; fieldsToExclude?: never; $unknown: [string, any]; } interface VisitorContains configurations for the metadata to use in reranking.
* @public */ export interface MetadataConfigurationForReranking { /** *Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.
Contains configurations for the metadata fields to include or exclude when considering reranking.
* @public */ selectiveModeConfiguration?: RerankingMetadataSelectiveModeConfiguration | undefined; } /** *Contains configurations for an Amazon Bedrock reranker model.
* @public */ export interface VectorSearchBedrockRerankingModelConfiguration { /** *The ARN of the reranker model to use.
* @public */ modelArn: string | undefined; /** *A JSON object whose keys are request fields for the model and whose values are values for those fields.
* @public */ additionalModelRequestFields?: RecordContains configurations for reranking with an Amazon Bedrock reranker model.
* @public */ export interface VectorSearchBedrockRerankingConfiguration { /** *Contains configurations for the reranker model.
* @public */ modelConfiguration: VectorSearchBedrockRerankingModelConfiguration | undefined; /** *The number of results to return after reranking.
* @public */ numberOfRerankedResults?: number | undefined; /** *Contains configurations for the metadata to use in reranking.
* @public */ metadataConfiguration?: MetadataConfigurationForReranking | undefined; } /** * @public * @enum */ export declare const VectorSearchRerankingConfigurationType: { readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL"; }; /** * @public */ export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType]; /** *Contains configurations for reranking the retrieved results.
* @public */ export interface VectorSearchRerankingConfiguration { /** *The type of reranker model.
* @public */ type: VectorSearchRerankingConfigurationType | undefined; /** *Contains configurations for an Amazon Bedrock reranker model.
* @public */ bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined; } /** *Configurations for streaming.
* @public */ export interface StreamingConfigurations { /** * Specifies whether to enable streaming for the final response. This is set to false by default.
The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.
Example response in chunks: Interval set to 3 characters
'Hel', 'lo, ','I am', ' an', ' Age', 'nt'
Each chunk has at least 3 characters except for the last chunk
Example response in chunks: Interval set to 20 or more characters
Hello, I am an Agent
Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the span field
InvokeAgent response – in the span field
Where the text with a citation starts in the generated output.
* @public */ start?: number | undefined; /** *Where the text with a citation ends in the generated output.
* @public */ end?: number | undefined; } /** *Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the textResponsePart field
InvokeAgent response – in the textResponsePart field
The part of the generated text that contains a citation.
* @public */ text?: string | undefined; /** *Contains information about where the text with a citation begins and ends in the generated output.
* @public */ span?: Span | undefined; } /** *Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response – in the generatedResponsePart field
RetrieveAndGenerate response – in the generatedResponsePart field
Contains metadata about a textual part of the generated response that is accompanied by a citation.
* @public */ textResponsePart?: TextResponsePart | undefined; } /** * @public * @enum */ export declare const RetrievalResultContentColumnType: { readonly BLOB: "BLOB"; readonly BOOLEAN: "BOOLEAN"; readonly DOUBLE: "DOUBLE"; readonly LONG: "LONG"; readonly NULL: "NULL"; readonly STRING: "STRING"; }; /** * @public */ export type RetrievalResultContentColumnType = (typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType]; /** *Contains information about a column with a cell to return in retrieval.
* @public */ export interface RetrievalResultContentColumn { /** *The name of the column.
* @public */ columnName?: string | undefined; /** *The value in the column.
* @public */ columnValue?: string | undefined; /** *The data type of the value.
* @public */ type?: RetrievalResultContentColumnType | undefined; } /** * @public * @enum */ export declare const RetrievalResultContentType: { readonly IMAGE: "IMAGE"; readonly ROW: "ROW"; readonly TEXT: "TEXT"; }; /** * @public */ export type RetrievalResultContentType = (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType]; /** *Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
This data type is used in the following API operations:
Retrieve response – in the content field
RetrieveAndGenerate response – in the content field
InvokeAgent response – in the content field
The type of content in the retrieval result.
* @public */ type?: RetrievalResultContentType | undefined; /** *The cited text from the data source.
* @public */ text?: string | undefined; /** *A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,$\{base64-encoded string\}.
Specifies information about the rows with the cells to return in retrieval.
* @public */ row?: RetrievalResultContentColumn[] | undefined; } /** *The Confluence data source location.
* @public */ export interface RetrievalResultConfluenceLocation { /** *The Confluence host URL for the data source location.
* @public */ url?: string | undefined; } /** *Contains information about the location of a document in a custom data source.
* @public */ export interface RetrievalResultCustomDocumentLocation { /** *The ID of the document.
* @public */ id?: string | undefined; } /** *The location of a result in Amazon Kendra.
* @public */ export interface RetrievalResultKendraDocumentLocation { /** *The document's uri.
* @public */ uri?: string | undefined; } /** *The S3 data source location.
This data type is used in the following API operations:
Retrieve response – in the s3Location field
RetrieveAndGenerate response – in the s3Location field
InvokeAgent response – in the s3Location field
The S3 URI for the data source location.
* @public */ uri?: string | undefined; } /** *The Salesforce data source location.
* @public */ export interface RetrievalResultSalesforceLocation { /** *The Salesforce host URL for the data source location.
* @public */ url?: string | undefined; } /** *The SharePoint data source location.
* @public */ export interface RetrievalResultSharePointLocation { /** *The SharePoint site URL for the data source location.
* @public */ url?: string | undefined; } /** *Contains information about the SQL query used to retrieve the result.
* @public */ export interface RetrievalResultSqlLocation { /** *The SQL query used to retrieve the result.
* @public */ query?: string | undefined; } /** * @public * @enum */ export declare const RetrievalResultLocationType: { readonly CONFLUENCE: "CONFLUENCE"; readonly CUSTOM: "CUSTOM"; readonly KENDRA: "KENDRA"; readonly S3: "S3"; readonly SALESFORCE: "SALESFORCE"; readonly SHAREPOINT: "SHAREPOINT"; readonly SQL: "SQL"; readonly WEB: "WEB"; }; /** * @public */ export type RetrievalResultLocationType = (typeof RetrievalResultLocationType)[keyof typeof RetrievalResultLocationType]; /** *The web URL/URLs data source location.
* @public */ export interface RetrievalResultWebLocation { /** *The web URL/URLs for the data source location.
* @public */ url?: string | undefined; } /** *Contains information about the data source location.
This data type is used in the following API operations:
Retrieve response – in the location field
RetrieveAndGenerate response – in the location field
InvokeAgent response – in the location field
The type of data source location.
* @public */ type: RetrievalResultLocationType | undefined; /** *The S3 data source location.
* @public */ s3Location?: RetrievalResultS3Location | undefined; /** *The web URL/URLs data source location.
* @public */ webLocation?: RetrievalResultWebLocation | undefined; /** *The Confluence data source location.
* @public */ confluenceLocation?: RetrievalResultConfluenceLocation | undefined; /** *The Salesforce data source location.
* @public */ salesforceLocation?: RetrievalResultSalesforceLocation | undefined; /** *The SharePoint data source location.
* @public */ sharePointLocation?: RetrievalResultSharePointLocation | undefined; /** *Specifies the location of a document in a custom data source.
* @public */ customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined; /** *The location of a document in Amazon Kendra.
* @public */ kendraDocumentLocation?: RetrievalResultKendraDocumentLocation | undefined; /** *Specifies information about the SQL query used to retrieve the result.
* @public */ sqlLocation?: RetrievalResultSqlLocation | undefined; } /** *Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the retrievedReferences field
InvokeAgent response – in the retrievedReferences field
Contains the cited text from the data source.
* @public */ content?: RetrievalResultContent | undefined; /** *Contains information about the location of the data source.
* @public */ location?: RetrievalResultLocation | undefined; /** *Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
* @public */ metadata?: RecordAn object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response – in the citations field
RetrieveAndGenerate response – in the citations field
Contains the generated response and metadata
* @public */ generatedResponsePart?: GeneratedResponsePart | undefined; /** *Contains metadata about the sources cited for the generated response.
* @public */ retrievedReferences?: RetrievedReference[] | undefined; } /** *Contains citations for a part of an agent response.
* @public */ export interface Attribution { /** *A list of citations and related information for a part of an agent response.
* @public */ citations?: Citation[] | undefined; } /** *Contains a part of an agent response and citations for it.
* @public */ export interface PayloadPart { /** *A part of the agent response in bytes.
* @public */ bytes?: Uint8Array | undefined; /** *Contains citations for a part of an agent response.
* @public */ attribution?: Attribution | undefined; } /** *Contains details of the response from code interpreter.
* @public */ export interface OutputFile { /** *The name of the file containing response from code interpreter.
* @public */ name?: string | undefined; /** *The type of file that contains response from the code interpreter.
* @public */ type?: string | undefined; /** *The byte count of files that contains response from code interpreter.
* @public */ bytes?: Uint8Array | undefined; } /** *Contains intermediate response for code interpreter if any files have been generated.
* @public */ export interface FilePart { /** *Files containing intermediate response for the user.
* @public */ files?: OutputFile[] | undefined; } /** *The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
* @public */ export declare class ModelNotReadyException extends __BaseException { readonly name: "ModelNotReadyException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionTypeDetails about a caller.
* @public */ export type Caller = Caller.AgentAliasArnMember | Caller.$UnknownMember; /** * @public */ export declare namespace Caller { /** *The caller's agent alias ARN.
* @public */ interface AgentAliasArnMember { agentAliasArn: string; $unknown?: never; } /** * @public */ interface $UnknownMember { agentAliasArn?: never; $unknown: [string, any]; } interface VisitorThe event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
* @public */ export interface CustomOrchestrationTraceEvent { /** *The text that prompted the event at this step.
* @public */ text?: string | undefined; } /** *The trace behavior for the custom orchestration.
* @public */ export interface CustomOrchestrationTrace { /** *The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *The event details used with the custom orchestration.
* @public */ event?: CustomOrchestrationTraceEvent | undefined; } /** *Contains information about the failure of the interaction.
* @public */ export interface FailureTrace { /** *The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *The reason the interaction failed.
* @public */ failureReason?: string | undefined; /** *The failure code for the trace.
* @public */ failureCode?: number | undefined; /** *Information about the failure that occurred.
* @public */ metadata?: Metadata | undefined; } /** * @public * @enum */ export declare const GuardrailAction: { readonly INTERVENED: "INTERVENED"; readonly NONE: "NONE"; }; /** * @public */ export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction]; /** * @public * @enum */ export declare const GuardrailContentPolicyAction: { readonly BLOCKED: "BLOCKED"; }; /** * @public */ export type GuardrailContentPolicyAction = (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction]; /** * @public * @enum */ export declare const GuardrailContentFilterConfidence: { readonly HIGH: "HIGH"; readonly LOW: "LOW"; readonly MEDIUM: "MEDIUM"; readonly NONE: "NONE"; }; /** * @public */ export type GuardrailContentFilterConfidence = (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence]; /** * @public * @enum */ export declare const GuardrailContentFilterType: { readonly HATE: "HATE"; readonly INSULTS: "INSULTS"; readonly MISCONDUCT: "MISCONDUCT"; readonly PROMPT_ATTACK: "PROMPT_ATTACK"; readonly SEXUAL: "SEXUAL"; readonly VIOLENCE: "VIOLENCE"; }; /** * @public */ export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType]; /** *Details of the content filter used in the Guardrail.
* @public */ export interface GuardrailContentFilter { /** *The type of content detected in the filter by the Guardrail.
* @public */ type?: GuardrailContentFilterType | undefined; /** *The confidence level regarding the content detected in the filter by the Guardrail.
* @public */ confidence?: GuardrailContentFilterConfidence | undefined; /** *The action placed on the content by the Guardrail filter.
* @public */ action?: GuardrailContentPolicyAction | undefined; } /** *The details of the policy assessment in the Guardrails filter.
* @public */ export interface GuardrailContentPolicyAssessment { /** *The filter details of the policy assessment used in the Guardrails filter.
* @public */ filters?: GuardrailContentFilter[] | undefined; } /** * @public * @enum */ export declare const GuardrailSensitiveInformationPolicyAction: { readonly ANONYMIZED: "ANONYMIZED"; readonly BLOCKED: "BLOCKED"; }; /** * @public */ export type GuardrailSensitiveInformationPolicyAction = (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction]; /** * @public * @enum */ export declare const GuardrailPiiEntityType: { readonly ADDRESS: "ADDRESS"; readonly AGE: "AGE"; readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY"; readonly AWS_SECRET_KEY: "AWS_SECRET_KEY"; readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER"; readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER"; readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV"; readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY"; readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER"; readonly DRIVER_ID: "DRIVER_ID"; readonly EMAIL: "EMAIL"; readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER"; readonly IP_ADDRESS: "IP_ADDRESS"; readonly LICENSE_PLATE: "LICENSE_PLATE"; readonly MAC_ADDRESS: "MAC_ADDRESS"; readonly NAME: "NAME"; readonly PASSWORD: "PASSWORD"; readonly PHONE: "PHONE"; readonly PIN: "PIN"; readonly SWIFT_CODE: "SWIFT_CODE"; readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER"; readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER"; readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"; readonly URL: "URL"; readonly USERNAME: "USERNAME"; readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER"; readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER"; readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"; readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER"; readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER"; readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER"; }; /** * @public */ export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType]; /** *The Guardrail filter to identify and remove personally identifiable information (PII).
* @public */ export interface GuardrailPiiEntityFilter { /** *The type of PII the Guardrail filter has identified and removed.
* @public */ type?: GuardrailPiiEntityType | undefined; /** *The match to settings in the Guardrail filter to identify and remove PII.
* @public */ match?: string | undefined; /** *The action of the Guardrail filter to identify and remove PII.
* @public */ action?: GuardrailSensitiveInformationPolicyAction | undefined; } /** *The details for the regex filter used in the Guardrail.
* @public */ export interface GuardrailRegexFilter { /** *The name details for the regex filter used in the Guardrail.
* @public */ name?: string | undefined; /** *The regex details for the regex filter used in the Guardrail.
* @public */ regex?: string | undefined; /** *The match details for the regex filter used in the Guardrail.
* @public */ match?: string | undefined; /** *The action details for the regex filter used in the Guardrail.
* @public */ action?: GuardrailSensitiveInformationPolicyAction | undefined; } /** *The details of the sensitive policy assessment used in the Guardrail.
* @public */ export interface GuardrailSensitiveInformationPolicyAssessment { /** *The details of the PII entities used in the sensitive policy assessment for the Guardrail.
* @public */ piiEntities?: GuardrailPiiEntityFilter[] | undefined; /** *The details of the regexes used in the sensitive policy assessment for the Guardrail.
* @public */ regexes?: GuardrailRegexFilter[] | undefined; } /** * @public * @enum */ export declare const GuardrailTopicPolicyAction: { readonly BLOCKED: "BLOCKED"; }; /** * @public */ export type GuardrailTopicPolicyAction = (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction]; /** * @public * @enum */ export declare const GuardrailTopicType: { readonly DENY: "DENY"; }; /** * @public */ export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType]; /** *The details for a specific topic defined in the Guardrail.
* @public */ export interface GuardrailTopic { /** *The name details on a specific topic in the Guardrail.
* @public */ name?: string | undefined; /** *The type details on a specific topic in the Guardrail.
* @public */ type?: GuardrailTopicType | undefined; /** *The action details on a specific topic in the Guardrail.
* @public */ action?: GuardrailTopicPolicyAction | undefined; } /** *The details of the policy assessment used in the Guardrail.
* @public */ export interface GuardrailTopicPolicyAssessment { /** *The topic details of the policy assessment used in the Guardrail.
* @public */ topics?: GuardrailTopic[] | undefined; } /** * @public * @enum */ export declare const GuardrailWordPolicyAction: { readonly BLOCKED: "BLOCKED"; }; /** * @public */ export type GuardrailWordPolicyAction = (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction]; /** *The custom word details for the filter in the Guardrail.
* @public */ export interface GuardrailCustomWord { /** *The match details for the custom word filter in the Guardrail.
* @public */ match?: string | undefined; /** *The action details for the custom word filter in the Guardrail.
* @public */ action?: GuardrailWordPolicyAction | undefined; } /** * @public * @enum */ export declare const GuardrailManagedWordType: { readonly PROFANITY: "PROFANITY"; }; /** * @public */ export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType]; /** *The managed word details for the filter in the Guardrail.
* @public */ export interface GuardrailManagedWord { /** *The match details for the managed word filter in the Guardrail.
* @public */ match?: string | undefined; /** *The type details for the managed word filter in the Guardrail.
* @public */ type?: GuardrailManagedWordType | undefined; /** *The action details for the managed word filter in the Guardrail.
* @public */ action?: GuardrailWordPolicyAction | undefined; } /** *The assessment details for words defined in the Guardrail filter.
* @public */ export interface GuardrailWordPolicyAssessment { /** *The custom word details for words defined in the Guardrail filter.
* @public */ customWords?: GuardrailCustomWord[] | undefined; /** *The managed word lists for words defined in the Guardrail filter.
* @public */ managedWordLists?: GuardrailManagedWord[] | undefined; } /** *Assessment details of the content analyzed by Guardrails.
* @public */ export interface GuardrailAssessment { /** *Topic policy details of the Guardrail.
* @public */ topicPolicy?: GuardrailTopicPolicyAssessment | undefined; /** *Content policy details of the Guardrail.
* @public */ contentPolicy?: GuardrailContentPolicyAssessment | undefined; /** *Word policy details of the Guardrail.
* @public */ wordPolicy?: GuardrailWordPolicyAssessment | undefined; /** *Sensitive Information policy details of Guardrail.
* @public */ sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment | undefined; } /** *The trace details used in the Guardrail.
* @public */ export interface GuardrailTrace { /** *The trace action details used with the Guardrail.
* @public */ action?: GuardrailAction | undefined; /** *The details of the trace Id used in the Guardrail Trace.
* @public */ traceId?: string | undefined; /** *The details of the input assessments used in the Guardrail Trace.
* @public */ inputAssessments?: GuardrailAssessment[] | undefined; /** *The details of the output assessments used in the Guardrail Trace.
* @public */ outputAssessments?: GuardrailAssessment[] | undefined; /** *Contains information about the Guardrail output.
* @public */ metadata?: Metadata | undefined; } /** *Contains information about the code interpreter being invoked.
* @public */ export interface CodeInterpreterInvocationInput { /** *The code for the code interpreter to use.
* @public */ code?: string | undefined; /** *Files that are uploaded for code interpreter to use.
* @public */ files?: string[] | undefined; } /** * @public * @enum */ export declare const InvocationType: { readonly ACTION_GROUP: "ACTION_GROUP"; readonly ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER"; readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR"; readonly FINISH: "FINISH"; readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE"; }; /** * @public */ export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType]; /** *Contains details about the knowledge base to look up and the query to be made.
* @public */ export interface KnowledgeBaseLookupInput { /** *The query made to the knowledge base.
* @public */ text?: string | undefined; /** *The unique identifier of the knowledge base to look up.
* @public */ knowledgeBaseId?: string | undefined; } /** *Contains information pertaining to the action group or knowledge base that is being invoked.
* @public */ export interface InvocationInput { /** *The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *Specifies whether the agent is invoking an action group or a knowledge base.
* @public */ invocationType?: InvocationType | undefined; /** *Contains information about the action group to be invoked.
* @public */ actionGroupInvocationInput?: ActionGroupInvocationInput | undefined; /** *Contains details about the knowledge base to look up and the query to be made.
* @public */ knowledgeBaseLookupInput?: KnowledgeBaseLookupInput | undefined; /** *Contains information about the code interpreter to be invoked.
* @public */ codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined; /** *The collaborator's invocation input.
* @public */ agentCollaboratorInvocationInput?: AgentCollaboratorInvocationInput | undefined; } /** *Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
* @public */ export interface InferenceConfiguration { /** *The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
* @public */ temperature?: number | undefined; /** *While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
The maximum number of tokens allowed in the generated response.
* @public */ maximumLength?: number | undefined; /** *A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
* @public */ stopSequences?: string[] | undefined; } /** * @public * @enum */ export declare const CreationMode: { readonly DEFAULT: "DEFAULT"; readonly OVERRIDDEN: "OVERRIDDEN"; }; /** * @public */ export type CreationMode = (typeof CreationMode)[keyof typeof CreationMode]; /** * @public * @enum */ export declare const PromptType: { readonly KNOWLEDGE_BASE_RESPONSE_GENERATION: "KNOWLEDGE_BASE_RESPONSE_GENERATION"; readonly ORCHESTRATION: "ORCHESTRATION"; readonly POST_PROCESSING: "POST_PROCESSING"; readonly PRE_PROCESSING: "PRE_PROCESSING"; readonly ROUTING_CLASSIFIER: "ROUTING_CLASSIFIER"; }; /** * @public */ export type PromptType = (typeof PromptType)[keyof typeof PromptType]; /** *The input for the pre-processing step.
The type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *The text that prompted the agent at this step.
* @public */ text?: string | undefined; /** *The step in the agent sequence.
* @public */ type?: PromptType | undefined; /** *The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
* @public */ overrideLambda?: string | undefined; /** *Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
* @public */ inferenceConfiguration?: InferenceConfiguration | undefined; /** *Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
The identifier of a foundation model.
* @public */ foundationModel?: string | undefined; } /** *Contains the raw output from the foundation model.
* @public */ export interface RawResponse { /** *The foundation model's raw output content.
* @public */ content?: string | undefined; } /** *Contains information about the reasoning that the model used to return the content in the content block.
* @public */ export interface ReasoningTextBlock { /** *Text describing the reasoning that the model used to return the content in the content block.
* @public */ text: string | undefined; /** *A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.
Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
* @public */ export type ReasoningContentBlock = ReasoningContentBlock.ReasoningTextMember | ReasoningContentBlock.RedactedContentMember | ReasoningContentBlock.$UnknownMember; /** * @public */ export declare namespace ReasoningContentBlock { /** *Contains information about the reasoning that the model used to return the content in the content block.
* @public */ interface ReasoningTextMember { reasoningText: ReasoningTextBlock; redactedContent?: never; $unknown?: never; } /** *The content in the reasoning that was encrypted by the model provider for trust and safety reasons.
* @public */ interface RedactedContentMember { reasoningText?: never; redactedContent: Uint8Array; $unknown?: never; } /** * @public */ interface $UnknownMember { reasoningText?: never; redactedContent?: never; $unknown: [string, any]; } interface VisitorThe foundation model output from the orchestration step.
* @public */ export interface OrchestrationModelInvocationOutput { /** *The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *Contains details of the raw response from the foundation model output.
* @public */ rawResponse?: RawResponse | undefined; /** *Contains information about the foundation model output from the orchestration step.
* @public */ metadata?: Metadata | undefined; /** *Contains content about the reasoning that the model made during the orchestration step.
* @public */ reasoningContent?: ReasoningContentBlock | undefined; } /** *Contains the JSON-formatted string returned by the API invoked by the code interpreter.
* @public */ export interface CodeInterpreterInvocationOutput { /** *Contains the successful output returned from code execution
* @public */ executionOutput?: string | undefined; /** *Contains the error returned from code execution.
* @public */ executionError?: string | undefined; /** *Contains output files, if generated by code execution.
* @public */ files?: string[] | undefined; /** *Indicates if the execution of the code timed out.
* @public */ executionTimeout?: boolean | undefined; /** *Contains information about the output from the code interpreter.
* @public */ metadata?: Metadata | undefined; } /** *Contains details about the response to the user.
* @public */ export interface FinalResponse { /** *The text in the response to the user.
* @public */ text?: string | undefined; /** *Contains information about the invoke agent operation.
* @public */ metadata?: Metadata | undefined; } /** *Contains details about the results from looking up the knowledge base.
* @public */ export interface KnowledgeBaseLookupOutput { /** *Contains metadata about the sources cited for the generated response.
* @public */ retrievedReferences?: RetrievedReference[] | undefined; /** *Contains information about the knowledge base output.
* @public */ metadata?: Metadata | undefined; } /** * @public * @enum */ export declare const Source: { readonly ACTION_GROUP: "ACTION_GROUP"; readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE"; readonly PARSER: "PARSER"; }; /** * @public */ export type Source = (typeof Source)[keyof typeof Source]; /** *Contains details about the agent's response to reprompt the input.
* @public */ export interface RepromptResponse { /** *The text reprompting the input.
* @public */ text?: string | undefined; /** *Specifies what output is prompting the agent to reprompt the input.
* @public */ source?: Source | undefined; } /** * @public * @enum */ export declare const Type: { readonly ACTION_GROUP: "ACTION_GROUP"; readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR"; readonly ASK_USER: "ASK_USER"; readonly FINISH: "FINISH"; readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE"; readonly REPROMPT: "REPROMPT"; }; /** * @public */ export type Type = (typeof Type)[keyof typeof Type]; /** *Contains the result or output of an action group or knowledge base, or the response to the user.
* @public */ export interface Observation { /** *The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *Specifies what kind of information the agent returns in the observation. The following values are possible.
ACTION_GROUP – The agent returns the result of an action group.
KNOWLEDGE_BASE – The agent returns information from a knowledge base.
FINISH – The agent returns a final response to the user with no follow-up.
ASK_USER – The agent asks the user a question.
REPROMPT – The agent prompts the user again for the same information.
Contains the JSON-formatted string returned by the API invoked by the action group.
* @public */ actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined; /** *A collaborator's invocation output.
* @public */ agentCollaboratorInvocationOutput?: AgentCollaboratorInvocationOutput | undefined; /** *Contains details about the results from looking up the knowledge base.
* @public */ knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput | undefined; /** *Contains details about the response to the user.
* @public */ finalResponse?: FinalResponse | undefined; /** *Contains details about the response to reprompt the input.
* @public */ repromptResponse?: RepromptResponse | undefined; /** *Contains the JSON-formatted string returned by the API invoked by the code interpreter.
* @public */ codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput | undefined; } /** *Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
* @public */ export interface Rationale { /** *The unique identifier of the trace step.
* @public */ traceId?: string | undefined; /** *The reasoning or thought process of the agent, based on the input.
* @public */ text?: string | undefined; } /** *Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
* @public */ export type OrchestrationTrace = OrchestrationTrace.InvocationInputMember | OrchestrationTrace.ModelInvocationInputMember | OrchestrationTrace.ModelInvocationOutputMember | OrchestrationTrace.ObservationMember | OrchestrationTrace.RationaleMember | OrchestrationTrace.$UnknownMember; /** * @public */ export declare namespace OrchestrationTrace { /** *Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
* @public */ interface RationaleMember { rationale: Rationale; invocationInput?: never; observation?: never; modelInvocationInput?: never; modelInvocationOutput?: never; $unknown?: never; } /** *Contains information pertaining to the action group or knowledge base that is being invoked.
* @public */ interface InvocationInputMember { rationale?: never; invocationInput: InvocationInput; observation?: never; modelInvocationInput?: never; modelInvocationOutput?: never; $unknown?: never; } /** *Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
* @public */ interface ObservationMember { rationale?: never; invocationInput?: never; observation: Observation; modelInvocationInput?: never; modelInvocationOutput?: never; $unknown?: never; } /** *The input for the orchestration step.
The type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
Contains information pertaining to the output from the foundation model that is being invoked.
* @public */ interface ModelInvocationOutputMember { rationale?: never; invocationInput?: never; observation?: never; modelInvocationInput?: never; modelInvocationOutput: OrchestrationModelInvocationOutput; $unknown?: never; } /** * @public */ interface $UnknownMember { rationale?: never; invocationInput?: never; observation?: never; modelInvocationInput?: never; modelInvocationOutput?: never; $unknown: [string, any]; } interface VisitorDetails about the response from the Lambda parsing of the output from the post-processing step.
* @public */ export interface PostProcessingParsedResponse { /** *The text returned by the parser.
* @public */ text?: string | undefined; } /** *The foundation model output from the post-processing step.
* @public */ export interface PostProcessingModelInvocationOutput { /** *The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *Details about the response from the Lambda parsing of the output of the post-processing step.
* @public */ parsedResponse?: PostProcessingParsedResponse | undefined; /** *Details of the raw response from the foundation model output.
* @public */ rawResponse?: RawResponse | undefined; /** *Contains information about the foundation model output from the post-processing step.
* @public */ metadata?: Metadata | undefined; /** *Contains content about the reasoning that the model made during the post-processing step.
* @public */ reasoningContent?: ReasoningContentBlock | undefined; } /** *Details about the post-processing step, in which the agent shapes the response.
* @public */ export type PostProcessingTrace = PostProcessingTrace.ModelInvocationInputMember | PostProcessingTrace.ModelInvocationOutputMember | PostProcessingTrace.$UnknownMember; /** * @public */ export declare namespace PostProcessingTrace { /** *The input for the post-processing step.
The type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the post-processing step.
* @public */ interface ModelInvocationOutputMember { modelInvocationInput?: never; modelInvocationOutput: PostProcessingModelInvocationOutput; $unknown?: never; } /** * @public */ interface $UnknownMember { modelInvocationInput?: never; modelInvocationOutput?: never; $unknown: [string, any]; } interface VisitorDetails about the response from the Lambda parsing of the output from the pre-processing step.
* @public */ export interface PreProcessingParsedResponse { /** *The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.
* @public */ rationale?: string | undefined; /** *Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.
The foundation model output from the pre-processing step.
* @public */ export interface PreProcessingModelInvocationOutput { /** *The unique identifier of the trace.
* @public */ traceId?: string | undefined; /** *Details about the response from the Lambda parsing of the output of the pre-processing step.
* @public */ parsedResponse?: PreProcessingParsedResponse | undefined; /** *Details of the raw response from the foundation model output.
* @public */ rawResponse?: RawResponse | undefined; /** *Contains information about the foundation model output from the pre-processing step.
* @public */ metadata?: Metadata | undefined; /** *Contains content about the reasoning that the model made during the pre-processing step.
* @public */ reasoningContent?: ReasoningContentBlock | undefined; } /** *Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
* @public */ export type PreProcessingTrace = PreProcessingTrace.ModelInvocationInputMember | PreProcessingTrace.ModelInvocationOutputMember | PreProcessingTrace.$UnknownMember; /** * @public */ export declare namespace PreProcessingTrace { /** *The input for the pre-processing step.
The type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The foundation model output from the pre-processing step.
* @public */ interface ModelInvocationOutputMember { modelInvocationInput?: never; modelInvocationOutput: PreProcessingModelInvocationOutput; $unknown?: never; } /** * @public */ interface $UnknownMember { modelInvocationInput?: never; modelInvocationOutput?: never; $unknown: [string, any]; } interface VisitorInvocation output from a routing classifier model.
* @public */ export interface RoutingClassifierModelInvocationOutput { /** *The invocation's trace ID.
* @public */ traceId?: string | undefined; /** *The invocation's raw response.
* @public */ rawResponse?: RawResponse | undefined; /** *The invocation's metadata.
* @public */ metadata?: Metadata | undefined; } /** *A trace for a routing classifier.
* @public */ export type RoutingClassifierTrace = RoutingClassifierTrace.InvocationInputMember | RoutingClassifierTrace.ModelInvocationInputMember | RoutingClassifierTrace.ModelInvocationOutputMember | RoutingClassifierTrace.ObservationMember | RoutingClassifierTrace.$UnknownMember; /** * @public */ export declare namespace RoutingClassifierTrace { /** *The classifier's invocation input.
* @public */ interface InvocationInputMember { invocationInput: InvocationInput; observation?: never; modelInvocationInput?: never; modelInvocationOutput?: never; $unknown?: never; } /** *The classifier's observation.
* @public */ interface ObservationMember { invocationInput?: never; observation: Observation; modelInvocationInput?: never; modelInvocationOutput?: never; $unknown?: never; } /** *The classifier's model invocation input.
* @public */ interface ModelInvocationInputMember { invocationInput?: never; observation?: never; modelInvocationInput: ModelInvocationInput; modelInvocationOutput?: never; $unknown?: never; } /** *The classifier's model invocation output.
* @public */ interface ModelInvocationOutputMember { invocationInput?: never; observation?: never; modelInvocationInput?: never; modelInvocationOutput: RoutingClassifierModelInvocationOutput; $unknown?: never; } /** * @public */ interface $UnknownMember { invocationInput?: never; observation?: never; modelInvocationInput?: never; modelInvocationOutput?: never; $unknown: [string, any]; } interface VisitorContains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
* @public */ export type Trace = Trace.CustomOrchestrationTraceMember | Trace.FailureTraceMember | Trace.GuardrailTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.RoutingClassifierTraceMember | Trace.$UnknownMember; /** * @public */ export declare namespace Trace { /** *The trace details for a trace defined in the Guardrail filter.
* @public */ interface GuardrailTraceMember { guardrailTrace: GuardrailTrace; preProcessingTrace?: never; orchestrationTrace?: never; postProcessingTrace?: never; routingClassifierTrace?: never; failureTrace?: never; customOrchestrationTrace?: never; $unknown?: never; } /** *Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
* @public */ interface PreProcessingTraceMember { guardrailTrace?: never; preProcessingTrace: PreProcessingTrace; orchestrationTrace?: never; postProcessingTrace?: never; routingClassifierTrace?: never; failureTrace?: never; customOrchestrationTrace?: never; $unknown?: never; } /** *Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
* @public */ interface OrchestrationTraceMember { guardrailTrace?: never; preProcessingTrace?: never; orchestrationTrace: OrchestrationTrace; postProcessingTrace?: never; routingClassifierTrace?: never; failureTrace?: never; customOrchestrationTrace?: never; $unknown?: never; } /** *Details about the post-processing step, in which the agent shapes the response..
* @public */ interface PostProcessingTraceMember { guardrailTrace?: never; preProcessingTrace?: never; orchestrationTrace?: never; postProcessingTrace: PostProcessingTrace; routingClassifierTrace?: never; failureTrace?: never; customOrchestrationTrace?: never; $unknown?: never; } /** *A routing classifier's trace.
* @public */ interface RoutingClassifierTraceMember { guardrailTrace?: never; preProcessingTrace?: never; orchestrationTrace?: never; postProcessingTrace?: never; routingClassifierTrace: RoutingClassifierTrace; failureTrace?: never; customOrchestrationTrace?: never; $unknown?: never; } /** *Contains information about the failure of the interaction.
* @public */ interface FailureTraceMember { guardrailTrace?: never; preProcessingTrace?: never; orchestrationTrace?: never; postProcessingTrace?: never; routingClassifierTrace?: never; failureTrace: FailureTrace; customOrchestrationTrace?: never; $unknown?: never; } /** *Details about the custom orchestration step in which the agent determines the order in which actions are executed.
* @public */ interface CustomOrchestrationTraceMember { guardrailTrace?: never; preProcessingTrace?: never; orchestrationTrace?: never; postProcessingTrace?: never; routingClassifierTrace?: never; failureTrace?: never; customOrchestrationTrace: CustomOrchestrationTrace; $unknown?: never; } /** * @public */ interface $UnknownMember { guardrailTrace?: never; preProcessingTrace?: never; orchestrationTrace?: never; postProcessingTrace?: never; routingClassifierTrace?: never; failureTrace?: never; customOrchestrationTrace?: never; $unknown: [string, any]; } interface VisitorContains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
* @public */ export interface TracePart { /** *The unique identifier of the session with the agent.
* @public */ sessionId?: string | undefined; /** *Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
* @public */ trace?: Trace | undefined; /** *The part's caller chain.
* @public */ callerChain?: Caller[] | undefined; /** *The time of the trace.
* @public */ eventTime?: Date | undefined; /** *The part's collaborator name.
* @public */ collaboratorName?: string | undefined; /** *The unique identifier of the agent.
* @public */ agentId?: string | undefined; /** *The unique identifier of the alias of the agent.
* @public */ agentAliasId?: string | undefined; /** *The version of the agent.
* @public */ agentVersion?: string | undefined; } /** *The response from invoking the agent and associated citations and trace information.
* @public */ export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.BadGatewayExceptionMember | ResponseStream.ChunkMember | ResponseStream.ConflictExceptionMember | ResponseStream.DependencyFailedExceptionMember | ResponseStream.FilesMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ModelNotReadyExceptionMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ReturnControlMember | ResponseStream.ServiceQuotaExceededExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember; /** * @public */ export declare namespace ResponseStream { /** *Contains a part of an agent response and citations for it.
* @public */ interface ChunkMember { chunk: PayloadPart; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
* @public */ interface TraceMember { chunk?: never; trace: TracePart; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
* @public */ interface ReturnControlMember { chunk?: never; trace?: never; returnControl: ReturnControlPayload; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *An internal server error occurred. Retry your request.
* @public */ interface InternalServerExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException: InternalServerException; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *Input validation failed. Check your request parameters and retry the request.
* @public */ interface ValidationExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException: ValidationException; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
* @public */ interface ResourceNotFoundExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException: ResourceNotFoundException; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *The number of requests exceeds the service quota. Resubmit your request later.
* @public */ interface ServiceQuotaExceededExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException: ServiceQuotaExceededException; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *The number of requests exceeds the limit. Resubmit your request later.
* @public */ interface ThrottlingExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException: ThrottlingException; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *The request is denied because of missing access permissions. Check your permissions and retry your request.
* @public */ interface AccessDeniedExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException: AccessDeniedException; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *There was a conflict performing an operation. Resolve the conflict and retry your request.
* @public */ interface ConflictExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException: ConflictException; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *There was an issue with a dependency. Check the resource configurations and retry the request.
* @public */ interface DependencyFailedExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException: DependencyFailedException; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *There was an issue with a dependency due to a server issue. Retry your request.
* @public */ interface BadGatewayExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException: BadGatewayException; modelNotReadyException?: never; files?: never; $unknown?: never; } /** *The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
* @public */ interface ModelNotReadyExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException: ModelNotReadyException; files?: never; $unknown?: never; } /** *Contains intermediate response for code interpreter if any files have been generated.
* @public */ interface FilesMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files: FilePart; $unknown?: never; } /** * @public */ interface $UnknownMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; modelNotReadyException?: never; files?: never; $unknown: [string, any]; } interface VisitorThe agent's response to the user prompt.
* @public */ completion: AsyncIterableThe MIME type of the input data in the request. The default value is application/json.
The unique identifier of the session with the agent.
* @public */ sessionId: string | undefined; /** *The unique identifier of the agent memory.
* @public */ memoryId?: string | undefined; } /** *Settings for a model called with InvokeInlineAgent.
* @public */ export interface InlineBedrockModelConfigurations { /** *The latency configuration for the model.
* @public */ performanceConfig?: PerformanceConfiguration | undefined; } /** * @public * @enum */ export declare const RelayConversationHistory: { readonly DISABLED: "DISABLED"; readonly TO_COLLABORATOR: "TO_COLLABORATOR"; }; /** * @public */ export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory]; /** *Settings of an inline collaborator agent.
* @public */ export interface CollaboratorConfiguration { /** * Name of the inline collaborator agent which must be the same name as specified for agentName.
Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
* @public */ collaboratorInstruction: string | undefined; /** *The Amazon Resource Name (ARN) of the inline collaborator agent.
* @public */ agentAliasArn?: string | undefined; /** *A relay conversation history for the inline collaborator agent.
* @public */ relayConversationHistory?: RelayConversationHistory | undefined; } /** *The configuration details for the guardrail.
* @public */ export interface GuardrailConfigurationWithArn { /** *The unique identifier for the guardrail.
* @public */ guardrailIdentifier: string | undefined; /** *The version of the guardrail.
* @public */ guardrailVersion: string | undefined; } /** * @public * @enum */ export declare const PromptState: { readonly DISABLED: "DISABLED"; readonly ENABLED: "ENABLED"; }; /** * @public */ export type PromptState = (typeof PromptState)[keyof typeof PromptState]; /** *Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
* @public */ export interface PromptConfiguration { /** *The step in the agent sequence that this prompt configuration applies to.
* @public */ promptType?: PromptType | undefined; /** *Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING – ENABLED
ORCHESTRATION – ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
POST_PROCESSING – DISABLED
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.
* @public */ basePromptTemplate?: string | undefined; /** *Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
The foundation model to use.
* @public */ foundationModel?: string | undefined; /** *If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
* @public */ additionalModelRequestFields?: __DocumentType | undefined; } /** *Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
* @public */ export interface PromptOverrideConfiguration { /** *Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
* @public */ promptConfigurations: PromptConfiguration[] | undefined; /** *The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.
The structure of the executor invoking the actions in custom orchestration.
* @public */ export type OrchestrationExecutor = OrchestrationExecutor.LambdaMember | OrchestrationExecutor.$UnknownMember; /** * @public */ export declare namespace OrchestrationExecutor { /** *The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
* @public */ interface LambdaMember { lambda: string; $unknown?: never; } /** * @public */ interface $UnknownMember { lambda?: never; $unknown: [string, any]; } interface VisitorContains details of the custom orchestration configured for the agent.
* @public */ export interface CustomOrchestration { /** *The structure of the executor invoking the actions in custom orchestration.
* @public */ executor?: OrchestrationExecutor | undefined; } /** * Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context
Contains attributes that persist across a session and the values of those attributes.
* @public */ sessionAttributes?: RecordContains attributes that persist across a session and the values of those attributes.
* @public */ promptSessionAttributes?: RecordContains information about the results from the action group invocation. For more information, see Return control to the agent developer.
If you include this field in the sessionState field, the inputText field will be ignored.
The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.
Contains information about the files used by code interpreter.
* @public */ files?: InputFile[] | undefined; /** *Contains the conversation history that persist across sessions.
* @public */ conversationHistory?: ConversationHistory | undefined; } /** * @public * @enum */ export declare const OrchestrationType: { readonly CUSTOM_ORCHESTRATION: "CUSTOM_ORCHESTRATION"; readonly DEFAULT: "DEFAULT"; }; /** * @public */ export type OrchestrationType = (typeof OrchestrationType)[keyof typeof OrchestrationType]; /** *Contains a part of an agent response and citations for it.
* @public */ export interface InlineAgentPayloadPart { /** *A part of the agent response in bytes.
* @public */ bytes?: Uint8Array | undefined; /** *Contains citations for a part of an agent response.
* @public */ attribution?: Attribution | undefined; } /** *Contains intermediate response for code interpreter if any files have been generated.
* @public */ export interface InlineAgentFilePart { /** *Files containing intermediate response for the user.
* @public */ files?: OutputFile[] | undefined; } /** *Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the InvokeAgent response API operation.
* @public */ export interface InlineAgentReturnControlPayload { /** *A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
* @public */ invocationInputs?: InvocationInputMember[] | undefined; /** *The identifier of the action group invocation.
* @public */ invocationId?: string | undefined; } /** *Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
* @public */ export interface InlineAgentTracePart { /** *The unique identifier of the session with the agent.
* @public */ sessionId?: string | undefined; /** *Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
* @public */ trace?: Trace | undefined; /** *The caller chain for the trace part.
* @public */ callerChain?: Caller[] | undefined; /** *The time that trace occurred.
* @public */ eventTime?: Date | undefined; /** *The collaborator name for the trace part.
* @public */ collaboratorName?: string | undefined; } /** *The response from invoking the agent and associated citations and trace information.
* @public */ export type InlineAgentResponseStream = InlineAgentResponseStream.AccessDeniedExceptionMember | InlineAgentResponseStream.BadGatewayExceptionMember | InlineAgentResponseStream.ChunkMember | InlineAgentResponseStream.ConflictExceptionMember | InlineAgentResponseStream.DependencyFailedExceptionMember | InlineAgentResponseStream.FilesMember | InlineAgentResponseStream.InternalServerExceptionMember | InlineAgentResponseStream.ResourceNotFoundExceptionMember | InlineAgentResponseStream.ReturnControlMember | InlineAgentResponseStream.ServiceQuotaExceededExceptionMember | InlineAgentResponseStream.ThrottlingExceptionMember | InlineAgentResponseStream.TraceMember | InlineAgentResponseStream.ValidationExceptionMember | InlineAgentResponseStream.$UnknownMember; /** * @public */ export declare namespace InlineAgentResponseStream { /** *Contains a part of an agent response and citations for it.
* @public */ interface ChunkMember { chunk: InlineAgentPayloadPart; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
* @public */ interface TraceMember { chunk?: never; trace: InlineAgentTracePart; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
* @public */ interface ReturnControlMember { chunk?: never; trace?: never; returnControl: InlineAgentReturnControlPayload; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *An internal server error occurred. Retry your request.
* @public */ interface InternalServerExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException: InternalServerException; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *Input validation failed. Check your request parameters and retry the request.
* @public */ interface ValidationExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException: ValidationException; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
* @public */ interface ResourceNotFoundExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException: ResourceNotFoundException; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *The number of requests exceeds the service quota. Resubmit your request later.
* @public */ interface ServiceQuotaExceededExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException: ServiceQuotaExceededException; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *The number of requests exceeds the limit. Resubmit your request later.
* @public */ interface ThrottlingExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException: ThrottlingException; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *The request is denied because of missing access permissions. Check your permissions and retry your request.
* @public */ interface AccessDeniedExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException: AccessDeniedException; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *There was a conflict performing an operation. Resolve the conflict and retry your request.
* @public */ interface ConflictExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException: ConflictException; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown?: never; } /** *There was an issue with a dependency. Check the resource configurations and retry the request.
* @public */ interface DependencyFailedExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException: DependencyFailedException; badGatewayException?: never; files?: never; $unknown?: never; } /** *There was an issue with a dependency due to a server issue. Retry your request.
* @public */ interface BadGatewayExceptionMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException: BadGatewayException; files?: never; $unknown?: never; } /** *Contains intermediate response for code interpreter if any files have been generated.
* @public */ interface FilesMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files: InlineAgentFilePart; $unknown?: never; } /** * @public */ interface $UnknownMember { chunk?: never; trace?: never; returnControl?: never; internalServerException?: never; validationException?: never; resourceNotFoundException?: never; serviceQuotaExceededException?: never; throttlingException?: never; accessDeniedException?: never; conflictException?: never; dependencyFailedException?: never; badGatewayException?: never; files?: never; $unknown: [string, any]; } interface VisitorThe inline agent's response to the user prompt.
* @public */ completion: AsyncIterableThe MIME type of the input data in the request. The default value is application/json.
* @public */ contentType: string | undefined; /** *The unique identifier of the session with the agent.
* @public */ sessionId: string | undefined; } /** * @public */ export interface DeleteAgentMemoryRequest { /** *The unique identifier of the agent to which the alias belongs.
* @public */ agentId: string | undefined; /** *The unique identifier of an alias of an agent.
* @public */ agentAliasId: string | undefined; /** *The unique identifier of the memory.
* @public */ memoryId?: string | undefined; /** *The unique session identifier of the memory.
* @public */ sessionId?: string | undefined; } /** * @public */ export interface DeleteAgentMemoryResponse { } /** * @public * @enum */ export declare const MemoryType: { readonly SESSION_SUMMARY: "SESSION_SUMMARY"; }; /** * @public */ export type MemoryType = (typeof MemoryType)[keyof typeof MemoryType]; /** * @public */ export interface GetAgentMemoryRequest { /** *If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The unique identifier of the agent to which the alias belongs.
* @public */ agentId: string | undefined; /** *The unique identifier of an alias of an agent.
* @public */ agentAliasId: string | undefined; /** *The type of memory.
* @public */ memoryType: MemoryType | undefined; /** *The unique identifier of the memory.
* @public */ memoryId: string | undefined; } /** *Contains details of a session summary.
* @public */ export interface MemorySessionSummary { /** *The unique identifier of the memory where the session summary is stored.
* @public */ memoryId?: string | undefined; /** *The identifier for this session.
* @public */ sessionId?: string | undefined; /** *The start time for this session.
* @public */ sessionStartTime?: Date | undefined; /** *The time when the memory duration for the session is set to end.
* @public */ sessionExpiryTime?: Date | undefined; /** *The summarized text for this session.
* @public */ summaryText?: string | undefined; } /** *Contains sessions summaries.
* @public */ export type Memory = Memory.SessionSummaryMember | Memory.$UnknownMember; /** * @public */ export declare namespace Memory { /** *Contains summary of a session.
* @public */ interface SessionSummaryMember { sessionSummary: MemorySessionSummary; $unknown?: never; } /** * @public */ interface $UnknownMember { sessionSummary?: never; $unknown: [string, any]; } interface VisitorIf the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Contains details of the sessions stored in the memory
* @public */ memoryContents?: Memory[] | undefined; } /** *Contains information about the text prompt to optimize.
* @public */ export interface TextPrompt { /** *The text in the text prompt to optimize.
* @public */ text: string | undefined; } /** *Contains information about the prompt to optimize.
* @public */ export type InputPrompt = InputPrompt.TextPromptMember | InputPrompt.$UnknownMember; /** * @public */ export declare namespace InputPrompt { /** *Contains information about the text prompt to optimize.
* @public */ interface TextPromptMember { textPrompt: TextPrompt; $unknown?: never; } /** * @public */ interface $UnknownMember { textPrompt?: never; $unknown: [string, any]; } interface VisitorContains the prompt to optimize.
* @public */ input: InputPrompt | undefined; /** *The unique identifier of the model that you want to optimize the prompt for.
* @public */ targetModelId: string | undefined; } /** *An event in which the prompt was analyzed in preparation for optimization.
* @public */ export interface AnalyzePromptEvent { /** *A message describing the analysis of the prompt.
* @public */ message?: string | undefined; } /** *Contains information about the optimized prompt.
* @public */ export type OptimizedPrompt = OptimizedPrompt.TextPromptMember | OptimizedPrompt.$UnknownMember; /** * @public */ export declare namespace OptimizedPrompt { /** *Contains information about the text in the prompt that was optimized.
* @public */ interface TextPromptMember { textPrompt: TextPrompt; $unknown?: never; } /** * @public */ interface $UnknownMember { textPrompt?: never; $unknown: [string, any]; } interface VisitorAn event in which the prompt was optimized.
* @public */ export interface OptimizedPromptEvent { /** *Contains information about the optimized prompt.
* @public */ optimizedPrompt?: OptimizedPrompt | undefined; } /** *The stream containing events in the prompt optimization process.
* @public */ export type OptimizedPromptStream = OptimizedPromptStream.AccessDeniedExceptionMember | OptimizedPromptStream.AnalyzePromptEventMember | OptimizedPromptStream.BadGatewayExceptionMember | OptimizedPromptStream.DependencyFailedExceptionMember | OptimizedPromptStream.InternalServerExceptionMember | OptimizedPromptStream.OptimizedPromptEventMember | OptimizedPromptStream.ThrottlingExceptionMember | OptimizedPromptStream.ValidationExceptionMember | OptimizedPromptStream.$UnknownMember; /** * @public */ export declare namespace OptimizedPromptStream { /** *An event in which the prompt was optimized.
* @public */ interface OptimizedPromptEventMember { optimizedPromptEvent: OptimizedPromptEvent; analyzePromptEvent?: never; internalServerException?: never; throttlingException?: never; validationException?: never; dependencyFailedException?: never; accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** *An event in which the prompt was analyzed in preparation for optimization.
* @public */ interface AnalyzePromptEventMember { optimizedPromptEvent?: never; analyzePromptEvent: AnalyzePromptEvent; internalServerException?: never; throttlingException?: never; validationException?: never; dependencyFailedException?: never; accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** *An internal server error occurred. Retry your request.
* @public */ interface InternalServerExceptionMember { optimizedPromptEvent?: never; analyzePromptEvent?: never; internalServerException: InternalServerException; throttlingException?: never; validationException?: never; dependencyFailedException?: never; accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** *Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.
* @public */ interface ThrottlingExceptionMember { optimizedPromptEvent?: never; analyzePromptEvent?: never; internalServerException?: never; throttlingException: ThrottlingException; validationException?: never; dependencyFailedException?: never; accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** *Input validation failed. Check your request parameters and retry the request.
* @public */ interface ValidationExceptionMember { optimizedPromptEvent?: never; analyzePromptEvent?: never; internalServerException?: never; throttlingException?: never; validationException: ValidationException; dependencyFailedException?: never; accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** *There was an issue with a dependency. Check the resource configurations and retry the request.
* @public */ interface DependencyFailedExceptionMember { optimizedPromptEvent?: never; analyzePromptEvent?: never; internalServerException?: never; throttlingException?: never; validationException?: never; dependencyFailedException: DependencyFailedException; accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** *The request is denied because of missing access permissions. Check your permissions and retry your request.
* @public */ interface AccessDeniedExceptionMember { optimizedPromptEvent?: never; analyzePromptEvent?: never; internalServerException?: never; throttlingException?: never; validationException?: never; dependencyFailedException?: never; accessDeniedException: AccessDeniedException; badGatewayException?: never; $unknown?: never; } /** *There was an issue with a dependency due to a server issue. Retry your request.
* @public */ interface BadGatewayExceptionMember { optimizedPromptEvent?: never; analyzePromptEvent?: never; internalServerException?: never; throttlingException?: never; validationException?: never; dependencyFailedException?: never; accessDeniedException?: never; badGatewayException: BadGatewayException; $unknown?: never; } /** * @public */ interface $UnknownMember { optimizedPromptEvent?: never; analyzePromptEvent?: never; internalServerException?: never; throttlingException?: never; validationException?: never; dependencyFailedException?: never; accessDeniedException?: never; badGatewayException?: never; $unknown: [string, any]; } interface VisitorThe prompt after being optimized for the task.
* @public */ optimizedPrompt: AsyncIterableContains information about a text document to rerank.
* @public */ export interface RerankTextDocument { /** *The text of the document.
* @public */ text?: string | undefined; } /** * @public * @enum */ export declare const RerankQueryContentType: { readonly TEXT: "TEXT"; }; /** * @public */ export type RerankQueryContentType = (typeof RerankQueryContentType)[keyof typeof RerankQueryContentType]; /** *Contains information about a query to submit to the reranker model.
* @public */ export interface RerankQuery { /** *The type of the query.
* @public */ type: RerankQueryContentType | undefined; /** *Contains information about a text query.
* @public */ textQuery: RerankTextDocument | undefined; } /** *Contains configurations for a reranker model.
* @public */ export interface BedrockRerankingModelConfiguration { /** *The ARN of the reranker model.
* @public */ modelArn: string | undefined; /** *A JSON object whose keys are request fields for the model and whose values are values for those fields.
* @public */ additionalModelRequestFields?: RecordContains configurations for an Amazon Bedrock reranker model.
* @public */ export interface BedrockRerankingConfiguration { /** *The number of results to return after reranking.
* @public */ numberOfResults?: number | undefined; /** *Contains configurations for a reranker model.
* @public */ modelConfiguration: BedrockRerankingModelConfiguration | undefined; } /** * @public * @enum */ export declare const RerankingConfigurationType: { readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL"; }; /** * @public */ export type RerankingConfigurationType = (typeof RerankingConfigurationType)[keyof typeof RerankingConfigurationType]; /** *Contains configurations for reranking.
* @public */ export interface RerankingConfiguration { /** *The type of reranker that the configurations apply to.
* @public */ type: RerankingConfigurationType | undefined; /** *Contains configurations for an Amazon Bedrock reranker.
* @public */ bedrockRerankingConfiguration: BedrockRerankingConfiguration | undefined; } /** * @public * @enum */ export declare const RerankDocumentType: { readonly JSON: "JSON"; readonly TEXT: "TEXT"; }; /** * @public */ export type RerankDocumentType = (typeof RerankDocumentType)[keyof typeof RerankDocumentType]; /** *Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.
The type of document to rerank.
* @public */ type: RerankDocumentType | undefined; /** *Contains information about a text document to rerank.
* @public */ textDocument?: RerankTextDocument | undefined; /** *Contains a JSON document to rerank.
* @public */ jsonDocument?: __DocumentType | undefined; } /** * @public * @enum */ export declare const RerankSourceType: { readonly INLINE: "INLINE"; }; /** * @public */ export type RerankSourceType = (typeof RerankSourceType)[keyof typeof RerankSourceType]; /** *Contains information about a source for reranking.
* @public */ export interface RerankSource { /** *The type of the source.
* @public */ type: RerankSourceType | undefined; /** *Contains an inline definition of a source for reranking.
* @public */ inlineDocumentSource: RerankDocument | undefined; } /** * @public */ export interface RerankRequest { /** *An array of objects, each of which contains information about a query to submit to the reranker model.
* @public */ queries: RerankQuery[] | undefined; /** *An array of objects, each of which contains information about the sources to rerank.
* @public */ sources: RerankSource[] | undefined; /** *Contains configurations for reranking.
* @public */ rerankingConfiguration: RerankingConfiguration | undefined; /** *If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.
Contains information about a document that was reranked.
* @public */ export interface RerankResult { /** *The ranking of the document. The lower a number, the higher the document is ranked.
* @public */ index: number | undefined; /** *The relevance score of the document.
* @public */ relevanceScore: number | undefined; /** *Contains information about the document.
* @public */ document?: RerankDocument | undefined; } /** * @public */ export interface RerankResponse { /** *An array of objects, each of which contains information about the results of reranking.
* @public */ results: RerankResult[] | undefined; /** *If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.
Contains the query made to the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the input field
The query made to the knowledge base.
* @public */ text: string | undefined; } /** *The configuration details for the guardrail.
* @public */ export interface GuardrailConfiguration { /** *The unique identifier for the guardrail.
* @public */ guardrailId: string | undefined; /** *The version of the guardrail.
* @public */ guardrailVersion: string | undefined; } /** *Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
* @public */ temperature?: number | undefined; /** *A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
* @public */ topP?: number | undefined; /** *The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
* @public */ maxTokens?: number | undefined; /** *A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
* @public */ stopSequences?: string[] | undefined; } /** *The configuration for inference settings when generating responses using RetrieveAndGenerate.
* @public */ export interface InferenceConfig { /** *Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
* @public */ textInferenceConfig?: TextInferenceConfig | undefined; } /** *Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the filter field
The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
* @public */ textPromptTemplate?: string | undefined; } /** *Contains the generation configuration of the external source wrapper object.
* @public */ export interface ExternalSourcesGenerationConfiguration { /** *Contain the textPromptTemplate string for the external source wrapper object.
* @public */ promptTemplate?: PromptTemplate | undefined; /** *The configuration details for the guardrail.
* @public */ guardrailConfiguration?: GuardrailConfiguration | undefined; /** *Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
* @public */ inferenceConfig?: InferenceConfig | undefined; /** *Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
* @public */ additionalModelRequestFields?: RecordThe latency configuration for the model.
* @public */ performanceConfig?: PerformanceConfiguration | undefined; } /** *This property contains the document to chat with, along with its attributes.
* @public */ export interface ByteContentDoc { /** *The file name of the document contained in the wrapper object.
* @public */ identifier: string | undefined; /** *The MIME type of the document contained in the wrapper object.
* @public */ contentType: string | undefined; /** *The byte value of the file to upload, encoded as a Base-64 string.
* @public */ data: Uint8Array | undefined; } /** *The unique wrapper object of the document from the S3 location.
* @public */ export interface S3ObjectDoc { /** *The file location of the S3 wrapper object.
* @public */ uri: string | undefined; } /** * @public * @enum */ export declare const ExternalSourceType: { readonly BYTE_CONTENT: "BYTE_CONTENT"; readonly S3: "S3"; }; /** * @public */ export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType]; /** *The unique external source of the content contained in the wrapper object.
* @public */ export interface ExternalSource { /** *The source type of the external source wrapper object.
* @public */ sourceType: ExternalSourceType | undefined; /** *The S3 location of the external source wrapper object.
* @public */ s3Location?: S3ObjectDoc | undefined; /** *The identifier, contentType, and data of the external source wrapper object.
* @public */ byteContent?: ByteContentDoc | undefined; } /** *The configurations of the external source wrapper object in the retrieveAndGenerate function.
The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.
The document for the external source wrapper object in the retrieveAndGenerate function.
The prompt used with the external source wrapper object with the retrieveAndGenerate function.
Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
* @public */ export interface GenerationConfiguration { /** *Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.
The configuration details for the guardrail.
* @public */ guardrailConfiguration?: GuardrailConfiguration | undefined; /** *Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
* @public */ inferenceConfig?: InferenceConfig | undefined; /** *Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
* @public */ additionalModelRequestFields?: RecordThe latency configuration for the model.
* @public */ performanceConfig?: PerformanceConfiguration | undefined; } /** * @public * @enum */ export declare const QueryTransformationType: { readonly QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION"; }; /** * @public */ export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType]; /** *To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
The type of transformation to apply to the prompt.
* @public */ type: QueryTransformationType | undefined; } /** *Settings for how the model processes the prompt prior to retrieval and generation.
* @public */ export interface OrchestrationConfiguration { /** *Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
* @public */ inferenceConfig?: InferenceConfig | undefined; /** *Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
* @public */ additionalModelRequestFields?: RecordTo split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
The latency configuration for the model.
* @public */ performanceConfig?: PerformanceConfiguration | undefined; } /** * @public * @enum */ export declare const RetrieveAndGenerateType: { readonly EXTERNAL_SOURCES: "EXTERNAL_SOURCES"; readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE"; }; /** * @public */ export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType]; /** *Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request – in the sessionConfiguration field
The ARN of the KMS key encrypting the session.
* @public */ kmsKeyArn: string | undefined; } /** * @public * @enum */ export declare const GuadrailAction: { readonly INTERVENED: "INTERVENED"; readonly NONE: "NONE"; }; /** * @public */ export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction]; /** *Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate response – in the output field
The response generated from querying the knowledge base.
* @public */ text: string | undefined; } /** * @public */ export interface RetrieveAndGenerateResponse { /** *The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.
Contains the response generated from querying the knowledge base.
* @public */ output: RetrieveAndGenerateOutput | undefined; /** *A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
* @public */ citations?: Citation[] | undefined; /** *Specifies if there is a guardrail intervention in the response.
* @public */ guardrailAction?: GuadrailAction | undefined; } /** *A citation event.
* @public */ export interface CitationEvent { /** *The citation.
* * @deprecated * @public */ citation?: Citation | undefined; /** *The generated response to the citation event.
* @public */ generatedResponsePart?: GeneratedResponsePart | undefined; /** *The retrieved references of the citation event.
* @public */ retrievedReferences?: RetrievedReference[] | undefined; } /** *A guardrail event.
* @public */ export interface GuardrailEvent { /** *The guardrail action.
* @public */ action?: GuadrailAction | undefined; } /** * @internal */ export declare const ActionGroupInvocationInputFilterSensitiveLog: (obj: ActionGroupInvocationInput) => any; /** * @internal */ export declare const UsageFilterSensitiveLog: (obj: Usage) => any; /** * @internal */ export declare const MetadataFilterSensitiveLog: (obj: Metadata) => any; /** * @internal */ export declare const ActionGroupInvocationOutputFilterSensitiveLog: (obj: ActionGroupInvocationOutput) => any; /** * @internal */ export declare const APISchemaFilterSensitiveLog: (obj: APISchema) => any; /** * @internal */ export declare const FunctionDefinitionFilterSensitiveLog: (obj: FunctionDefinition) => any; /** * @internal */ export declare const FunctionSchemaFilterSensitiveLog: (obj: FunctionSchema) => any; /** * @internal */ export declare const AgentActionGroupFilterSensitiveLog: (obj: AgentActionGroup) => any; /** * @internal */ export declare const ApiResultFilterSensitiveLog: (obj: ApiResult) => any; /** * @internal */ export declare const InvocationResultMemberFilterSensitiveLog: (obj: InvocationResultMember) => any; /** * @internal */ export declare const ReturnControlResultsFilterSensitiveLog: (obj: ReturnControlResults) => any; /** * @internal */ export declare const AgentCollaboratorInputPayloadFilterSensitiveLog: (obj: AgentCollaboratorInputPayload) => any; /** * @internal */ export declare const AgentCollaboratorInvocationInputFilterSensitiveLog: (obj: AgentCollaboratorInvocationInput) => any; /** * @internal */ export declare const ApiInvocationInputFilterSensitiveLog: (obj: ApiInvocationInput) => any; /** * @internal */ export declare const FunctionInvocationInputFilterSensitiveLog: (obj: FunctionInvocationInput) => any; /** * @internal */ export declare const InvocationInputMemberFilterSensitiveLog: (obj: InvocationInputMember) => any; /** * @internal */ export declare const ReturnControlPayloadFilterSensitiveLog: (obj: ReturnControlPayload) => any; /** * @internal */ export declare const AgentCollaboratorOutputPayloadFilterSensitiveLog: (obj: AgentCollaboratorOutputPayload) => any; /** * @internal */ export declare const AgentCollaboratorInvocationOutputFilterSensitiveLog: (obj: AgentCollaboratorInvocationOutput) => any; /** * @internal */ export declare const SatisfiedConditionFilterSensitiveLog: (obj: SatisfiedCondition) => any; /** * @internal */ export declare const ConditionResultEventFilterSensitiveLog: (obj: ConditionResultEvent) => any; /** * @internal */ export declare const FlowFailureEventFilterSensitiveLog: (obj: FlowFailureEvent) => any; /** * @internal */ export declare const FlowExecutionContentFilterSensitiveLog: (obj: FlowExecutionContent) => any; /** * @internal */ export declare const FlowInputFieldFilterSensitiveLog: (obj: FlowInputField) => any; /** * @internal */ export declare const FlowExecutionInputEventFilterSensitiveLog: (obj: FlowExecutionInputEvent) => any; /** * @internal */ export declare const FlowOutputFieldFilterSensitiveLog: (obj: FlowOutputField) => any; /** * @internal */ export declare const FlowExecutionOutputEventFilterSensitiveLog: (obj: FlowExecutionOutputEvent) => any; /** * @internal */ export declare const NodeFailureEventFilterSensitiveLog: (obj: NodeFailureEvent) => any; /** * @internal */ export declare const NodeExecutionContentFilterSensitiveLog: (obj: NodeExecutionContent) => any; /** * @internal */ export declare const NodeInputFieldFilterSensitiveLog: (obj: NodeInputField) => any; /** * @internal */ export declare const NodeInputEventFilterSensitiveLog: (obj: NodeInputEvent) => any; /** * @internal */ export declare const NodeOutputFieldFilterSensitiveLog: (obj: NodeOutputField) => any; /** * @internal */ export declare const NodeOutputEventFilterSensitiveLog: (obj: NodeOutputEvent) => any; /** * @internal */ export declare const FlowExecutionEventFilterSensitiveLog: (obj: FlowExecutionEvent) => any; /** * @internal */ export declare const ListFlowExecutionEventsResponseFilterSensitiveLog: (obj: ListFlowExecutionEventsResponse) => any; /** * @internal */ export declare const FlowInputContentFilterSensitiveLog: (obj: FlowInputContent) => any; /** * @internal */ export declare const FlowInputFilterSensitiveLog: (obj: FlowInput) => any; /** * @internal */ export declare const StartFlowExecutionRequestFilterSensitiveLog: (obj: StartFlowExecutionRequest) => any; /** * @internal */ export declare const InvokeFlowRequestFilterSensitiveLog: (obj: InvokeFlowRequest) => any; /** * @internal */ export declare const FlowCompletionEventFilterSensitiveLog: (obj: FlowCompletionEvent) => any; /** * @internal */ export declare const FlowMultiTurnInputRequestEventFilterSensitiveLog: (obj: FlowMultiTurnInputRequestEvent) => any; /** * @internal */ export declare const FlowOutputEventFilterSensitiveLog: (obj: FlowOutputEvent) => any; /** * @internal */ export declare const FlowTraceConditionFilterSensitiveLog: (obj: FlowTraceCondition) => any; /** * @internal */ export declare const FlowTraceConditionNodeResultEventFilterSensitiveLog: (obj: FlowTraceConditionNodeResultEvent) => any; /** * @internal */ export declare const FlowTraceNodeActionEventFilterSensitiveLog: (obj: FlowTraceNodeActionEvent) => any; /** * @internal */ export declare const FlowTraceNodeInputContentFilterSensitiveLog: (obj: FlowTraceNodeInputContent) => any; /** * @internal */ export declare const FlowTraceNodeInputFieldFilterSensitiveLog: (obj: FlowTraceNodeInputField) => any; /** * @internal */ export declare const FlowTraceNodeInputEventFilterSensitiveLog: (obj: FlowTraceNodeInputEvent) => any; /** * @internal */ export declare const FlowTraceNodeOutputFieldFilterSensitiveLog: (obj: FlowTraceNodeOutputField) => any; /** * @internal */ export declare const FlowTraceNodeOutputEventFilterSensitiveLog: (obj: FlowTraceNodeOutputEvent) => any; /** * @internal */ export declare const FlowTraceFilterSensitiveLog: (obj: FlowTrace) => any; /** * @internal */ export declare const FlowTraceEventFilterSensitiveLog: (obj: FlowTraceEvent) => any; /** * @internal */ export declare const FlowResponseStreamFilterSensitiveLog: (obj: FlowResponseStream) => any; /** * @internal */ export declare const InvokeFlowResponseFilterSensitiveLog: (obj: InvokeFlowResponse) => any; /** * @internal */ export declare const QueryGenerationInputFilterSensitiveLog: (obj: QueryGenerationInput) => any; /** * @internal */ export declare const GenerateQueryRequestFilterSensitiveLog: (obj: GenerateQueryRequest) => any; /** * @internal */ export declare const GeneratedQueryFilterSensitiveLog: (obj: GeneratedQuery) => any; /** * @internal */ export declare const GenerateQueryResponseFilterSensitiveLog: (obj: GenerateQueryResponse) => any; /** * @internal */ export declare const ContentBlockFilterSensitiveLog: (obj: ContentBlock) => any; /** * @internal */ export declare const MessageFilterSensitiveLog: (obj: Message) => any; /** * @internal */ export declare const ConversationHistoryFilterSensitiveLog: (obj: ConversationHistory) => any; /** * @internal */ export declare const ByteContentFileFilterSensitiveLog: (obj: ByteContentFile) => any; /** * @internal */ export declare const FileSourceFilterSensitiveLog: (obj: FileSource) => any; /** * @internal */ export declare const InputFileFilterSensitiveLog: (obj: InputFile) => any; /** * @internal */ export declare const MetadataAttributeSchemaFilterSensitiveLog: (obj: MetadataAttributeSchema) => any; /** * @internal */ export declare const ImplicitFilterConfigurationFilterSensitiveLog: (obj: ImplicitFilterConfiguration) => any; /** * @internal */ export declare const RerankingMetadataSelectiveModeConfigurationFilterSensitiveLog: (obj: RerankingMetadataSelectiveModeConfiguration) => any; /** * @internal */ export declare const MetadataConfigurationForRerankingFilterSensitiveLog: (obj: MetadataConfigurationForReranking) => any; /** * @internal */ export declare const VectorSearchBedrockRerankingConfigurationFilterSensitiveLog: (obj: VectorSearchBedrockRerankingConfiguration) => any; /** * @internal */ export declare const VectorSearchRerankingConfigurationFilterSensitiveLog: (obj: VectorSearchRerankingConfiguration) => any; /** * @internal */ export declare const TextResponsePartFilterSensitiveLog: (obj: TextResponsePart) => any; /** * @internal */ export declare const GeneratedResponsePartFilterSensitiveLog: (obj: GeneratedResponsePart) => any; /** * @internal */ export declare const RetrievalResultContentColumnFilterSensitiveLog: (obj: RetrievalResultContentColumn) => any; /** * @internal */ export declare const RetrievalResultContentFilterSensitiveLog: (obj: RetrievalResultContent) => any; /** * @internal */ export declare const RetrievalResultLocationFilterSensitiveLog: (obj: RetrievalResultLocation) => any; /** * @internal */ export declare const RetrievedReferenceFilterSensitiveLog: (obj: RetrievedReference) => any; /** * @internal */ export declare const CitationFilterSensitiveLog: (obj: Citation) => any; /** * @internal */ export declare const AttributionFilterSensitiveLog: (obj: Attribution) => any; /** * @internal */ export declare const PayloadPartFilterSensitiveLog: (obj: PayloadPart) => any; /** * @internal */ export declare const OutputFileFilterSensitiveLog: (obj: OutputFile) => any; /** * @internal */ export declare const FilePartFilterSensitiveLog: (obj: FilePart) => any; /** * @internal */ export declare const CustomOrchestrationTraceEventFilterSensitiveLog: (obj: CustomOrchestrationTraceEvent) => any; /** * @internal */ export declare const CustomOrchestrationTraceFilterSensitiveLog: (obj: CustomOrchestrationTrace) => any; /** * @internal */ export declare const FailureTraceFilterSensitiveLog: (obj: FailureTrace) => any; /** * @internal */ export declare const GuardrailContentFilterFilterSensitiveLog: (obj: GuardrailContentFilter) => any; /** * @internal */ export declare const GuardrailContentPolicyAssessmentFilterSensitiveLog: (obj: GuardrailContentPolicyAssessment) => any; /** * @internal */ export declare const GuardrailPiiEntityFilterFilterSensitiveLog: (obj: GuardrailPiiEntityFilter) => any; /** * @internal */ export declare const GuardrailRegexFilterFilterSensitiveLog: (obj: GuardrailRegexFilter) => any; /** * @internal */ export declare const GuardrailSensitiveInformationPolicyAssessmentFilterSensitiveLog: (obj: GuardrailSensitiveInformationPolicyAssessment) => any; /** * @internal */ export declare const GuardrailTopicFilterSensitiveLog: (obj: GuardrailTopic) => any; /** * @internal */ export declare const GuardrailTopicPolicyAssessmentFilterSensitiveLog: (obj: GuardrailTopicPolicyAssessment) => any; /** * @internal */ export declare const GuardrailCustomWordFilterSensitiveLog: (obj: GuardrailCustomWord) => any; /** * @internal */ export declare const GuardrailManagedWordFilterSensitiveLog: (obj: GuardrailManagedWord) => any; /** * @internal */ export declare const GuardrailWordPolicyAssessmentFilterSensitiveLog: (obj: GuardrailWordPolicyAssessment) => any; /** * @internal */ export declare const GuardrailAssessmentFilterSensitiveLog: (obj: GuardrailAssessment) => any; /** * @internal */ export declare const GuardrailTraceFilterSensitiveLog: (obj: GuardrailTrace) => any; /** * @internal */ export declare const KnowledgeBaseLookupInputFilterSensitiveLog: (obj: KnowledgeBaseLookupInput) => any; /** * @internal */ export declare const InvocationInputFilterSensitiveLog: (obj: InvocationInput) => any; /** * @internal */ export declare const ModelInvocationInputFilterSensitiveLog: (obj: ModelInvocationInput) => any; /** * @internal */ export declare const RawResponseFilterSensitiveLog: (obj: RawResponse) => any; /** * @internal */ export declare const ReasoningTextBlockFilterSensitiveLog: (obj: ReasoningTextBlock) => any; /** * @internal */ export declare const ReasoningContentBlockFilterSensitiveLog: (obj: ReasoningContentBlock) => any; /** * @internal */ export declare const OrchestrationModelInvocationOutputFilterSensitiveLog: (obj: OrchestrationModelInvocationOutput) => any; /** * @internal */ export declare const CodeInterpreterInvocationOutputFilterSensitiveLog: (obj: CodeInterpreterInvocationOutput) => any; /** * @internal */ export declare const FinalResponseFilterSensitiveLog: (obj: FinalResponse) => any; /** * @internal */ export declare const KnowledgeBaseLookupOutputFilterSensitiveLog: (obj: KnowledgeBaseLookupOutput) => any; /** * @internal */ export declare const RepromptResponseFilterSensitiveLog: (obj: RepromptResponse) => any; /** * @internal */ export declare const ObservationFilterSensitiveLog: (obj: Observation) => any; /** * @internal */ export declare const RationaleFilterSensitiveLog: (obj: Rationale) => any; /** * @internal */ export declare const OrchestrationTraceFilterSensitiveLog: (obj: OrchestrationTrace) => any; /** * @internal */ export declare const PostProcessingParsedResponseFilterSensitiveLog: (obj: PostProcessingParsedResponse) => any; /** * @internal */ export declare const PostProcessingModelInvocationOutputFilterSensitiveLog: (obj: PostProcessingModelInvocationOutput) => any; /** * @internal */ export declare const PostProcessingTraceFilterSensitiveLog: (obj: PostProcessingTrace) => any; /** * @internal */ export declare const PreProcessingParsedResponseFilterSensitiveLog: (obj: PreProcessingParsedResponse) => any; /** * @internal */ export declare const PreProcessingModelInvocationOutputFilterSensitiveLog: (obj: PreProcessingModelInvocationOutput) => any; /** * @internal */ export declare const PreProcessingTraceFilterSensitiveLog: (obj: PreProcessingTrace) => any; /** * @internal */ export declare const RoutingClassifierModelInvocationOutputFilterSensitiveLog: (obj: RoutingClassifierModelInvocationOutput) => any; /** * @internal */ export declare const RoutingClassifierTraceFilterSensitiveLog: (obj: RoutingClassifierTrace) => any; /** * @internal */ export declare const TraceFilterSensitiveLog: (obj: Trace) => any; /** * @internal */ export declare const TracePartFilterSensitiveLog: (obj: TracePart) => any; /** * @internal */ export declare const ResponseStreamFilterSensitiveLog: (obj: ResponseStream) => any; /** * @internal */ export declare const InvokeAgentResponseFilterSensitiveLog: (obj: InvokeAgentResponse) => any; /** * @internal */ export declare const CollaboratorConfigurationFilterSensitiveLog: (obj: CollaboratorConfiguration) => any; /** * @internal */ export declare const PromptConfigurationFilterSensitiveLog: (obj: PromptConfiguration) => any; /** * @internal */ export declare const PromptOverrideConfigurationFilterSensitiveLog: (obj: PromptOverrideConfiguration) => any; /** * @internal */ export declare const InlineSessionStateFilterSensitiveLog: (obj: InlineSessionState) => any; /** * @internal */ export declare const InlineAgentPayloadPartFilterSensitiveLog: (obj: InlineAgentPayloadPart) => any; /** * @internal */ export declare const InlineAgentFilePartFilterSensitiveLog: (obj: InlineAgentFilePart) => any; /** * @internal */ export declare const InlineAgentReturnControlPayloadFilterSensitiveLog: (obj: InlineAgentReturnControlPayload) => any; /** * @internal */ export declare const InlineAgentTracePartFilterSensitiveLog: (obj: InlineAgentTracePart) => any; /** * @internal */ export declare const InlineAgentResponseStreamFilterSensitiveLog: (obj: InlineAgentResponseStream) => any; /** * @internal */ export declare const InvokeInlineAgentResponseFilterSensitiveLog: (obj: InvokeInlineAgentResponse) => any; /** * @internal */ export declare const TextPromptFilterSensitiveLog: (obj: TextPrompt) => any; /** * @internal */ export declare const InputPromptFilterSensitiveLog: (obj: InputPrompt) => any; /** * @internal */ export declare const OptimizePromptRequestFilterSensitiveLog: (obj: OptimizePromptRequest) => any; /** * @internal */ export declare const AnalyzePromptEventFilterSensitiveLog: (obj: AnalyzePromptEvent) => any; /** * @internal */ export declare const OptimizedPromptFilterSensitiveLog: (obj: OptimizedPrompt) => any; /** * @internal */ export declare const OptimizedPromptEventFilterSensitiveLog: (obj: OptimizedPromptEvent) => any; /** * @internal */ export declare const OptimizedPromptStreamFilterSensitiveLog: (obj: OptimizedPromptStream) => any; /** * @internal */ export declare const OptimizePromptResponseFilterSensitiveLog: (obj: OptimizePromptResponse) => any; /** * @internal */ export declare const RerankTextDocumentFilterSensitiveLog: (obj: RerankTextDocument) => any; /** * @internal */ export declare const RerankQueryFilterSensitiveLog: (obj: RerankQuery) => any; /** * @internal */ export declare const RerankDocumentFilterSensitiveLog: (obj: RerankDocument) => any; /** * @internal */ export declare const RerankSourceFilterSensitiveLog: (obj: RerankSource) => any; /** * @internal */ export declare const RerankRequestFilterSensitiveLog: (obj: RerankRequest) => any; /** * @internal */ export declare const RerankResultFilterSensitiveLog: (obj: RerankResult) => any; /** * @internal */ export declare const RerankResponseFilterSensitiveLog: (obj: RerankResponse) => any; /** * @internal */ export declare const RetrieveAndGenerateInputFilterSensitiveLog: (obj: RetrieveAndGenerateInput) => any; /** * @internal */ export declare const PromptTemplateFilterSensitiveLog: (obj: PromptTemplate) => any; /** * @internal */ export declare const ExternalSourcesGenerationConfigurationFilterSensitiveLog: (obj: ExternalSourcesGenerationConfiguration) => any; /** * @internal */ export declare const ByteContentDocFilterSensitiveLog: (obj: ByteContentDoc) => any; /** * @internal */ export declare const ExternalSourceFilterSensitiveLog: (obj: ExternalSource) => any; /** * @internal */ export declare const ExternalSourcesRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: ExternalSourcesRetrieveAndGenerateConfiguration) => any; /** * @internal */ export declare const GenerationConfigurationFilterSensitiveLog: (obj: GenerationConfiguration) => any; /** * @internal */ export declare const OrchestrationConfigurationFilterSensitiveLog: (obj: OrchestrationConfiguration) => any; /** * @internal */ export declare const RetrieveAndGenerateOutputFilterSensitiveLog: (obj: RetrieveAndGenerateOutput) => any; /** * @internal */ export declare const RetrieveAndGenerateResponseFilterSensitiveLog: (obj: RetrieveAndGenerateResponse) => any; /** * @internal */ export declare const CitationEventFilterSensitiveLog: (obj: CitationEvent) => any;