@aws-sdk/client-bedrock-agent-runtime 3.701.0 → 3.703.0

package/dist-types/BedrockAgentRuntime.d.ts

@@ -6,7 +6,9 @@ import { InvokeAgentCommandInput, InvokeAgentCommandOutput } from "./commands/In
 import { InvokeFlowCommandInput, InvokeFlowCommandOutput } from "./commands/InvokeFlowCommand";
 import { InvokeInlineAgentCommandInput, InvokeInlineAgentCommandOutput } from "./commands/InvokeInlineAgentCommand";
 import { OptimizePromptCommandInput, OptimizePromptCommandOutput } from "./commands/OptimizePromptCommand";
+import { RerankCommandInput, RerankCommandOutput } from "./commands/RerankCommand";
 import { RetrieveAndGenerateCommandInput, RetrieveAndGenerateCommandOutput } from "./commands/RetrieveAndGenerateCommand";
+import { RetrieveAndGenerateStreamCommandInput, RetrieveAndGenerateStreamCommandOutput } from "./commands/RetrieveAndGenerateStreamCommand";
 import { RetrieveCommandInput, RetrieveCommandOutput } from "./commands/RetrieveCommand";
 export interface BedrockAgentRuntime {
     /**
@@ -45,6 +47,12 @@ export interface BedrockAgentRuntime {
     optimizePrompt(args: OptimizePromptCommandInput, options?: __HttpHandlerOptions): Promise<OptimizePromptCommandOutput>;
     optimizePrompt(args: OptimizePromptCommandInput, cb: (err: any, data?: OptimizePromptCommandOutput) => void): void;
     optimizePrompt(args: OptimizePromptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: OptimizePromptCommandOutput) => void): void;
+    /**
+     * @see {@link RerankCommand}
+     */
+    rerank(args: RerankCommandInput, options?: __HttpHandlerOptions): Promise<RerankCommandOutput>;
+    rerank(args: RerankCommandInput, cb: (err: any, data?: RerankCommandOutput) => void): void;
+    rerank(args: RerankCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RerankCommandOutput) => void): void;
     /**
      * @see {@link RetrieveCommand}
      */
@@ -57,6 +65,12 @@ export interface BedrockAgentRuntime {
     retrieveAndGenerate(args: RetrieveAndGenerateCommandInput, options?: __HttpHandlerOptions): Promise<RetrieveAndGenerateCommandOutput>;
     retrieveAndGenerate(args: RetrieveAndGenerateCommandInput, cb: (err: any, data?: RetrieveAndGenerateCommandOutput) => void): void;
     retrieveAndGenerate(args: RetrieveAndGenerateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveAndGenerateCommandOutput) => void): void;
+    /**
+     * @see {@link RetrieveAndGenerateStreamCommand}
+     */
+    retrieveAndGenerateStream(args: RetrieveAndGenerateStreamCommandInput, options?: __HttpHandlerOptions): Promise<RetrieveAndGenerateStreamCommandOutput>;
+    retrieveAndGenerateStream(args: RetrieveAndGenerateStreamCommandInput, cb: (err: any, data?: RetrieveAndGenerateStreamCommandOutput) => void): void;
+    retrieveAndGenerateStream(args: RetrieveAndGenerateStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetrieveAndGenerateStreamCommandOutput) => void): void;
 }
 /**
  * <p>Contains APIs related to model invocation and querying of knowledge bases.</p>

package/dist-types/BedrockAgentRuntimeClient.d.ts

@@ -14,7 +14,9 @@ import { InvokeAgentCommandInput, InvokeAgentCommandOutput } from "./commands/In
 import { InvokeFlowCommandInput, InvokeFlowCommandOutput } from "./commands/InvokeFlowCommand";
 import { InvokeInlineAgentCommandInput, InvokeInlineAgentCommandOutput } from "./commands/InvokeInlineAgentCommand";
 import { OptimizePromptCommandInput, OptimizePromptCommandOutput } from "./commands/OptimizePromptCommand";
+import { RerankCommandInput, RerankCommandOutput } from "./commands/RerankCommand";
 import { RetrieveAndGenerateCommandInput, RetrieveAndGenerateCommandOutput } from "./commands/RetrieveAndGenerateCommand";
+import { RetrieveAndGenerateStreamCommandInput, RetrieveAndGenerateStreamCommandOutput } from "./commands/RetrieveAndGenerateStreamCommand";
 import { RetrieveCommandInput, RetrieveCommandOutput } from "./commands/RetrieveCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
 import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -22,11 +24,11 @@ export { __Client };
 /**
  * @public
  */
-export type ServiceInputTypes = DeleteAgentMemoryCommandInput | GetAgentMemoryCommandInput | InvokeAgentCommandInput | InvokeFlowCommandInput | InvokeInlineAgentCommandInput | OptimizePromptCommandInput | RetrieveAndGenerateCommandInput | RetrieveCommandInput;
+export type ServiceInputTypes = DeleteAgentMemoryCommandInput | GetAgentMemoryCommandInput | InvokeAgentCommandInput | InvokeFlowCommandInput | InvokeInlineAgentCommandInput | OptimizePromptCommandInput | RerankCommandInput | RetrieveAndGenerateCommandInput | RetrieveAndGenerateStreamCommandInput | RetrieveCommandInput;
 /**
  * @public
  */
-export type ServiceOutputTypes = DeleteAgentMemoryCommandOutput | GetAgentMemoryCommandOutput | InvokeAgentCommandOutput | InvokeFlowCommandOutput | InvokeInlineAgentCommandOutput | OptimizePromptCommandOutput | RetrieveAndGenerateCommandOutput | RetrieveCommandOutput;
+export type ServiceOutputTypes = DeleteAgentMemoryCommandOutput | GetAgentMemoryCommandOutput | InvokeAgentCommandOutput | InvokeFlowCommandOutput | InvokeInlineAgentCommandOutput | OptimizePromptCommandOutput | RerankCommandOutput | RetrieveAndGenerateCommandOutput | RetrieveAndGenerateStreamCommandOutput | RetrieveCommandOutput;
 /**
  * @public
  */

package/dist-types/commands/InvokeAgentCommand.d.ts

@@ -178,6 +178,43 @@ declare const InvokeAgentCommand_base: {
  *                 "<RetrievalFilter>",
  *               ],
  *             },
+ *             rerankingConfiguration: { // VectorSearchRerankingConfiguration
+ *               type: "BEDROCK_RERANKING_MODEL", // required
+ *               bedrockRerankingConfiguration: { // VectorSearchBedrockRerankingConfiguration
+ *                 modelConfiguration: { // VectorSearchBedrockRerankingModelConfiguration
+ *                   modelArn: "STRING_VALUE", // required
+ *                   additionalModelRequestFields: { // AdditionalModelRequestFields
+ *                     "<keys>": "DOCUMENT_VALUE",
+ *                   },
+ *                 },
+ *                 numberOfRerankedResults: Number("int"),
+ *                 metadataConfiguration: { // MetadataConfigurationForReranking
+ *                   selectionMode: "SELECTIVE" || "ALL", // required
+ *                   selectiveModeConfiguration: { // RerankingMetadataSelectiveModeConfiguration Union: only one key present
+ *                     fieldsToInclude: [ // FieldsForReranking
+ *                       { // FieldForReranking
+ *                         fieldName: "STRING_VALUE", // required
+ *                       },
+ *                     ],
+ *                     fieldsToExclude: [
+ *                       {
+ *                         fieldName: "STRING_VALUE", // required
+ *                       },
+ *                     ],
+ *                   },
+ *                 },
+ *               },
+ *             },
+ *             implicitFilterConfiguration: { // ImplicitFilterConfiguration
+ *               metadataAttributes: [ // MetadataAttributeSchemaList // required
+ *                 { // MetadataAttributeSchema
+ *                   key: "STRING_VALUE", // required
+ *                   type: "STRING" || "NUMBER" || "BOOLEAN" || "STRING_LIST", // required
+ *                   description: "STRING_VALUE", // required
+ *                 },
+ *               ],
+ *               modelArn: "STRING_VALUE", // required
+ *             },
  *           },
  *         },
  *       },
@@ -219,7 +256,7 @@ declare const InvokeAgentCommand_base: {
  * //                   text: "STRING_VALUE", // required
  * //                 },
  * //                 location: { // RetrievalResultLocation
- * //                   type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //                   type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //                   s3Location: { // RetrievalResultS3Location
  * //                     uri: "STRING_VALUE",
  * //                   },
@@ -235,6 +272,9 @@ declare const InvokeAgentCommand_base: {
  * //                   sharePointLocation: { // RetrievalResultSharePointLocation
  * //                     url: "STRING_VALUE",
  * //                   },
+ * //                   customDocumentLocation: { // RetrievalResultCustomDocumentLocation
+ * //                     id: "STRING_VALUE",
+ * //                   },
  * //                 },
  * //                 metadata: { // RetrievalResultMetadata
  * //                   "<keys>": "DOCUMENT_VALUE",
@@ -453,7 +493,7 @@ declare const InvokeAgentCommand_base: {
  * //                     text: "STRING_VALUE", // required
  * //                   },
  * //                   location: {
- * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //                     s3Location: {
  * //                       uri: "STRING_VALUE",
  * //                     },
@@ -469,6 +509,9 @@ declare const InvokeAgentCommand_base: {
  * //                     sharePointLocation: {
  * //                       url: "STRING_VALUE",
  * //                     },
+ * //                     customDocumentLocation: {
+ * //                       id: "STRING_VALUE",
+ * //                     },
  * //                   },
  * //                   metadata: {
  * //                     "<keys>": "DOCUMENT_VALUE",

package/dist-types/commands/InvokeInlineAgentCommand.d.ts

@@ -215,6 +215,43 @@ declare const InvokeInlineAgentCommand_base: {
  *               "<RetrievalFilter>",
  *             ],
  *           },
+ *           rerankingConfiguration: { // VectorSearchRerankingConfiguration
+ *             type: "BEDROCK_RERANKING_MODEL", // required
+ *             bedrockRerankingConfiguration: { // VectorSearchBedrockRerankingConfiguration
+ *               modelConfiguration: { // VectorSearchBedrockRerankingModelConfiguration
+ *                 modelArn: "STRING_VALUE", // required
+ *                 additionalModelRequestFields: { // AdditionalModelRequestFields
+ *                   "<keys>": "DOCUMENT_VALUE",
+ *                 },
+ *               },
+ *               numberOfRerankedResults: Number("int"),
+ *               metadataConfiguration: { // MetadataConfigurationForReranking
+ *                 selectionMode: "SELECTIVE" || "ALL", // required
+ *                 selectiveModeConfiguration: { // RerankingMetadataSelectiveModeConfiguration Union: only one key present
+ *                   fieldsToInclude: [ // FieldsForReranking
+ *                     { // FieldForReranking
+ *                       fieldName: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                   fieldsToExclude: [
+ *                     {
+ *                       fieldName: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                 },
+ *               },
+ *             },
+ *           },
+ *           implicitFilterConfiguration: { // ImplicitFilterConfiguration
+ *             metadataAttributes: [ // MetadataAttributeSchemaList // required
+ *               { // MetadataAttributeSchema
+ *                 key: "STRING_VALUE", // required
+ *                 type: "STRING" || "NUMBER" || "BOOLEAN" || "STRING_LIST", // required
+ *                 description: "STRING_VALUE", // required
+ *               },
+ *             ],
+ *             modelArn: "STRING_VALUE", // required
+ *           },
  *         },
  *       },
  *     },
@@ -269,7 +306,7 @@ declare const InvokeInlineAgentCommand_base: {
  * //                   text: "STRING_VALUE", // required
  * //                 },
  * //                 location: { // RetrievalResultLocation
- * //                   type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //                   type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //                   s3Location: { // RetrievalResultS3Location
  * //                     uri: "STRING_VALUE",
  * //                   },
@@ -285,6 +322,9 @@ declare const InvokeInlineAgentCommand_base: {
  * //                   sharePointLocation: { // RetrievalResultSharePointLocation
  * //                     url: "STRING_VALUE",
  * //                   },
+ * //                   customDocumentLocation: { // RetrievalResultCustomDocumentLocation
+ * //                     id: "STRING_VALUE",
+ * //                   },
  * //                 },
  * //                 metadata: { // RetrievalResultMetadata
  * //                   "<keys>": "DOCUMENT_VALUE",
@@ -503,7 +543,7 @@ declare const InvokeInlineAgentCommand_base: {
  * //                     text: "STRING_VALUE", // required
  * //                   },
  * //                   location: {
- * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //                     s3Location: {
  * //                       uri: "STRING_VALUE",
  * //                     },
@@ -519,6 +559,9 @@ declare const InvokeInlineAgentCommand_base: {
  * //                     sharePointLocation: {
  * //                       url: "STRING_VALUE",
  * //                     },
+ * //                     customDocumentLocation: {
+ * //                       id: "STRING_VALUE",
+ * //                     },
  * //                   },
  * //                   metadata: {
  * //                     "<keys>": "DOCUMENT_VALUE",

package/dist-types/commands/RerankCommand.d.ts

@@ -0,0 +1,143 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { RerankRequest, RerankResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RerankCommand}.
+ */
+export interface RerankCommandInput extends RerankRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RerankCommand}.
+ */
+export interface RerankCommandOutput extends RerankResponse, __MetadataBearer {
+}
+declare const RerankCommand_base: {
+    new (input: RerankCommandInput): import("@smithy/smithy-client").CommandImpl<RerankCommandInput, RerankCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: RerankCommandInput): import("@smithy/smithy-client").CommandImpl<RerankCommandInput, RerankCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Reranks the relevance of sources based on queries. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html">Improve the relevance of query responses with a reranker model</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, RerankCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, RerankCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // RerankRequest
+ *   queries: [ // RerankQueriesList // required
+ *     { // RerankQuery
+ *       type: "TEXT", // required
+ *       textQuery: { // RerankTextDocument
+ *         text: "STRING_VALUE",
+ *       },
+ *     },
+ *   ],
+ *   sources: [ // RerankSourcesList // required
+ *     { // RerankSource
+ *       type: "INLINE", // required
+ *       inlineDocumentSource: { // RerankDocument
+ *         type: "TEXT" || "JSON", // required
+ *         textDocument: {
+ *           text: "STRING_VALUE",
+ *         },
+ *         jsonDocument: "DOCUMENT_VALUE",
+ *       },
+ *     },
+ *   ],
+ *   rerankingConfiguration: { // RerankingConfiguration
+ *     type: "BEDROCK_RERANKING_MODEL", // required
+ *     bedrockRerankingConfiguration: { // BedrockRerankingConfiguration
+ *       numberOfResults: Number("int"),
+ *       modelConfiguration: { // BedrockRerankingModelConfiguration
+ *         modelArn: "STRING_VALUE", // required
+ *         additionalModelRequestFields: { // AdditionalModelRequestFields
+ *           "<keys>": "DOCUMENT_VALUE",
+ *         },
+ *       },
+ *     },
+ *   },
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new RerankCommand(input);
+ * const response = await client.send(command);
+ * // { // RerankResponse
+ * //   results: [ // RerankResultsList // required
+ * //     { // RerankResult
+ * //       index: Number("int"), // required
+ * //       relevanceScore: Number("float"), // required
+ * //       document: { // RerankDocument
+ * //         type: "TEXT" || "JSON", // required
+ * //         textDocument: { // RerankTextDocument
+ * //           text: "STRING_VALUE",
+ * //         },
+ * //         jsonDocument: "DOCUMENT_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param RerankCommandInput - {@link RerankCommandInput}
+ * @returns {@link RerankCommandOutput}
+ * @see {@link RerankCommandInput} for command's `input` shape.
+ * @see {@link RerankCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
+ *
+ * @throws {@link BadGatewayException} (server fault)
+ *  <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
+ *
+ * @throws {@link DependencyFailedException} (client fault)
+ *  <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockAgentRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgentRuntime service.</p>
+ *
+ * @public
+ */
+export declare class RerankCommand extends RerankCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RerankRequest;
+            output: RerankResponse;
+        };
+        sdk: {
+            input: RerankCommandInput;
+            output: RerankCommandOutput;
+        };
+    };
+}

package/dist-types/commands/RetrieveAndGenerateCommand.d.ts

@@ -100,6 +100,43 @@ declare const RetrieveAndGenerateCommand_base: {
  *               "<RetrievalFilter>",
  *             ],
  *           },
+ *           rerankingConfiguration: { // VectorSearchRerankingConfiguration
+ *             type: "BEDROCK_RERANKING_MODEL", // required
+ *             bedrockRerankingConfiguration: { // VectorSearchBedrockRerankingConfiguration
+ *               modelConfiguration: { // VectorSearchBedrockRerankingModelConfiguration
+ *                 modelArn: "STRING_VALUE", // required
+ *                 additionalModelRequestFields: { // AdditionalModelRequestFields
+ *                   "<keys>": "DOCUMENT_VALUE",
+ *                 },
+ *               },
+ *               numberOfRerankedResults: Number("int"),
+ *               metadataConfiguration: { // MetadataConfigurationForReranking
+ *                 selectionMode: "SELECTIVE" || "ALL", // required
+ *                 selectiveModeConfiguration: { // RerankingMetadataSelectiveModeConfiguration Union: only one key present
+ *                   fieldsToInclude: [ // FieldsForReranking
+ *                     { // FieldForReranking
+ *                       fieldName: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                   fieldsToExclude: [
+ *                     {
+ *                       fieldName: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                 },
+ *               },
+ *             },
+ *           },
+ *           implicitFilterConfiguration: { // ImplicitFilterConfiguration
+ *             metadataAttributes: [ // MetadataAttributeSchemaList // required
+ *               { // MetadataAttributeSchema
+ *                 key: "STRING_VALUE", // required
+ *                 type: "STRING" || "NUMBER" || "BOOLEAN" || "STRING_LIST", // required
+ *                 description: "STRING_VALUE", // required
+ *               },
+ *             ],
+ *             modelArn: "STRING_VALUE", // required
+ *           },
  *         },
  *       },
  *       generationConfiguration: { // GenerationConfiguration
@@ -120,7 +157,7 @@ declare const RetrieveAndGenerateCommand_base: {
  *             ],
  *           },
  *         },
- *         additionalModelRequestFields: { // AdditionalModelRequestFields
+ *         additionalModelRequestFields: {
  *           "<keys>": "DOCUMENT_VALUE",
  *         },
  *       },
@@ -213,7 +250,7 @@ declare const RetrieveAndGenerateCommand_base: {
  * //             text: "STRING_VALUE", // required
  * //           },
  * //           location: { // RetrievalResultLocation
- * //             type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //             type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //             s3Location: { // RetrievalResultS3Location
  * //               uri: "STRING_VALUE",
  * //             },
@@ -229,6 +266,9 @@ declare const RetrieveAndGenerateCommand_base: {
  * //             sharePointLocation: { // RetrievalResultSharePointLocation
  * //               url: "STRING_VALUE",
  * //             },
+ * //             customDocumentLocation: { // RetrievalResultCustomDocumentLocation
+ * //               id: "STRING_VALUE",
+ * //             },
  * //           },
  * //           metadata: { // RetrievalResultMetadata
  * //             "<keys>": "DOCUMENT_VALUE",