@aws-sdk/client-bedrock-agent-runtime
Advanced tools
@aws-sdk/client-bedrock-agent-runtime - npm Package Compare versions
Comparing version 3.529.1 to 3.530.0
@@ -28,5 +28,5 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types"; | ||
| * @public | ||
| * Amazon Bedrock Agent | ||
| * <p>Contains APIs related to model invocation and querying of knowledge bases.</p> | ||
| */ | ||
| export declare class BedrockAgentRuntime extends BedrockAgentRuntimeClient implements BedrockAgentRuntime { | ||
| } |
@@ -163,3 +163,3 @@ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header"; | ||
| * @public | ||
| * Amazon Bedrock Agent | ||
| * <p>Contains APIs related to model invocation and querying of knowledge bases.</p> | ||
| */ | ||
@@ -166,0 +166,0 @@ export declare class BedrockAgentRuntimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BedrockAgentRuntimeClientResolvedConfig> { |
@@ -29,3 +29,32 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @public | ||
| * Invokes the specified Bedrock model to run inference using the input provided in the request body. | ||
| * <p>Sends a prompt for the agent to process and respond to.</p> | ||
| * <note> | ||
| * <p>The CLI doesn't support <code>InvokeAgent</code>.</p> | ||
| * </note> | ||
| * <ul> | ||
| * <li> | ||
| * <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>Include attributes for the session or prompt in the <code>sessionState</code> object.</p> | ||
| * </li> | ||
| * </ul> | ||
| * <p>The response is returned in the <code>bytes</code> field of the <code>chunk</code> object.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>attribution</code> object contains citations for parts of the response.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>Errors are also surfaced in the response.</p> | ||
| * </li> | ||
| * </ul> | ||
| * @example | ||
@@ -276,27 +305,27 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * This exception is thrown when a request is denied per access permissions | ||
| * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p> | ||
| * | ||
| * @throws {@link BadGatewayException} (server fault) | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource | ||
| * <p>There was an issue with a dependency due to a server issue. Retry your request.</p> | ||
| * | ||
| * @throws {@link ConflictException} (client fault) | ||
| * This exception is thrown when there is a conflict performing an operation | ||
| * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p> | ||
| * | ||
| * @throws {@link DependencyFailedException} (client fault) | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration) | ||
| * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * This exception is thrown if there was an unexpected error during processing of request | ||
| * <p>An internal server error occurred. Retry your request.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * This exception is thrown when a resource referenced by the operation does not exist | ||
| * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p> | ||
| * | ||
| * @throws {@link ServiceQuotaExceededException} (client fault) | ||
| * This exception is thrown when a request is made beyond the service quota | ||
| * <p>The number of requests exceeds the service quota. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * This exception is thrown when the number of requests exceeds the limit | ||
| * <p>The number of requests exceeds the limit. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * This exception is thrown when the request's input validation fails | ||
| * <p>Input validation failed. Check your request parameters and retry the request.</p> | ||
| * | ||
@@ -303,0 +332,0 @@ * @throws {@link BedrockAgentRuntimeServiceException} |
@@ -29,3 +29,6 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @public | ||
| * RetrieveAndGenerate API | ||
| * <p>Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query.</p> | ||
| * <note> | ||
| * <p>The <code>numberOfResults</code> field is currently unsupported for <code>RetrieveAndGenerate</code>. Don't include it in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_KnowledgeBaseVectorSearchConfiguration.html">vectorSearchConfiguration</a> object.</p> | ||
| * </note> | ||
| * @example | ||
@@ -103,27 +106,27 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * This exception is thrown when a request is denied per access permissions | ||
| * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p> | ||
| * | ||
| * @throws {@link BadGatewayException} (server fault) | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource | ||
| * <p>There was an issue with a dependency due to a server issue. Retry your request.</p> | ||
| * | ||
| * @throws {@link ConflictException} (client fault) | ||
| * This exception is thrown when there is a conflict performing an operation | ||
| * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p> | ||
| * | ||
| * @throws {@link DependencyFailedException} (client fault) | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration) | ||
| * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * This exception is thrown if there was an unexpected error during processing of request | ||
| * <p>An internal server error occurred. Retry your request.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * This exception is thrown when a resource referenced by the operation does not exist | ||
| * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p> | ||
| * | ||
| * @throws {@link ServiceQuotaExceededException} (client fault) | ||
| * This exception is thrown when a request is made beyond the service quota | ||
| * <p>The number of requests exceeds the service quota. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * This exception is thrown when the number of requests exceeds the limit | ||
| * <p>The number of requests exceeds the limit. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * This exception is thrown when the request's input validation fails | ||
| * <p>Input validation failed. Check your request parameters and retry the request.</p> | ||
| * | ||
@@ -130,0 +133,0 @@ * @throws {@link BedrockAgentRuntimeServiceException} |
@@ -29,3 +29,3 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * @public | ||
| * Retrieve from knowledge base. | ||
| * <p>Queries a knowledge base and retrieves information from it.</p> | ||
| * @example | ||
@@ -79,27 +79,27 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * This exception is thrown when a request is denied per access permissions | ||
| * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p> | ||
| * | ||
| * @throws {@link BadGatewayException} (server fault) | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource | ||
| * <p>There was an issue with a dependency due to a server issue. Retry your request.</p> | ||
| * | ||
| * @throws {@link ConflictException} (client fault) | ||
| * This exception is thrown when there is a conflict performing an operation | ||
| * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p> | ||
| * | ||
| * @throws {@link DependencyFailedException} (client fault) | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration) | ||
| * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * This exception is thrown if there was an unexpected error during processing of request | ||
| * <p>An internal server error occurred. Retry your request.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * This exception is thrown when a resource referenced by the operation does not exist | ||
| * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p> | ||
| * | ||
| * @throws {@link ServiceQuotaExceededException} (client fault) | ||
| * This exception is thrown when a request is made beyond the service quota | ||
| * <p>The number of requests exceeds the service quota. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * This exception is thrown when the number of requests exceeds the limit | ||
| * <p>The number of requests exceeds the limit. Resubmit your request later.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * This exception is thrown when the request's input validation fails | ||
| * <p>Input validation failed. Check your request parameters and retry the request.</p> | ||
| * | ||
@@ -106,0 +106,0 @@ * @throws {@link BedrockAgentRuntimeServiceException} |
| /** | ||
| * Amazon Bedrock Agent | ||
| * <p>Contains APIs related to model invocation and querying of knowledge bases.</p> | ||
| * | ||
@@ -4,0 +4,0 @@ * @packageDocumentation |
@@ -5,3 +5,3 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; | ||
| * @public | ||
| * This exception is thrown when a request is denied per access permissions | ||
| * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p> | ||
| */ | ||
@@ -18,3 +18,3 @@ export declare class AccessDeniedException extends __BaseException { | ||
| * @public | ||
| * parameters included in action group invocation | ||
| * <p>A parameter in the Lambda input event.</p> | ||
| */ | ||
@@ -24,3 +24,3 @@ export interface Parameter { | ||
| * @public | ||
| * Name of parameter | ||
| * <p>The name of the parameter.</p> | ||
| */ | ||
@@ -30,3 +30,3 @@ name?: string; | ||
| * @public | ||
| * Type of parameter | ||
| * <p>The type of the parameter.</p> | ||
| */ | ||
@@ -36,3 +36,3 @@ type?: string; | ||
| * @public | ||
| * Value of parameter | ||
| * <p>The value of the parameter.</p> | ||
| */ | ||
@@ -43,3 +43,3 @@ value?: string; | ||
| * @public | ||
| * Request Body Content Map | ||
| * <p>The parameters in the request body for the Lambda input event.</p> | ||
| */ | ||
@@ -49,3 +49,3 @@ export interface RequestBody { | ||
| * @public | ||
| * Content type paramter map | ||
| * <p>The content in the request body.</p> | ||
| */ | ||
@@ -56,3 +56,3 @@ content?: Record<string, Parameter[]>; | ||
| * @public | ||
| * input to lambda used in action group | ||
| * <p>Contains information about the action group being invoked.</p> | ||
| */ | ||
@@ -62,3 +62,3 @@ export interface ActionGroupInvocationInput { | ||
| * @public | ||
| * Agent Trace Action Group Name | ||
| * <p>The name of the action group.</p> | ||
| */ | ||
@@ -68,3 +68,3 @@ actionGroupName?: string; | ||
| * @public | ||
| * Agent Trace Action Group Action verb | ||
| * <p>The API method being used, based off the action group.</p> | ||
| */ | ||
@@ -74,3 +74,3 @@ verb?: string; | ||
| * @public | ||
| * Agent Trace Action Group API path | ||
| * <p>The path to the API to call, based off the action group.</p> | ||
| */ | ||
@@ -80,3 +80,3 @@ apiPath?: string; | ||
| * @public | ||
| * list of parameters included in action group invocation | ||
| * <p>The parameters in the Lambda input event.</p> | ||
| */ | ||
@@ -86,3 +86,3 @@ parameters?: Parameter[]; | ||
| * @public | ||
| * Request Body Content Map | ||
| * <p>The parameters in the request body for the Lambda input event.</p> | ||
| */ | ||
@@ -93,3 +93,3 @@ requestBody?: RequestBody; | ||
| * @public | ||
| * output from lambda used in action group | ||
| * <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p> | ||
| */ | ||
@@ -99,3 +99,3 @@ export interface ActionGroupInvocationOutput { | ||
| * @public | ||
| * Agent Trace Action Group Lambda Invocation Output String | ||
| * <p>The JSON-formatted string returned by the API invoked by the action group.</p> | ||
| */ | ||
@@ -106,3 +106,3 @@ text?: string; | ||
| * @public | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource | ||
| * <p>There was an issue with a dependency due to a server issue. Retry your request.</p> | ||
| */ | ||
@@ -114,3 +114,3 @@ export declare class BadGatewayException extends __BaseException { | ||
| * @public | ||
| * Non Blank String | ||
| * <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p> | ||
| */ | ||
@@ -125,3 +125,3 @@ resourceName?: string; | ||
| * @public | ||
| * This exception is thrown when there is a conflict performing an operation | ||
| * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p> | ||
| */ | ||
@@ -138,3 +138,3 @@ export declare class ConflictException extends __BaseException { | ||
| * @public | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration) | ||
| * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p> | ||
| */ | ||
@@ -146,3 +146,3 @@ export declare class DependencyFailedException extends __BaseException { | ||
| * @public | ||
| * Non Blank String | ||
| * <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p> | ||
| */ | ||
@@ -157,3 +157,3 @@ resourceName?: string; | ||
| * @public | ||
| * This exception is thrown if there was an unexpected error during processing of request | ||
| * <p>An internal server error occurred. Retry your request.</p> | ||
| */ | ||
@@ -170,3 +170,3 @@ export declare class InternalServerException extends __BaseException { | ||
| * @public | ||
| * Session state provided | ||
| * <p>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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessionstate.html">Session context</a>.</p> | ||
| */ | ||
@@ -176,3 +176,3 @@ export interface SessionState { | ||
| * @public | ||
| * Session Attributes | ||
| * <p>Contains attributes that persist across a session and the values of those attributes.</p> | ||
| */ | ||
@@ -182,3 +182,3 @@ sessionAttributes?: Record<string, string>; | ||
| * @public | ||
| * Prompt Session Attributes | ||
| * <p>Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p> | ||
| */ | ||
@@ -189,3 +189,2 @@ promptSessionAttributes?: Record<string, string>; | ||
| * @public | ||
| * InvokeAgent Request | ||
| */ | ||
@@ -195,3 +194,3 @@ export interface InvokeAgentRequest { | ||
| * @public | ||
| * Session state passed by customer. Base64 encoded json string representation of SessionState. | ||
| * <p>Contains parameters that specify various attributes of the session.</p> | ||
| */ | ||
@@ -201,3 +200,3 @@ sessionState?: SessionState; | ||
| * @public | ||
| * Identifier for Agent | ||
| * <p>The unique identifier of the agent to use.</p> | ||
| */ | ||
@@ -207,3 +206,3 @@ agentId: string | undefined; | ||
| * @public | ||
| * Identifier for Agent Alias | ||
| * <p>The alias of the agent to use.</p> | ||
| */ | ||
@@ -213,3 +212,3 @@ agentAliasId: string | undefined; | ||
| * @public | ||
| * Identifier used for the current session | ||
| * <p>The unique identifier of the session. Use the same value across requests to continue the same conversation.</p> | ||
| */ | ||
@@ -219,3 +218,3 @@ sessionId: string | undefined; | ||
| * @public | ||
| * End current session | ||
| * <p>Specifies whether to end the session with the agent or not.</p> | ||
| */ | ||
@@ -225,3 +224,3 @@ endSession?: boolean; | ||
| * @public | ||
| * Enable agent trace events for improved debugging | ||
| * <p>Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p> | ||
| */ | ||
@@ -231,3 +230,3 @@ enableTrace?: boolean; | ||
| * @public | ||
| * Input data in the format specified in the Content-Type request header. | ||
| * <p>The prompt text to send the agent.</p> | ||
| */ | ||
@@ -238,3 +237,3 @@ inputText: string | undefined; | ||
| * @public | ||
| * Span of text | ||
| * <p>Contains information about where the text with a citation begins and ends in the generated output.</p> | ||
| */ | ||
@@ -244,3 +243,3 @@ export interface Span { | ||
| * @public | ||
| * Start of span | ||
| * <p>Where the text with a citation starts in the generated output.</p> | ||
| */ | ||
@@ -250,3 +249,3 @@ start?: number; | ||
| * @public | ||
| * End of span | ||
| * <p>Where the text with a citation ends in the generated output.</p> | ||
| */ | ||
@@ -257,3 +256,3 @@ end?: number; | ||
| * @public | ||
| * Text response part | ||
| * <p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</p> | ||
| */ | ||
@@ -263,3 +262,3 @@ export interface TextResponsePart { | ||
| * @public | ||
| * Response part in text | ||
| * <p>The part of the generated text that contains a citation.</p> | ||
| */ | ||
@@ -269,3 +268,3 @@ text?: string; | ||
| * @public | ||
| * Span of text | ||
| * <p>Contains information about where the text with a citation begins and ends in the generated output.</p> | ||
| */ | ||
@@ -276,3 +275,3 @@ span?: Span; | ||
| * @public | ||
| * Generate response part | ||
| * <p>Contains metadata about a part of the generated response that is accompanied by a citation.</p> | ||
| */ | ||
@@ -282,3 +281,3 @@ export interface GeneratedResponsePart { | ||
| * @public | ||
| * Text response part | ||
| * <p>Contains metadata about a textual part of the generated response that is accompanied by a citation.</p> | ||
| */ | ||
@@ -289,3 +288,3 @@ textResponsePart?: TextResponsePart; | ||
| * @public | ||
| * Content of a retrieval result. | ||
| * <p>Contains the cited text from the data source.</p> | ||
| */ | ||
@@ -295,3 +294,3 @@ export interface RetrievalResultContent { | ||
| * @public | ||
| * Content of a retrieval result in text | ||
| * <p>The cited text from the data source.</p> | ||
| */ | ||
@@ -302,3 +301,3 @@ text: string | undefined; | ||
| * @public | ||
| * The S3 location of a retrieval result. | ||
| * <p>Contains the S3 location of the data source.</p> | ||
| */ | ||
@@ -308,3 +307,3 @@ export interface RetrievalResultS3Location { | ||
| * @public | ||
| * URI of S3 location | ||
| * <p>The S3 URI of the data source.</p> | ||
| */ | ||
@@ -326,3 +325,3 @@ uri?: string; | ||
| * @public | ||
| * The source location of a retrieval result. | ||
| * <p>Contains information about the location of the data source.</p> | ||
| */ | ||
@@ -332,3 +331,3 @@ export interface RetrievalResultLocation { | ||
| * @public | ||
| * The location type of a retrieval result. | ||
| * <p>The type of the location of the data source.</p> | ||
| */ | ||
@@ -338,3 +337,3 @@ type: RetrievalResultLocationType | undefined; | ||
| * @public | ||
| * The S3 location of a retrieval result. | ||
| * <p>Contains the S3 location of the data source.</p> | ||
| */ | ||
@@ -345,3 +344,3 @@ s3Location?: RetrievalResultS3Location; | ||
| * @public | ||
| * Retrieved reference | ||
| * <p>Contains metadata about a sources cited for the generated response.</p> | ||
| */ | ||
@@ -351,3 +350,3 @@ export interface RetrievedReference { | ||
| * @public | ||
| * Content of a retrieval result. | ||
| * <p>Contains the cited text from the data source.</p> | ||
| */ | ||
@@ -357,3 +356,3 @@ content?: RetrievalResultContent; | ||
| * @public | ||
| * The source location of a retrieval result. | ||
| * <p>Contains information about the location of the data source.</p> | ||
| */ | ||
@@ -364,3 +363,3 @@ location?: RetrievalResultLocation; | ||
| * @public | ||
| * Citation associated with the agent response | ||
| * <p>An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.</p> | ||
| */ | ||
@@ -370,3 +369,3 @@ export interface Citation { | ||
| * @public | ||
| * Generate response part | ||
| * <p>Contains the generated response and metadata </p> | ||
| */ | ||
@@ -376,3 +375,3 @@ generatedResponsePart?: GeneratedResponsePart; | ||
| * @public | ||
| * list of retrieved references | ||
| * <p>Contains metadata about the sources cited for the generated response.</p> | ||
| */ | ||
@@ -383,3 +382,3 @@ retrievedReferences?: RetrievedReference[]; | ||
| * @public | ||
| * Citations associated with final agent response | ||
| * <p>Contains citations for a part of an agent response.</p> | ||
| */ | ||
@@ -389,3 +388,3 @@ export interface Attribution { | ||
| * @public | ||
| * List of citations | ||
| * <p>A list of citations and related information for a part of an agent response.</p> | ||
| */ | ||
@@ -396,3 +395,3 @@ citations?: Citation[]; | ||
| * @public | ||
| * Base 64 endoded byte response | ||
| * <p>Contains a part of an agent response and citations for it.</p> | ||
| */ | ||
@@ -402,3 +401,3 @@ export interface PayloadPart { | ||
| * @public | ||
| * PartBody of the payload in bytes | ||
| * <p>A part of the agent response in bytes.</p> | ||
| */ | ||
@@ -408,3 +407,3 @@ bytes?: Uint8Array; | ||
| * @public | ||
| * Citations associated with final agent response | ||
| * <p>Contains citations for a part of an agent response.</p> | ||
| */ | ||
@@ -415,3 +414,3 @@ attribution?: Attribution; | ||
| * @public | ||
| * This exception is thrown when a resource referenced by the operation does not exist | ||
| * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p> | ||
| */ | ||
@@ -428,3 +427,3 @@ export declare class ResourceNotFoundException extends __BaseException { | ||
| * @public | ||
| * This exception is thrown when a request is made beyond the service quota | ||
| * <p>The number of requests exceeds the service quota. Resubmit your request later.</p> | ||
| */ | ||
@@ -441,3 +440,3 @@ export declare class ServiceQuotaExceededException extends __BaseException { | ||
| * @public | ||
| * This exception is thrown when the number of requests exceeds the limit | ||
| * <p>The number of requests exceeds the limit. Resubmit your request later.</p> | ||
| */ | ||
@@ -454,3 +453,3 @@ export declare class ThrottlingException extends __BaseException { | ||
| * @public | ||
| * Trace Part which is emitted when agent trace could not be generated | ||
| * <p>Contains information about the failure of the interaction.</p> | ||
| */ | ||
@@ -460,3 +459,3 @@ export interface FailureTrace { | ||
| * @public | ||
| * Identifier for trace | ||
| * <p>The unique identifier of the trace.</p> | ||
| */ | ||
@@ -466,3 +465,3 @@ traceId?: string; | ||
| * @public | ||
| * Agent Trace Failed Reason String | ||
| * <p>The reason the interaction failed.</p> | ||
| */ | ||
@@ -486,3 +485,3 @@ failureReason?: string; | ||
| * @public | ||
| * Input to lambda used in action group | ||
| * <p>Contains details about the knowledge base to look up and the query to be made.</p> | ||
| */ | ||
@@ -492,3 +491,3 @@ export interface KnowledgeBaseLookupInput { | ||
| * @public | ||
| * Agent Trace Action Group Lambda Invocation Output String | ||
| * <p>The query made to the knowledge base.</p> | ||
| */ | ||
@@ -498,3 +497,3 @@ text?: string; | ||
| * @public | ||
| * Agent Trace Action Group Knowledge Base Id | ||
| * <p>The unique identifier of the knowledge base to look up.</p> | ||
| */ | ||
@@ -505,3 +504,3 @@ knowledgeBaseId?: string; | ||
| * @public | ||
| * Trace Part which contains input details for action group or knowledge base | ||
| * <p>Contains information pertaining to the action group or knowledge base that is being invoked.</p> | ||
| */ | ||
@@ -511,3 +510,3 @@ export interface InvocationInput { | ||
| * @public | ||
| * Identifier for trace | ||
| * <p>The unique identifier of the trace.</p> | ||
| */ | ||
@@ -517,3 +516,3 @@ traceId?: string; | ||
| * @public | ||
| * types of invocations | ||
| * <p>Specifies whether the agent is invoking an action group or a knowledge base.</p> | ||
| */ | ||
@@ -523,3 +522,3 @@ invocationType?: InvocationType; | ||
| * @public | ||
| * input to lambda used in action group | ||
| * <p>Contains information about the action group to be invoked.</p> | ||
| */ | ||
@@ -529,3 +528,3 @@ actionGroupInvocationInput?: ActionGroupInvocationInput; | ||
| * @public | ||
| * Input to lambda used in action group | ||
| * <p>Contains details about the knowledge base to look up and the query to be made.</p> | ||
| */ | ||
@@ -536,3 +535,3 @@ knowledgeBaseLookupInput?: KnowledgeBaseLookupInput; | ||
| * @public | ||
| * Configurations for controlling the inference response of an InvokeAgent API call | ||
| * <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p> | ||
| */ | ||
@@ -542,3 +541,3 @@ export interface InferenceConfiguration { | ||
| * @public | ||
| * Controls randomness, higher values increase diversity | ||
| * <p>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.</p> | ||
| */ | ||
@@ -548,3 +547,3 @@ temperature?: number; | ||
| * @public | ||
| * Cumulative probability cutoff for token selection | ||
| * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p> | ||
| */ | ||
@@ -554,3 +553,3 @@ topP?: number; | ||
| * @public | ||
| * Sample from the k most likely next tokens | ||
| * <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>topK</code> is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topK</code> to 50, the model selects the next token from among the top 50 most likely choices.</p> | ||
| */ | ||
@@ -560,3 +559,3 @@ topK?: number; | ||
| * @public | ||
| * Maximum length of output | ||
| * <p>The maximum number of tokens allowed in the generated response.</p> | ||
| */ | ||
@@ -566,3 +565,3 @@ maximumLength?: number; | ||
| * @public | ||
| * List of stop sequences | ||
| * <p>A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.</p> | ||
| */ | ||
@@ -599,3 +598,14 @@ stopSequences?: string[]; | ||
| * @public | ||
| * Trace Part which contains information used to call Invoke Model | ||
| * <p>The input for the pre-processing step.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>type</code> matches the agent step.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>text</code> contains the prompt.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p> | ||
| * </li> | ||
| * </ul> | ||
| */ | ||
@@ -605,3 +615,3 @@ export interface ModelInvocationInput { | ||
| * @public | ||
| * Identifier for trace | ||
| * <p>The unique identifier of the trace.</p> | ||
| */ | ||
@@ -611,3 +621,3 @@ traceId?: string; | ||
| * @public | ||
| * Prompt Message | ||
| * <p>The text that prompted the agent at this step.</p> | ||
| */ | ||
@@ -617,3 +627,3 @@ text?: string; | ||
| * @public | ||
| * types of prompts | ||
| * <p>The step in the agent sequence.</p> | ||
| */ | ||
@@ -623,3 +633,3 @@ type?: PromptType; | ||
| * @public | ||
| * Configurations for controlling the inference response of an InvokeAgent API call | ||
| * <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p> | ||
| */ | ||
@@ -629,3 +639,3 @@ inferenceConfiguration?: InferenceConfiguration; | ||
| * @public | ||
| * ARN of a Lambda. | ||
| * <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.</p> | ||
| */ | ||
@@ -635,3 +645,3 @@ overrideLambda?: string; | ||
| * @public | ||
| * indicates if agent uses default prompt or overriden prompt | ||
| * <p>Specifies whether the default prompt template was <code>OVERRIDDEN</code>. If it was, the <code>basePromptTemplate</code> that was set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object when the agent was created or updated is used instead.</p> | ||
| */ | ||
@@ -641,3 +651,3 @@ promptCreationMode?: CreationMode; | ||
| * @public | ||
| * indicates if agent uses default prompt or overriden prompt | ||
| * <p>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 <code>promptType</code>.</p> | ||
| */ | ||
@@ -648,3 +658,3 @@ parserMode?: CreationMode; | ||
| * @public | ||
| * Agent finish output | ||
| * <p>Contains details about the response to the user.</p> | ||
| */ | ||
@@ -654,3 +664,3 @@ export interface FinalResponse { | ||
| * @public | ||
| * Agent Trace Action Group Lambda Invocation Output String | ||
| * <p>The text in the response to the user.</p> | ||
| */ | ||
@@ -661,3 +671,3 @@ text?: string; | ||
| * @public | ||
| * Input to lambda used in action group | ||
| * <p>Contains details about the results from looking up the knowledge base.</p> | ||
| */ | ||
@@ -667,3 +677,3 @@ export interface KnowledgeBaseLookupOutput { | ||
| * @public | ||
| * list of retrieved references | ||
| * <p>Contains metadata about the sources cited for the generated response.</p> | ||
| */ | ||
@@ -687,3 +697,3 @@ retrievedReferences?: RetrievedReference[]; | ||
| * @public | ||
| * Observation information if there were reprompts | ||
| * <p>Contains details about the agent's response to reprompt the input.</p> | ||
| */ | ||
@@ -693,3 +703,3 @@ export interface RepromptResponse { | ||
| * @public | ||
| * Reprompt response text | ||
| * <p>The text reprompting the input.</p> | ||
| */ | ||
@@ -699,3 +709,3 @@ text?: string; | ||
| * @public | ||
| * Parsing error source | ||
| * <p>Specifies what output is prompting the agent to reprompt the input.</p> | ||
| */ | ||
@@ -721,3 +731,3 @@ source?: Source; | ||
| * @public | ||
| * Trace Part which contains output details for action group or knowledge base or final response | ||
| * <p>Contains the result or output of an action group or knowledge base, or the response to the user.</p> | ||
| */ | ||
@@ -727,3 +737,3 @@ export interface Observation { | ||
| * @public | ||
| * Identifier for trace | ||
| * <p>The unique identifier of the trace.</p> | ||
| */ | ||
@@ -733,3 +743,25 @@ traceId?: string; | ||
| * @public | ||
| * types of observations | ||
| * <p>Specifies what kind of information the agent returns in the observation. The following values are possible.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p> | ||
| * <code>ACTION_GROUP</code> – The agent returns the result of an action group.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <code>KNOWLEDGE_BASE</code> – The agent returns information from a knowledge base.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <code>FINISH</code> – The agent returns a final response to the user with no follow-up.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <code>ASK_USER</code> – The agent asks the user a question.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <code>REPROMPT</code> – The agent prompts the user again for the same information.</p> | ||
| * </li> | ||
| * </ul> | ||
| */ | ||
@@ -739,3 +771,3 @@ type?: Type; | ||
| * @public | ||
| * output from lambda used in action group | ||
| * <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p> | ||
| */ | ||
@@ -745,3 +777,3 @@ actionGroupInvocationOutput?: ActionGroupInvocationOutput; | ||
| * @public | ||
| * Input to lambda used in action group | ||
| * <p>Contains details about the results from looking up the knowledge base.</p> | ||
| */ | ||
@@ -751,3 +783,3 @@ knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput; | ||
| * @public | ||
| * Agent finish output | ||
| * <p>Contains details about the response to the user.</p> | ||
| */ | ||
@@ -757,3 +789,3 @@ finalResponse?: FinalResponse; | ||
| * @public | ||
| * Observation information if there were reprompts | ||
| * <p>Contains details about the response to reprompt the input.</p> | ||
| */ | ||
@@ -764,3 +796,3 @@ repromptResponse?: RepromptResponse; | ||
| * @public | ||
| * Trace Part which contains information related to reasoning | ||
| * <p>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.</p> | ||
| */ | ||
@@ -770,3 +802,3 @@ export interface Rationale { | ||
| * @public | ||
| * Identifier for trace | ||
| * <p>The unique identifier of the trace step.</p> | ||
| */ | ||
@@ -776,3 +808,3 @@ traceId?: string; | ||
| * @public | ||
| * Agent Trace Rationale String | ||
| * <p>The reasoning or thought process of the agent, based on the input.</p> | ||
| */ | ||
@@ -783,3 +815,3 @@ text?: string; | ||
| * @public | ||
| * Trace contains intermidate response during orchestration | ||
| * <p>Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.</p> | ||
| */ | ||
@@ -793,3 +825,3 @@ export type OrchestrationTrace = OrchestrationTrace.InvocationInputMember | OrchestrationTrace.ModelInvocationInputMember | OrchestrationTrace.ObservationMember | OrchestrationTrace.RationaleMember | OrchestrationTrace.$UnknownMember; | ||
| * @public | ||
| * Trace Part which contains information related to reasoning | ||
| * <p>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.</p> | ||
| */ | ||
@@ -805,3 +837,3 @@ interface RationaleMember { | ||
| * @public | ||
| * Trace Part which contains input details for action group or knowledge base | ||
| * <p>Contains information pertaining to the action group or knowledge base that is being invoked.</p> | ||
| */ | ||
@@ -817,3 +849,3 @@ interface InvocationInputMember { | ||
| * @public | ||
| * Trace Part which contains output details for action group or knowledge base or final response | ||
| * <p>Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.</p> | ||
| */ | ||
@@ -829,3 +861,14 @@ interface ObservationMember { | ||
| * @public | ||
| * Trace Part which contains information used to call Invoke Model | ||
| * <p>The input for the orchestration step.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>type</code> is <code>ORCHESTRATION</code>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>text</code> contains the prompt.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p> | ||
| * </li> | ||
| * </ul> | ||
| */ | ||
@@ -860,3 +903,3 @@ interface ModelInvocationInputMember { | ||
| * @public | ||
| * Trace Part which contains information if preprocessing was successful | ||
| * <p>Details about the response from the Lambda parsing of the output from the post-processing step.</p> | ||
| */ | ||
@@ -866,3 +909,3 @@ export interface PostProcessingParsedResponse { | ||
| * @public | ||
| * Agent Trace Output String | ||
| * <p>The text returned by the parser.</p> | ||
| */ | ||
@@ -873,3 +916,3 @@ text?: string; | ||
| * @public | ||
| * Trace Part which contains information related to postprocessing | ||
| * <p>The foundation model output from the post-processing step.</p> | ||
| */ | ||
@@ -879,3 +922,3 @@ export interface PostProcessingModelInvocationOutput { | ||
| * @public | ||
| * Identifier for trace | ||
| * <p>The unique identifier of the trace.</p> | ||
| */ | ||
@@ -885,3 +928,3 @@ traceId?: string; | ||
| * @public | ||
| * Trace Part which contains information if preprocessing was successful | ||
| * <p>Details about the response from the Lambda parsing of the output of the post-processing step.</p> | ||
| */ | ||
@@ -892,3 +935,3 @@ parsedResponse?: PostProcessingParsedResponse; | ||
| * @public | ||
| * Trace Part which contains information related to post processing step | ||
| * <p>Details about the post-processing step, in which the agent shapes the response.</p> | ||
| */ | ||
@@ -902,3 +945,14 @@ export type PostProcessingTrace = PostProcessingTrace.ModelInvocationInputMember | PostProcessingTrace.ModelInvocationOutputMember | PostProcessingTrace.$UnknownMember; | ||
| * @public | ||
| * Trace Part which contains information used to call Invoke Model | ||
| * <p>The input for the post-processing step.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>type</code> is <code>POST_PROCESSING</code>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>text</code> contains the prompt.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p> | ||
| * </li> | ||
| * </ul> | ||
| */ | ||
@@ -912,3 +966,3 @@ interface ModelInvocationInputMember { | ||
| * @public | ||
| * Trace Part which contains information related to postprocessing | ||
| * <p>The foundation model output from the post-processing step.</p> | ||
| */ | ||
@@ -937,3 +991,3 @@ interface ModelInvocationOutputMember { | ||
| * @public | ||
| * Trace Part which contains information if preprocessing was successful | ||
| * <p>Details about the response from the Lambda parsing of the output from the pre-processing step.</p> | ||
| */ | ||
@@ -943,3 +997,3 @@ export interface PreProcessingParsedResponse { | ||
| * @public | ||
| * Agent Trace Rationale String | ||
| * <p>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.</p> | ||
| */ | ||
@@ -949,3 +1003,3 @@ rationale?: string; | ||
| * @public | ||
| * Boolean value | ||
| * <p>Whether the user input is valid or not. If <code>false</code>, the agent doesn't proceed to orchestration.</p> | ||
| */ | ||
@@ -956,3 +1010,3 @@ isValid?: boolean; | ||
| * @public | ||
| * Trace Part which contains information related to preprocessing | ||
| * <p>The foundation model output from the pre-processing step.</p> | ||
| */ | ||
@@ -962,3 +1016,3 @@ export interface PreProcessingModelInvocationOutput { | ||
| * @public | ||
| * Identifier for trace | ||
| * <p>The unique identifier of the trace.</p> | ||
| */ | ||
@@ -968,3 +1022,3 @@ traceId?: string; | ||
| * @public | ||
| * Trace Part which contains information if preprocessing was successful | ||
| * <p>Details about the response from the Lambda parsing of the output of the pre-processing step.</p> | ||
| */ | ||
@@ -975,3 +1029,3 @@ parsedResponse?: PreProcessingParsedResponse; | ||
| * @public | ||
| * Trace Part which contains information related to preprocessing step | ||
| * <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p> | ||
| */ | ||
@@ -985,3 +1039,14 @@ export type PreProcessingTrace = PreProcessingTrace.ModelInvocationInputMember | PreProcessingTrace.ModelInvocationOutputMember | PreProcessingTrace.$UnknownMember; | ||
| * @public | ||
| * Trace Part which contains information used to call Invoke Model | ||
| * <p>The input for the pre-processing step.</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p>The <code>type</code> is <code>PRE_PROCESSING</code>.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>text</code> contains the prompt.</p> | ||
| * </li> | ||
| * <li> | ||
| * <p>The <code>inferenceConfiguration</code>, <code>parserMode</code>, and <code>overrideLambda</code> values are set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated.</p> | ||
| * </li> | ||
| * </ul> | ||
| */ | ||
@@ -995,3 +1060,3 @@ interface ModelInvocationInputMember { | ||
| * @public | ||
| * Trace Part which contains information related to preprocessing | ||
| * <p>The foundation model output from the pre-processing step.</p> | ||
| */ | ||
@@ -1020,3 +1085,3 @@ interface ModelInvocationOutputMember { | ||
| * @public | ||
| * Trace contains intermidate response for customer | ||
| * <p>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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p> | ||
| */ | ||
@@ -1030,3 +1095,3 @@ export type Trace = Trace.FailureTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.$UnknownMember; | ||
| * @public | ||
| * Trace Part which contains information related to preprocessing step | ||
| * <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p> | ||
| */ | ||
@@ -1042,3 +1107,3 @@ interface PreProcessingTraceMember { | ||
| * @public | ||
| * Trace contains intermidate response during orchestration | ||
| * <p>Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.</p> | ||
| */ | ||
@@ -1054,3 +1119,3 @@ interface OrchestrationTraceMember { | ||
| * @public | ||
| * Trace Part which contains information related to post processing step | ||
| * <p>Details about the post-processing step, in which the agent shapes the response..</p> | ||
| */ | ||
@@ -1066,3 +1131,3 @@ interface PostProcessingTraceMember { | ||
| * @public | ||
| * Trace Part which is emitted when agent trace could not be generated | ||
| * <p>Contains information about the failure of the interaction.</p> | ||
| */ | ||
@@ -1097,3 +1162,3 @@ interface FailureTraceMember { | ||
| * @public | ||
| * Trace Part which contains intermidate response for customer | ||
| * <p>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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p> | ||
| */ | ||
@@ -1103,3 +1168,3 @@ export interface TracePart { | ||
| * @public | ||
| * Identifier of the agent. | ||
| * <p>The unique identifier of the agent.</p> | ||
| */ | ||
@@ -1109,3 +1174,3 @@ agentId?: string; | ||
| * @public | ||
| * Identifier of the agent alias. | ||
| * <p>The unique identifier of the alias of the agent.</p> | ||
| */ | ||
@@ -1115,3 +1180,3 @@ agentAliasId?: string; | ||
| * @public | ||
| * Identifier of the session. | ||
| * <p>The unique identifier of the session with the agent.</p> | ||
| */ | ||
@@ -1121,3 +1186,3 @@ sessionId?: string; | ||
| * @public | ||
| * Trace contains intermidate response for customer | ||
| * <p>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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p> | ||
| */ | ||
@@ -1128,3 +1193,3 @@ trace?: Trace; | ||
| * @public | ||
| * This exception is thrown when the request's input validation fails | ||
| * <p>Input validation failed. Check your request parameters and retry the request.</p> | ||
| */ | ||
@@ -1141,3 +1206,3 @@ export declare class ValidationException extends __BaseException { | ||
| * @public | ||
| * Response body of is a stream | ||
| * <p>The response from invoking the agent and associated citations and trace information.</p> | ||
| */ | ||
@@ -1151,3 +1216,3 @@ export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.BadGatewayExceptionMember | ResponseStream.ChunkMember | ResponseStream.ConflictExceptionMember | ResponseStream.DependencyFailedExceptionMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ServiceQuotaExceededExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember; | ||
| * @public | ||
| * Base 64 endoded byte response | ||
| * <p>Contains a part of an agent response and citations for it.</p> | ||
| */ | ||
@@ -1170,3 +1235,3 @@ interface ChunkMember { | ||
| * @public | ||
| * Trace Part which contains intermidate response for customer | ||
| * <p>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 <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Trace events</a>.</p> | ||
| */ | ||
@@ -1189,3 +1254,3 @@ interface TraceMember { | ||
| * @public | ||
| * This exception is thrown if there was an unexpected error during processing of request | ||
| * <p>An internal server error occurred. Retry your request.</p> | ||
| */ | ||
@@ -1208,3 +1273,3 @@ interface InternalServerExceptionMember { | ||
| * @public | ||
| * This exception is thrown when the request's input validation fails | ||
| * <p>Input validation failed. Check your request parameters and retry the request.</p> | ||
| */ | ||
@@ -1227,3 +1292,3 @@ interface ValidationExceptionMember { | ||
| * @public | ||
| * This exception is thrown when a resource referenced by the operation does not exist | ||
| * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p> | ||
| */ | ||
@@ -1246,3 +1311,3 @@ interface ResourceNotFoundExceptionMember { | ||
| * @public | ||
| * This exception is thrown when a request is made beyond the service quota | ||
| * <p>The number of requests exceeds the service quota. Resubmit your request later.</p> | ||
| */ | ||
@@ -1265,3 +1330,3 @@ interface ServiceQuotaExceededExceptionMember { | ||
| * @public | ||
| * This exception is thrown when the number of requests exceeds the limit | ||
| * <p>The number of requests exceeds the limit. Resubmit your request later.</p> | ||
| */ | ||
@@ -1284,3 +1349,3 @@ interface ThrottlingExceptionMember { | ||
| * @public | ||
| * This exception is thrown when a request is denied per access permissions | ||
| * <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p> | ||
| */ | ||
@@ -1303,3 +1368,3 @@ interface AccessDeniedExceptionMember { | ||
| * @public | ||
| * This exception is thrown when there is a conflict performing an operation | ||
| * <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p> | ||
| */ | ||
@@ -1322,3 +1387,3 @@ interface ConflictExceptionMember { | ||
| * @public | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration) | ||
| * <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p> | ||
| */ | ||
@@ -1341,3 +1406,3 @@ interface DependencyFailedExceptionMember { | ||
| * @public | ||
| * This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource | ||
| * <p>There was an issue with a dependency due to a server issue. Retry your request.</p> | ||
| */ | ||
@@ -1393,3 +1458,2 @@ interface BadGatewayExceptionMember { | ||
| * @public | ||
| * InvokeAgent Response | ||
| */ | ||
@@ -1399,3 +1463,3 @@ export interface InvokeAgentResponse { | ||
| * @public | ||
| * Inference response from the model in the format specified in the Content-Type response header. | ||
| * <p>The agent's response to the user prompt.</p> | ||
| */ | ||
@@ -1405,3 +1469,3 @@ completion: AsyncIterable<ResponseStream> | undefined; | ||
| * @public | ||
| * streaming response mimetype of the model | ||
| * <p>The MIME type of the input data in the request. The default value is <code>application/json</code>.</p> | ||
| */ | ||
@@ -1411,3 +1475,3 @@ contentType: string | undefined; | ||
| * @public | ||
| * streaming response mimetype of the model | ||
| * <p>The unique identifier of the session with the agent.</p> | ||
| */ | ||
@@ -1418,3 +1482,3 @@ sessionId: string | undefined; | ||
| * @public | ||
| * Customer input of the turn | ||
| * <p>Contains the query made to the knowledge base.</p> | ||
| */ | ||
@@ -1424,3 +1488,3 @@ export interface RetrieveAndGenerateInput { | ||
| * @public | ||
| * Customer input of the turn in text | ||
| * <p>The query made to the knowledge base.</p> | ||
| */ | ||
@@ -1443,3 +1507,3 @@ text: string | undefined; | ||
| * @public | ||
| * Knowledge base vector search configuration | ||
| * <p>Configurations for how to carry out the search.</p> | ||
| */ | ||
@@ -1449,3 +1513,6 @@ export interface KnowledgeBaseVectorSearchConfiguration { | ||
| * @public | ||
| * Top-K results to retrieve from knowledge base. | ||
| * <p>The number of results to return.</p> | ||
| * <note> | ||
| * <p>The <code>numberOfResults</code> field is currently unsupported for <code>RetrieveAndGenerate</code>. Don't include it in this field if you are sending a <code>RetrieveAndGenerate</code> request.</p> | ||
| * </note> | ||
| */ | ||
@@ -1455,3 +1522,3 @@ numberOfResults?: number; | ||
| * @public | ||
| * Override the type of query to be performed on data store | ||
| * <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</p> | ||
| */ | ||
@@ -1462,3 +1529,16 @@ overrideSearchType?: SearchType; | ||
| * @public | ||
| * Search parameters for retrieving from knowledge base. | ||
| * <p>Contains details about how the results should be returned.</p> | ||
| * <p>This data type is used in the following API operations:</p> | ||
| * <ul> | ||
| * <li> | ||
| * <p> | ||
| * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request body</a> | ||
| * </p> | ||
| * </li> | ||
| * <li> | ||
| * <p> | ||
| * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request body</a> | ||
| * </p> | ||
| * </li> | ||
| * </ul> | ||
| */ | ||
@@ -1468,3 +1548,3 @@ export interface KnowledgeBaseRetrievalConfiguration { | ||
| * @public | ||
| * Knowledge base vector search configuration | ||
| * <p>Contains details about how the results from the vector search should be returned.</p> | ||
| */ | ||
@@ -1475,3 +1555,3 @@ vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined; | ||
| * @public | ||
| * Configurations for retrieval and generation for knowledge base. | ||
| * <p>Contains details about the resource being queried.</p> | ||
| */ | ||
@@ -1481,3 +1561,3 @@ export interface KnowledgeBaseRetrieveAndGenerateConfiguration { | ||
| * @public | ||
| * Identifier of the KnowledgeBase | ||
| * <p>The unique identifier of the knowledge base that is queried and the foundation model used for generation.</p> | ||
| */ | ||
@@ -1487,3 +1567,3 @@ knowledgeBaseId: string | undefined; | ||
| * @public | ||
| * Arn of a Bedrock model. | ||
| * <p>The ARN of the foundation model used to generate a response.</p> | ||
| */ | ||
@@ -1493,3 +1573,3 @@ modelArn: string | undefined; | ||
| * @public | ||
| * Search parameters for retrieving from knowledge base. | ||
| * <p>Contains configurations for how to retrieve and return the knowledge base query.</p> | ||
| */ | ||
@@ -1511,3 +1591,3 @@ retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration; | ||
| * @public | ||
| * Configures the retrieval and generation for the session. | ||
| * <p>Contains details about the resource being queried.</p> | ||
| */ | ||
@@ -1517,3 +1597,3 @@ export interface RetrieveAndGenerateConfiguration { | ||
| * @public | ||
| * The type of RetrieveAndGenerate. | ||
| * <p>The type of resource that is queried by the request.</p> | ||
| */ | ||
@@ -1523,3 +1603,3 @@ type: RetrieveAndGenerateType | undefined; | ||
| * @public | ||
| * Configurations for retrieval and generation for knowledge base. | ||
| * <p>Contains details about the resource being queried.</p> | ||
| */ | ||
@@ -1530,3 +1610,3 @@ knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration; | ||
| * @public | ||
| * Configures common parameters of the session. | ||
| * <p>Contains configuration about the session with the knowledge base.</p> | ||
| */ | ||
@@ -1536,3 +1616,3 @@ export interface RetrieveAndGenerateSessionConfiguration { | ||
| * @public | ||
| * The KMS key arn to encrypt the customer data of the session. | ||
| * <p>The ARN of the KMS key encrypting the session.</p> | ||
| */ | ||
@@ -1547,3 +1627,3 @@ kmsKeyArn: string | undefined; | ||
| * @public | ||
| * Identifier of the session. | ||
| * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p> | ||
| */ | ||
@@ -1553,3 +1633,3 @@ sessionId?: string; | ||
| * @public | ||
| * Customer input of the turn | ||
| * <p>Contains the query made to the knowledge base.</p> | ||
| */ | ||
@@ -1559,3 +1639,3 @@ input: RetrieveAndGenerateInput | undefined; | ||
| * @public | ||
| * Configures the retrieval and generation for the session. | ||
| * <p>Contains details about the resource being queried and the foundation model used for generation.</p> | ||
| */ | ||
@@ -1565,3 +1645,3 @@ retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration; | ||
| * @public | ||
| * Configures common parameters of the session. | ||
| * <p>Contains details about the session with the knowledge base.</p> | ||
| */ | ||
@@ -1572,3 +1652,3 @@ sessionConfiguration?: RetrieveAndGenerateSessionConfiguration; | ||
| * @public | ||
| * Service response of the turn | ||
| * <p>Contains the response generated from querying the knowledge base.</p> | ||
| */ | ||
@@ -1578,3 +1658,3 @@ export interface RetrieveAndGenerateOutput { | ||
| * @public | ||
| * Service response of the turn in text | ||
| * <p>The response generated from querying the knowledge base.</p> | ||
| */ | ||
@@ -1589,3 +1669,3 @@ text: string | undefined; | ||
| * @public | ||
| * Identifier of the session. | ||
| * <p>The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base.</p> | ||
| */ | ||
@@ -1595,3 +1675,3 @@ sessionId: string | undefined; | ||
| * @public | ||
| * Service response of the turn | ||
| * <p>Contains the response generated from querying the knowledge base.</p> | ||
| */ | ||
@@ -1601,3 +1681,3 @@ output: RetrieveAndGenerateOutput | undefined; | ||
| * @public | ||
| * List of citations | ||
| * <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p> | ||
| */ | ||
@@ -1608,3 +1688,3 @@ citations?: Citation[]; | ||
| * @public | ||
| * Knowledge base input query. | ||
| * <p>Contains the query made to the knowledge base.</p> | ||
| */ | ||
@@ -1614,3 +1694,3 @@ export interface KnowledgeBaseQuery { | ||
| * @public | ||
| * Knowledge base input query in text | ||
| * <p>The text of the query made to the knowledge base.</p> | ||
| */ | ||
@@ -1625,3 +1705,3 @@ text: string | undefined; | ||
| * @public | ||
| * Identifier of the KnowledgeBase | ||
| * <p>The unique identifier of the knowledge base to query.</p> | ||
| */ | ||
@@ -1631,3 +1711,3 @@ knowledgeBaseId: string | undefined; | ||
| * @public | ||
| * Knowledge base input query. | ||
| * <p>The query to send the knowledge base.</p> | ||
| */ | ||
@@ -1637,3 +1717,3 @@ retrievalQuery: KnowledgeBaseQuery | undefined; | ||
| * @public | ||
| * Search parameters for retrieving from knowledge base. | ||
| * <p>Contains details about how the results should be returned.</p> | ||
| */ | ||
@@ -1643,3 +1723,3 @@ retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration; | ||
| * @public | ||
| * Opaque continuation token of previous paginated response. | ||
| * <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p> | ||
| */ | ||
@@ -1650,3 +1730,3 @@ nextToken?: string; | ||
| * @public | ||
| * Result item returned from a knowledge base retrieval. | ||
| * <p>Details about a result from querying the knowledge base.</p> | ||
| */ | ||
@@ -1656,3 +1736,3 @@ export interface KnowledgeBaseRetrievalResult { | ||
| * @public | ||
| * Content of a retrieval result. | ||
| * <p>Contains a chunk of text from a data source in the knowledge base.</p> | ||
| */ | ||
@@ -1662,3 +1742,3 @@ content: RetrievalResultContent | undefined; | ||
| * @public | ||
| * The source location of a retrieval result. | ||
| * <p>Contains information about the location of the data source.</p> | ||
| */ | ||
@@ -1668,3 +1748,3 @@ location?: RetrievalResultLocation; | ||
| * @public | ||
| * The relevance score of a result. | ||
| * <p>The level of relevance of the result to the query.</p> | ||
| */ | ||
@@ -1679,3 +1759,3 @@ score?: number; | ||
| * @public | ||
| * List of knowledge base retrieval results | ||
| * <p>A list of results from querying the knowledge base.</p> | ||
| */ | ||
@@ -1685,3 +1765,3 @@ retrievalResults: KnowledgeBaseRetrievalResult[] | undefined; | ||
| * @public | ||
| * Opaque continuation token of previous paginated response. | ||
| * <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p> | ||
| */ | ||
@@ -1688,0 +1768,0 @@ nextToken?: string; |
| { | ||
| "name": "@aws-sdk/client-bedrock-agent-runtime", | ||
| "description": "AWS SDK for JavaScript Bedrock Agent Runtime Client for Node.js, Browser and React Native", | ||
| "version": "3.529.1", | ||
| "version": "3.530.0", | ||
| "scripts": { | ||
@@ -6,0 +6,0 @@ "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", |
@@ -9,3 +9,3 @@ <!-- generated file, do not edit directly --> | ||
| Amazon Bedrock Agent | ||
| <p>Contains APIs related to model invocation and querying of knowledge bases.</p> | ||
@@ -12,0 +12,0 @@ ## Installing |
Improved metrics
- Total package byte prevSize
- increased by5.7%
332182
- Lines of code
- increased by1.77%
7571