feat(client-bedrock-agent-runtime): This release introduces a new Rer…

…ank API to leverage reranking models (with integration into Knowledge Bases); APIs to upload documents directly into Knowledge Base; RetrieveAndGenerateStream API for streaming response; Guardrails on Retrieve API; and ability to automatically generate filters
aws · Dec 2, 2024 · 4ed232e · 4ed232e
1 parent ac2bf51
commit 4ed232e
Show file tree

Hide file tree

Showing 15 changed files with 3,398 additions and 87 deletions.
diff --git a/clients/client-bedrock-agent-runtime/README.md b/clients/client-bedrock-agent-runtime/README.md
@@ -250,6 +250,14 @@ OptimizePrompt
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/OptimizePromptCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/OptimizePromptCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/OptimizePromptCommandOutput/)
 
+</details>
+<details>
+<summary>
+Rerank
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/RerankCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RerankCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RerankCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -267,3 +275,11 @@ RetrieveAndGenerate
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/RetrieveAndGenerateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RetrieveAndGenerateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RetrieveAndGenerateCommandOutput/)
 
 </details>
+<details>
+<summary>
+RetrieveAndGenerateStream
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/RetrieveAndGenerateStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RetrieveAndGenerateStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RetrieveAndGenerateStreamCommandOutput/)
+
+</details>
diff --git a/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntime.ts b/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntime.ts
@@ -25,11 +25,17 @@ import {
   OptimizePromptCommandInput,
   OptimizePromptCommandOutput,
 } from "./commands/OptimizePromptCommand";
+import { RerankCommand, RerankCommandInput, RerankCommandOutput } from "./commands/RerankCommand";
 import {
   RetrieveAndGenerateCommand,
   RetrieveAndGenerateCommandInput,
   RetrieveAndGenerateCommandOutput,
 } from "./commands/RetrieveAndGenerateCommand";
+import {
+  RetrieveAndGenerateStreamCommand,
+  RetrieveAndGenerateStreamCommandInput,
+  RetrieveAndGenerateStreamCommandOutput,
+} from "./commands/RetrieveAndGenerateStreamCommand";
 import { RetrieveCommand, RetrieveCommandInput, RetrieveCommandOutput } from "./commands/RetrieveCommand";
 
 const commands = {
@@ -39,8 +45,10 @@ const commands = {
   InvokeFlowCommand,
   InvokeInlineAgentCommand,
   OptimizePromptCommand,
+  RerankCommand,
   RetrieveCommand,
   RetrieveAndGenerateCommand,
+  RetrieveAndGenerateStreamCommand,
 };
 
 export interface BedrockAgentRuntime {
@@ -128,6 +136,17 @@ export interface BedrockAgentRuntime {
     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}
    */
@@ -155,6 +174,23 @@ export interface BedrockAgentRuntime {
     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;
 }
 
 /**

diff --git a/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntimeClient.ts b/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntimeClient.ts
@@ -65,10 +65,15 @@ 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,
@@ -91,7 +96,9 @@ export type ServiceInputTypes =
   | InvokeFlowCommandInput
   | InvokeInlineAgentCommandInput
   | OptimizePromptCommandInput
+  | RerankCommandInput
   | RetrieveAndGenerateCommandInput
+  | RetrieveAndGenerateStreamCommandInput
   | RetrieveCommandInput;
 
 /**
@@ -104,7 +111,9 @@ export type ServiceOutputTypes =
   | InvokeFlowCommandOutput
   | InvokeInlineAgentCommandOutput
   | OptimizePromptCommandOutput
+  | RerankCommandOutput
   | RetrieveAndGenerateCommandOutput
+  | RetrieveAndGenerateStreamCommandOutput
   | RetrieveCommandOutput;
 
 /**

diff --git a/clients/client-bedrock-agent-runtime/src/commands/InvokeAgentCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/InvokeAgentCommand.ts
@@ -188,6 +188,43 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
  *                 "<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
+ *             },
  *           },
  *         },
  *       },
@@ -229,7 +266,7 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
  * //                   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",
  * //                   },
@@ -245,6 +282,9 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
  * //                   sharePointLocation: { // RetrievalResultSharePointLocation
  * //                     url: "STRING_VALUE",
  * //                   },
+ * //                   customDocumentLocation: { // RetrievalResultCustomDocumentLocation
+ * //                     id: "STRING_VALUE",
+ * //                   },
  * //                 },
  * //                 metadata: { // RetrievalResultMetadata
  * //                   "<keys>": "DOCUMENT_VALUE",
@@ -463,7 +503,7 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
  * //                     text: "STRING_VALUE", // required
  * //                   },
  * //                   location: {
- * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //                     s3Location: {
  * //                       uri: "STRING_VALUE",
  * //                     },
@@ -479,6 +519,9 @@ export interface InvokeAgentCommandOutput extends InvokeAgentResponse, __Metadat
  * //                     sharePointLocation: {
  * //                       url: "STRING_VALUE",
  * //                     },
+ * //                     customDocumentLocation: {
+ * //                       id: "STRING_VALUE",
+ * //                     },
  * //                   },
  * //                   metadata: {
  * //                     "<keys>": "DOCUMENT_VALUE",

diff --git a/clients/client-bedrock-agent-runtime/src/commands/InvokeInlineAgentCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/InvokeInlineAgentCommand.ts
@@ -225,6 +225,43 @@ export interface InvokeInlineAgentCommandOutput extends InvokeInlineAgentRespons
  *               "<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
+ *           },
  *         },
  *       },
  *     },
@@ -279,7 +316,7 @@ export interface InvokeInlineAgentCommandOutput extends InvokeInlineAgentRespons
  * //                   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",
  * //                   },
@@ -295,6 +332,9 @@ export interface InvokeInlineAgentCommandOutput extends InvokeInlineAgentRespons
  * //                   sharePointLocation: { // RetrievalResultSharePointLocation
  * //                     url: "STRING_VALUE",
  * //                   },
+ * //                   customDocumentLocation: { // RetrievalResultCustomDocumentLocation
+ * //                     id: "STRING_VALUE",
+ * //                   },
  * //                 },
  * //                 metadata: { // RetrievalResultMetadata
  * //                   "<keys>": "DOCUMENT_VALUE",
@@ -513,7 +553,7 @@ export interface InvokeInlineAgentCommandOutput extends InvokeInlineAgentRespons
  * //                     text: "STRING_VALUE", // required
  * //                   },
  * //                   location: {
- * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //                     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //                     s3Location: {
  * //                       uri: "STRING_VALUE",
  * //                     },
@@ -529,6 +569,9 @@ export interface InvokeInlineAgentCommandOutput extends InvokeInlineAgentRespons
  * //                     sharePointLocation: {
  * //                       url: "STRING_VALUE",
  * //                     },
+ * //                     customDocumentLocation: {
+ * //                       id: "STRING_VALUE",
+ * //                     },
  * //                   },
  * //                   metadata: {
  * //                     "<keys>": "DOCUMENT_VALUE",