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

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",

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

@@ -0,0 +1,371 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
+import { RetrieveAndGenerateStreamRequest, RetrieveAndGenerateStreamResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RetrieveAndGenerateStreamCommand}.
+ */
+export interface RetrieveAndGenerateStreamCommandInput extends RetrieveAndGenerateStreamRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RetrieveAndGenerateStreamCommand}.
+ */
+export interface RetrieveAndGenerateStreamCommandOutput extends RetrieveAndGenerateStreamResponse, __MetadataBearer {
+}
+declare const RetrieveAndGenerateStreamCommand_base: {
+    new (input: RetrieveAndGenerateStreamCommandInput): import("@smithy/smithy-client").CommandImpl<RetrieveAndGenerateStreamCommandInput, RetrieveAndGenerateStreamCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: RetrieveAndGenerateStreamCommandInput): import("@smithy/smithy-client").CommandImpl<RetrieveAndGenerateStreamCommandInput, RetrieveAndGenerateStreamCommandOutput, BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.</p>
+ *          <note>
+ *             <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p>
+ *          </note>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentRuntimeClient, RetrieveAndGenerateStreamCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import
+ * // const { BedrockAgentRuntimeClient, RetrieveAndGenerateStreamCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import
+ * const client = new BedrockAgentRuntimeClient(config);
+ * const input = { // RetrieveAndGenerateStreamRequest
+ *   sessionId: "STRING_VALUE",
+ *   input: { // RetrieveAndGenerateInput
+ *     text: "STRING_VALUE", // required
+ *   },
+ *   retrieveAndGenerateConfiguration: { // RetrieveAndGenerateConfiguration
+ *     type: "KNOWLEDGE_BASE" || "EXTERNAL_SOURCES", // required
+ *     knowledgeBaseConfiguration: { // KnowledgeBaseRetrieveAndGenerateConfiguration
+ *       knowledgeBaseId: "STRING_VALUE", // required
+ *       modelArn: "STRING_VALUE", // required
+ *       retrievalConfiguration: { // KnowledgeBaseRetrievalConfiguration
+ *         vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
+ *           numberOfResults: Number("int"),
+ *           overrideSearchType: "HYBRID" || "SEMANTIC",
+ *           filter: { // RetrievalFilter Union: only one key present
+ *             equals: { // FilterAttribute
+ *               key: "STRING_VALUE", // required
+ *               value: "DOCUMENT_VALUE", // required
+ *             },
+ *             notEquals: {
+ *               key: "STRING_VALUE", // required
+ *               value: "DOCUMENT_VALUE", // required
+ *             },
+ *             greaterThan: {
+ *               key: "STRING_VALUE", // required
+ *               value: "DOCUMENT_VALUE", // required
+ *             },
+ *             greaterThanOrEquals: {
+ *               key: "STRING_VALUE", // required
+ *               value: "DOCUMENT_VALUE", // required
+ *             },
+ *             lessThan: {
+ *               key: "STRING_VALUE", // required
+ *               value: "DOCUMENT_VALUE", // required
+ *             },
+ *             lessThanOrEquals: "<FilterAttribute>",
+ *             in: "<FilterAttribute>",
+ *             notIn: "<FilterAttribute>",
+ *             startsWith: "<FilterAttribute>",
+ *             listContains: "<FilterAttribute>",
+ *             stringContains: "<FilterAttribute>",
+ *             andAll: [ // RetrievalFilterList
+ *               {//  Union: only one key present
+ *                 equals: "<FilterAttribute>",
+ *                 notEquals: "<FilterAttribute>",
+ *                 greaterThan: "<FilterAttribute>",
+ *                 greaterThanOrEquals: "<FilterAttribute>",
+ *                 lessThan: "<FilterAttribute>",
+ *                 lessThanOrEquals: "<FilterAttribute>",
+ *                 in: "<FilterAttribute>",
+ *                 notIn: "<FilterAttribute>",
+ *                 startsWith: "<FilterAttribute>",
+ *                 listContains: "<FilterAttribute>",
+ *                 stringContains: "<FilterAttribute>",
+ *                 andAll: [
+ *                   "<RetrievalFilter>",
+ *                 ],
+ *                 orAll: [
+ *                   "<RetrievalFilter>",
+ *                 ],
+ *               },
+ *             ],
+ *             orAll: [
+ *               "<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
+ *         promptTemplate: { // PromptTemplate
+ *           textPromptTemplate: "STRING_VALUE",
+ *         },
+ *         guardrailConfiguration: { // GuardrailConfiguration
+ *           guardrailId: "STRING_VALUE", // required
+ *           guardrailVersion: "STRING_VALUE", // required
+ *         },
+ *         inferenceConfig: { // InferenceConfig
+ *           textInferenceConfig: { // TextInferenceConfig
+ *             temperature: Number("float"),
+ *             topP: Number("float"),
+ *             maxTokens: Number("int"),
+ *             stopSequences: [ // RAGStopSequences
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *         },
+ *         additionalModelRequestFields: {
+ *           "<keys>": "DOCUMENT_VALUE",
+ *         },
+ *       },
+ *       orchestrationConfiguration: { // OrchestrationConfiguration
+ *         promptTemplate: {
+ *           textPromptTemplate: "STRING_VALUE",
+ *         },
+ *         inferenceConfig: {
+ *           textInferenceConfig: {
+ *             temperature: Number("float"),
+ *             topP: Number("float"),
+ *             maxTokens: Number("int"),
+ *             stopSequences: [
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *         },
+ *         additionalModelRequestFields: {
+ *           "<keys>": "DOCUMENT_VALUE",
+ *         },
+ *         queryTransformationConfiguration: { // QueryTransformationConfiguration
+ *           type: "QUERY_DECOMPOSITION", // required
+ *         },
+ *       },
+ *     },
+ *     externalSourcesConfiguration: { // ExternalSourcesRetrieveAndGenerateConfiguration
+ *       modelArn: "STRING_VALUE", // required
+ *       sources: [ // ExternalSources // required
+ *         { // ExternalSource
+ *           sourceType: "S3" || "BYTE_CONTENT", // required
+ *           s3Location: { // S3ObjectDoc
+ *             uri: "STRING_VALUE", // required
+ *           },
+ *           byteContent: { // ByteContentDoc
+ *             identifier: "STRING_VALUE", // required
+ *             contentType: "STRING_VALUE", // required
+ *             data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")             // required
+ *           },
+ *         },
+ *       ],
+ *       generationConfiguration: { // ExternalSourcesGenerationConfiguration
+ *         promptTemplate: {
+ *           textPromptTemplate: "STRING_VALUE",
+ *         },
+ *         guardrailConfiguration: {
+ *           guardrailId: "STRING_VALUE", // required
+ *           guardrailVersion: "STRING_VALUE", // required
+ *         },
+ *         inferenceConfig: {
+ *           textInferenceConfig: {
+ *             temperature: Number("float"),
+ *             topP: Number("float"),
+ *             maxTokens: Number("int"),
+ *             stopSequences: [
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *         },
+ *         additionalModelRequestFields: {
+ *           "<keys>": "DOCUMENT_VALUE",
+ *         },
+ *       },
+ *     },
+ *   },
+ *   sessionConfiguration: { // RetrieveAndGenerateSessionConfiguration
+ *     kmsKeyArn: "STRING_VALUE", // required
+ *   },
+ * };
+ * const command = new RetrieveAndGenerateStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // RetrieveAndGenerateStreamResponse
+ * //   stream: { // RetrieveAndGenerateStreamResponseOutput Union: only one key present
+ * //     output: { // RetrieveAndGenerateOutputEvent
+ * //       text: "STRING_VALUE", // required
+ * //     },
+ * //     citation: { // CitationEvent
+ * //       citation: { // Citation
+ * //         generatedResponsePart: { // GeneratedResponsePart
+ * //           textResponsePart: { // TextResponsePart
+ * //             text: "STRING_VALUE",
+ * //             span: { // Span
+ * //               start: Number("int"),
+ * //               end: Number("int"),
+ * //             },
+ * //           },
+ * //         },
+ * //         retrievedReferences: [ // RetrievedReferences
+ * //           { // RetrievedReference
+ * //             content: { // RetrievalResultContent
+ * //               text: "STRING_VALUE", // required
+ * //             },
+ * //             location: { // RetrievalResultLocation
+ * //               type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
+ * //               s3Location: { // RetrievalResultS3Location
+ * //                 uri: "STRING_VALUE",
+ * //               },
+ * //               webLocation: { // RetrievalResultWebLocation
+ * //                 url: "STRING_VALUE",
+ * //               },
+ * //               confluenceLocation: { // RetrievalResultConfluenceLocation
+ * //                 url: "STRING_VALUE",
+ * //               },
+ * //               salesforceLocation: { // RetrievalResultSalesforceLocation
+ * //                 url: "STRING_VALUE",
+ * //               },
+ * //               sharePointLocation: { // RetrievalResultSharePointLocation
+ * //                 url: "STRING_VALUE",
+ * //               },
+ * //               customDocumentLocation: { // RetrievalResultCustomDocumentLocation
+ * //                 id: "STRING_VALUE",
+ * //               },
+ * //             },
+ * //             metadata: { // RetrievalResultMetadata
+ * //               "<keys>": "DOCUMENT_VALUE",
+ * //             },
+ * //           },
+ * //         ],
+ * //       },
+ * //     },
+ * //     guardrail: { // GuardrailEvent
+ * //       action: "INTERVENED" || "NONE",
+ * //     },
+ * //     internalServerException: { // InternalServerException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     validationException: { // ValidationException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     resourceNotFoundException: { // ResourceNotFoundException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     serviceQuotaExceededException: { // ServiceQuotaExceededException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     throttlingException: { // ThrottlingException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     accessDeniedException: { // AccessDeniedException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     conflictException: { // ConflictException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     dependencyFailedException: { // DependencyFailedException
+ * //       message: "STRING_VALUE",
+ * //       resourceName: "STRING_VALUE",
+ * //     },
+ * //     badGatewayException: { // BadGatewayException
+ * //       message: "STRING_VALUE",
+ * //       resourceName: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   sessionId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param RetrieveAndGenerateStreamCommandInput - {@link RetrieveAndGenerateStreamCommandInput}
+ * @returns {@link RetrieveAndGenerateStreamCommandOutput}
+ * @see {@link RetrieveAndGenerateStreamCommandInput} for command's `input` shape.
+ * @see {@link RetrieveAndGenerateStreamCommandOutput} 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 RetrieveAndGenerateStreamCommand extends RetrieveAndGenerateStreamCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RetrieveAndGenerateStreamRequest;
+            output: RetrieveAndGenerateStreamResponse;
+        };
+        sdk: {
+            input: RetrieveAndGenerateStreamCommandInput;
+            output: RetrieveAndGenerateStreamCommandOutput;
+        };
+    };
+}

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

@@ -95,8 +95,49 @@ declare const RetrieveCommand_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
+ *       },
  *     },
  *   },
+ *   guardrailConfiguration: { // GuardrailConfiguration
+ *     guardrailId: "STRING_VALUE", // required
+ *     guardrailVersion: "STRING_VALUE", // required
+ *   },
  *   nextToken: "STRING_VALUE",
  * };
  * const command = new RetrieveCommand(input);
@@ -108,7 +149,7 @@ declare const RetrieveCommand_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",
  * //         },
@@ -124,6 +165,9 @@ declare const RetrieveCommand_base: {
  * //         sharePointLocation: { // RetrievalResultSharePointLocation
  * //           url: "STRING_VALUE",
  * //         },
+ * //         customDocumentLocation: { // RetrievalResultCustomDocumentLocation
+ * //           id: "STRING_VALUE",
+ * //         },
  * //       },
  * //       score: Number("double"),
  * //       metadata: { // RetrievalResultMetadata
@@ -131,6 +175,7 @@ declare const RetrieveCommand_base: {
  * //       },
  * //     },
  * //   ],
+ * //   guardrailAction: "INTERVENED" || "NONE",
  * //   nextToken: "STRING_VALUE",
  * // };
  *

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

@@ -4,5 +4,7 @@ export * from "./InvokeAgentCommand";
 export * from "./InvokeFlowCommand";
 export * from "./InvokeInlineAgentCommand";
 export * from "./OptimizePromptCommand";
+export * from "./RerankCommand";
 export * from "./RetrieveAndGenerateCommand";
+export * from "./RetrieveAndGenerateStreamCommand";
 export * from "./RetrieveCommand";