@aws-sdk/client-bedrock-agent-runtime 3.535.0 → 3.542.0

package/dist-cjs/endpoint/endpointResolver.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultEndpointResolver = void 0;
-const util_endpoints_1 = require("@smithy/util-endpoints");
+const util_endpoints_1 = require("@aws-sdk/util-endpoints");
+const util_endpoints_2 = require("@smithy/util-endpoints");
 const ruleset_1 = require("./ruleset");
 const defaultEndpointResolver = (endpointParams, context = {}) => {
-    return (0, util_endpoints_1.resolveEndpoint)(ruleset_1.ruleSet, {
+    return (0, util_endpoints_2.resolveEndpoint)(ruleset_1.ruleSet, {
         endpointParams: endpointParams,
         logger: context.logger,
     });
 };
 exports.defaultEndpointResolver = defaultEndpointResolver;
+util_endpoints_2.customEndpointFunctions.aws = util_endpoints_1.awsEndpointFunctions;

package/dist-cjs/index.js

@@ -36,6 +36,7 @@ __export(src_exports, {
   FailureTraceFilterSensitiveLog: () => FailureTraceFilterSensitiveLog,
   FinalResponseFilterSensitiveLog: () => FinalResponseFilterSensitiveLog,
   GeneratedResponsePartFilterSensitiveLog: () => GeneratedResponsePartFilterSensitiveLog,
+  GenerationConfigurationFilterSensitiveLog: () => GenerationConfigurationFilterSensitiveLog,
   InternalServerException: () => InternalServerException,
   InvocationInputFilterSensitiveLog: () => InvocationInputFilterSensitiveLog,
   InvocationType: () => InvocationType,
@@ -46,6 +47,7 @@ __export(src_exports, {
   KnowledgeBaseLookupOutputFilterSensitiveLog: () => KnowledgeBaseLookupOutputFilterSensitiveLog,
   KnowledgeBaseQueryFilterSensitiveLog: () => KnowledgeBaseQueryFilterSensitiveLog,
   KnowledgeBaseRetrievalResultFilterSensitiveLog: () => KnowledgeBaseRetrievalResultFilterSensitiveLog,
+  KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: () => KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog,
   ModelInvocationInputFilterSensitiveLog: () => ModelInvocationInputFilterSensitiveLog,
   ObservationFilterSensitiveLog: () => ObservationFilterSensitiveLog,
   OrchestrationTrace: () => OrchestrationTrace,
@@ -59,6 +61,7 @@ __export(src_exports, {
   PreProcessingParsedResponseFilterSensitiveLog: () => PreProcessingParsedResponseFilterSensitiveLog,
   PreProcessingTrace: () => PreProcessingTrace,
   PreProcessingTraceFilterSensitiveLog: () => PreProcessingTraceFilterSensitiveLog,
+  PromptTemplateFilterSensitiveLog: () => PromptTemplateFilterSensitiveLog,
   PromptType: () => PromptType,
   RationaleFilterSensitiveLog: () => RationaleFilterSensitiveLog,
   RepromptResponseFilterSensitiveLog: () => RepromptResponseFilterSensitiveLog,
@@ -69,6 +72,7 @@ __export(src_exports, {
   RetrievalResultLocationFilterSensitiveLog: () => RetrievalResultLocationFilterSensitiveLog,
   RetrievalResultLocationType: () => RetrievalResultLocationType,
   RetrieveAndGenerateCommand: () => RetrieveAndGenerateCommand,
+  RetrieveAndGenerateConfigurationFilterSensitiveLog: () => RetrieveAndGenerateConfigurationFilterSensitiveLog,
   RetrieveAndGenerateInputFilterSensitiveLog: () => RetrieveAndGenerateInputFilterSensitiveLog,
   RetrieveAndGenerateOutputFilterSensitiveLog: () => RetrieveAndGenerateOutputFilterSensitiveLog,
   RetrieveAndGenerateRequestFilterSensitiveLog: () => RetrieveAndGenerateRequestFilterSensitiveLog,
@@ -727,9 +731,36 @@ var InvokeAgentResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
 var RetrieveAndGenerateInputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
   ...obj
 }), "RetrieveAndGenerateInputFilterSensitiveLog");
+var PromptTemplateFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.textPromptTemplate && { textPromptTemplate: import_smithy_client.SENSITIVE_STRING }
+}), "PromptTemplateFilterSensitiveLog");
+var GenerationConfigurationFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.promptTemplate && { promptTemplate: PromptTemplateFilterSensitiveLog(obj.promptTemplate) }
+}), "GenerationConfigurationFilterSensitiveLog");
+var KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.generationConfiguration && {
+    generationConfiguration: GenerationConfigurationFilterSensitiveLog(obj.generationConfiguration)
+  }
+}), "KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog");
+var RetrieveAndGenerateConfigurationFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.knowledgeBaseConfiguration && {
+    knowledgeBaseConfiguration: KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog(
+      obj.knowledgeBaseConfiguration
+    )
+  }
+}), "RetrieveAndGenerateConfigurationFilterSensitiveLog");
 var RetrieveAndGenerateRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
   ...obj,
-  ...obj.input && { input: import_smithy_client.SENSITIVE_STRING }
+  ...obj.input && { input: import_smithy_client.SENSITIVE_STRING },
+  ...obj.retrieveAndGenerateConfiguration && {
+    retrieveAndGenerateConfiguration: RetrieveAndGenerateConfigurationFilterSensitiveLog(
+      obj.retrieveAndGenerateConfiguration
+    )
+  }
 }), "RetrieveAndGenerateRequestFilterSensitiveLog");
 var RetrieveAndGenerateOutputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
   ...obj
@@ -1367,9 +1398,6 @@ var BedrockAgentRuntime = _BedrockAgentRuntime;
 // src/pagination/RetrievePaginator.ts
 
 var paginateRetrieve = (0, import_core.createPaginator)(BedrockAgentRuntimeClient, RetrieveCommand, "nextToken", "nextToken", "");
-
-// src/index.ts
-var import_util_endpoints = require("@aws-sdk/util-endpoints");
 // Annotate the CommonJS export names for ESM import in node:
 
 0 && (module.exports = {
@@ -1436,6 +1464,10 @@ var import_util_endpoints = require("@aws-sdk/util-endpoints");
   ResponseStreamFilterSensitiveLog,
   InvokeAgentResponseFilterSensitiveLog,
   RetrieveAndGenerateInputFilterSensitiveLog,
+  PromptTemplateFilterSensitiveLog,
+  GenerationConfigurationFilterSensitiveLog,
+  KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog,
+  RetrieveAndGenerateConfigurationFilterSensitiveLog,
   RetrieveAndGenerateRequestFilterSensitiveLog,
   RetrieveAndGenerateOutputFilterSensitiveLog,
   RetrieveAndGenerateResponseFilterSensitiveLog,

package/dist-es/endpoint/endpointResolver.js

@@ -1,4 +1,5 @@
-import { resolveEndpoint } from "@smithy/util-endpoints";
+import { awsEndpointFunctions } from "@aws-sdk/util-endpoints";
+import { customEndpointFunctions, resolveEndpoint } from "@smithy/util-endpoints";
 import { ruleSet } from "./ruleset";
 export const defaultEndpointResolver = (endpointParams, context = {}) => {
     return resolveEndpoint(ruleSet, {
@@ -6,3 +7,4 @@ export const defaultEndpointResolver = (endpointParams, context = {}) => {
         logger: context.logger,
     });
 };
+customEndpointFunctions.aws = awsEndpointFunctions;

package/dist-es/index.js

@@ -3,5 +3,4 @@ export * from "./BedrockAgentRuntime";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";
-import "@aws-sdk/util-endpoints";
 export { BedrockAgentRuntimeServiceException } from "./models/BedrockAgentRuntimeServiceException";

package/dist-es/models/models_0.js

@@ -417,9 +417,32 @@ export const InvokeAgentResponseFilterSensitiveLog = (obj) => ({
 export const RetrieveAndGenerateInputFilterSensitiveLog = (obj) => ({
     ...obj,
 });
+export const PromptTemplateFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.textPromptTemplate && { textPromptTemplate: SENSITIVE_STRING }),
+});
+export const GenerationConfigurationFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.promptTemplate && { promptTemplate: PromptTemplateFilterSensitiveLog(obj.promptTemplate) }),
+});
+export const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.generationConfiguration && {
+        generationConfiguration: GenerationConfigurationFilterSensitiveLog(obj.generationConfiguration),
+    }),
+});
+export const RetrieveAndGenerateConfigurationFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.knowledgeBaseConfiguration && {
+        knowledgeBaseConfiguration: KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog(obj.knowledgeBaseConfiguration),
+    }),
+});
 export const RetrieveAndGenerateRequestFilterSensitiveLog = (obj) => ({
     ...obj,
     ...(obj.input && { input: SENSITIVE_STRING }),
+    ...(obj.retrieveAndGenerateConfiguration && {
+        retrieveAndGenerateConfiguration: RetrieveAndGenerateConfigurationFilterSensitiveLog(obj.retrieveAndGenerateConfiguration),
+    }),
 });
 export const RetrieveAndGenerateOutputFilterSensitiveLog = (obj) => ({
     ...obj,

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

@@ -27,9 +27,6 @@ declare const RetrieveAndGenerateCommand_base: {
 };
 /**
  * <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
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,6 +49,11 @@ declare const RetrieveAndGenerateCommand_base: {
  *           overrideSearchType: "HYBRID" || "SEMANTIC",
  *         },
  *       },
+ *       generationConfiguration: { // GenerationConfiguration
+ *         promptTemplate: { // PromptTemplate
+ *           textPromptTemplate: "STRING_VALUE",
+ *         },
+ *       },
  *     },
  *   },
  *   sessionConfiguration: { // RetrieveAndGenerateSessionConfiguration

package/dist-types/index.d.ts

@@ -11,5 +11,4 @@ export { BedrockAgentRuntimeExtensionConfiguration } from "./extensionConfigurat
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";
-import "@aws-sdk/util-endpoints";
 export { BedrockAgentRuntimeServiceException } from "./models/BedrockAgentRuntimeServiceException";

package/dist-types/models/models_0.d.ts

@@ -145,7 +145,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
- * <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>
+ * <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/agents-session-state.html">Control session context</a>.</p>
  * @public
  */
 export interface SessionState {
@@ -165,7 +165,7 @@ export interface SessionState {
  */
 export interface InvokeAgentRequest {
     /**
-     * <p>Contains parameters that specify various attributes of the session.</p>
+     * <p>Contains parameters that specify various attributes of the session. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
      * @public
      */
     sessionState?: SessionState;
@@ -202,6 +202,17 @@ export interface InvokeAgentRequest {
 }
 /**
  * <p>Contains information about where the text with a citation begins and ends in the generated output.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>span</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>span</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface Span {
@@ -218,6 +229,17 @@ export interface Span {
 }
 /**
  * <p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>textResponsePart</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>textResponsePart</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface TextResponsePart {
@@ -234,6 +256,17 @@ export interface TextResponsePart {
 }
 /**
  * <p>Contains metadata about a part of the generated response that is accompanied by a citation.</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_ResponseSyntax">Retrieve response</a> – in the <code>generatedResponsePart</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>generatedResponsePart</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface GeneratedResponsePart {
@@ -245,6 +278,21 @@ export interface GeneratedResponsePart {
 }
 /**
  * <p>Contains the cited text from the data source.</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_ResponseSyntax">Retrieve response</a> – in the <code>content</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>content</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>content</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrievalResultContent {
@@ -256,6 +304,21 @@ export interface RetrievalResultContent {
 }
 /**
  * <p>Contains the S3 location of the data source.</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_ResponseSyntax">Retrieve response</a> – in the <code>s3Location</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>s3Location</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>s3Location</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrievalResultS3Location {
@@ -278,6 +341,21 @@ export declare const RetrievalResultLocationType: {
 export type RetrievalResultLocationType = (typeof RetrievalResultLocationType)[keyof typeof RetrievalResultLocationType];
 /**
  * <p>Contains information about the location of the data source.</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_ResponseSyntax">Retrieve response</a> – in the <code>location</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>location</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>locatino</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrievalResultLocation {
@@ -293,7 +371,18 @@ export interface RetrievalResultLocation {
     s3Location?: RetrievalResultS3Location;
 }
 /**
- * <p>Contains metadata about a sources cited for the generated response.</p>
+ * <p>Contains metadata about a source cited for the generated response.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>retrievedReferences</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a> – in the <code>retrievedReferences</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrievedReference {
@@ -310,6 +399,17 @@ export interface RetrievedReference {
 }
 /**
  * <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>
+ *          <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_ResponseSyntax">Retrieve response</a> – in the <code>citations</code> field</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>citations</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface Citation {
@@ -1327,6 +1427,13 @@ export interface InvokeAgentResponse {
 }
 /**
  * <p>Contains the query made to the knowledge base.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>input</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrieveAndGenerateInput {
@@ -1336,6 +1443,57 @@ export interface RetrieveAndGenerateInput {
      */
     text: string | undefined;
 }
+/**
+ * <p>Contains the template for the prompt that's sent to the model for response generation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a>.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @public
+ */
+export interface PromptTemplate {
+    /**
+     * <p>The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.</p>
+     *          <p>For more information, see the following resources:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <a href="https://docs.anthropic.com/claude/docs/use-xml-tags">Use XML tags with Anthropic Claude models</a>
+     *                </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    textPromptTemplate?: string;
+}
+/**
+ * <p>Contains configurations for response generation based on the knowledge base query results.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @public
+ */
+export interface GenerationConfiguration {
+    /**
+     * <p>Contains the template for the prompt that's sent to the model for response generation.</p>
+     * @public
+     */
+    promptTemplate?: PromptTemplate;
+}
 /**
  * @public
  * @enum
@@ -1349,15 +1507,23 @@ export declare const SearchType: {
  */
 export type SearchType = (typeof SearchType)[keyof typeof SearchType];
 /**
- * <p>Configurations for how to carry out the search.</p>
+ * <p>Configurations for how to perform the search query and return results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</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</a> – in the <code>vectorSearchConfiguration</code> field</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</a> – in the <code>vectorSearchConfiguration</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface KnowledgeBaseVectorSearchConfiguration {
     /**
-     * <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>
+     * <p>The number of source chunks to retrieve.</p>
      * @public
      */
     numberOfResults?: number;
@@ -1368,31 +1534,40 @@ export interface KnowledgeBaseVectorSearchConfiguration {
     overrideSearchType?: SearchType;
 }
 /**
- * <p>Contains details about how the results should be returned.</p>
+ * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalConfiguration</code> field</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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrievalConfiguration</code> field</p>
  *             </li>
  *          </ul>
  * @public
  */
 export interface KnowledgeBaseRetrievalConfiguration {
     /**
-     * <p>Contains details about how the results from the vector search should be returned.</p>
+     * <p>Contains details about how the results from the vector search should be returned. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
      * @public
      */
     vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
 }
 /**
  * <p>Contains details about the resource being queried.</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</a> – in the <code>knowledgeBaseConfiguration</code> field</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</a> – in the <code>knowledgeBaseConfiguration</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
@@ -1411,6 +1586,11 @@ export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
      * @public
      */
     retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
+    /**
+     * <p>Contains configurations for response generation based on the knowwledge base query results.</p>
+     * @public
+     */
+    generationConfiguration?: GenerationConfiguration;
 }
 /**
  * @public
@@ -1425,6 +1605,13 @@ export declare const RetrieveAndGenerateType: {
 export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType];
 /**
  * <p>Contains details about the resource being queried.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrieveAndGenerateConfiguration</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrieveAndGenerateConfiguration {
@@ -1441,6 +1628,13 @@ export interface RetrieveAndGenerateConfiguration {
 }
 /**
  * <p>Contains configuration about the session with the knowledge base.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>sessionConfiguration</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrieveAndGenerateSessionConfiguration {
@@ -1460,12 +1654,12 @@ export interface RetrieveAndGenerateRequest {
      */
     sessionId?: string;
     /**
-     * <p>Contains the query made to the knowledge base.</p>
+     * <p>Contains the query to be made to the knowledge base.</p>
      * @public
      */
     input: RetrieveAndGenerateInput | undefined;
     /**
-     * <p>Contains details about the resource being queried and the foundation model used for generation.</p>
+     * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
      * @public
      */
     retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
@@ -1477,6 +1671,13 @@ export interface RetrieveAndGenerateRequest {
 }
 /**
  * <p>Contains the response generated from querying the knowledge base.</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_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface RetrieveAndGenerateOutput {
@@ -1508,6 +1709,13 @@ export interface RetrieveAndGenerateResponse {
 }
 /**
  * <p>Contains the query made to the knowledge base.</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</a> – in the <code>retrievalQuery</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface KnowledgeBaseQuery {
@@ -1527,12 +1735,12 @@ export interface RetrieveRequest {
      */
     knowledgeBaseId: string | undefined;
     /**
-     * <p>The query to send the knowledge base.</p>
+     * <p>Contains the query to send the knowledge base.</p>
      * @public
      */
     retrievalQuery: KnowledgeBaseQuery | undefined;
     /**
-     * <p>Contains details about how the results should be returned.</p>
+     * <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
      * @public
      */
     retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
@@ -1544,6 +1752,13 @@ export interface RetrieveRequest {
 }
 /**
  * <p>Details about a result from querying the knowledge base.</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_ResponseSyntax">Retrieve response</a> – in the <code>retrievalResults</code> field</p>
+ *             </li>
+ *          </ul>
  * @public
  */
 export interface KnowledgeBaseRetrievalResult {
@@ -1706,6 +1921,22 @@ export declare const InvokeAgentResponseFilterSensitiveLog: (obj: InvokeAgentRes
  * @internal
  */
 export declare const RetrieveAndGenerateInputFilterSensitiveLog: (obj: RetrieveAndGenerateInput) => any;
+/**
+ * @internal
+ */
+export declare const PromptTemplateFilterSensitiveLog: (obj: PromptTemplate) => any;
+/**
+ * @internal
+ */
+export declare const GenerationConfigurationFilterSensitiveLog: (obj: GenerationConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
+/**
+ * @internal
+ */
+export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/index.d.ts

@@ -6,5 +6,4 @@ export { BedrockAgentRuntimeExtensionConfiguration } from "./extensionConfigurat
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";
-import "@aws-sdk/util-endpoints";
 export { BedrockAgentRuntimeServiceException } from "./models/BedrockAgentRuntimeServiceException";

package/dist-types/ts3.4/models/models_0.d.ts

@@ -603,6 +603,12 @@ export interface InvokeAgentResponse {
 export interface RetrieveAndGenerateInput {
   text: string | undefined;
 }
+export interface PromptTemplate {
+  textPromptTemplate?: string;
+}
+export interface GenerationConfiguration {
+  promptTemplate?: PromptTemplate;
+}
 export declare const SearchType: {
   readonly HYBRID: "HYBRID";
   readonly SEMANTIC: "SEMANTIC";
@@ -619,6 +625,7 @@ export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
   knowledgeBaseId: string | undefined;
   modelArn: string | undefined;
   retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
+  generationConfiguration?: GenerationConfiguration;
 }
 export declare const RetrieveAndGenerateType: {
   readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
@@ -744,6 +751,18 @@ export declare const InvokeAgentResponseFilterSensitiveLog: (
 export declare const RetrieveAndGenerateInputFilterSensitiveLog: (
   obj: RetrieveAndGenerateInput
 ) => any;
+export declare const PromptTemplateFilterSensitiveLog: (
+  obj: PromptTemplate
+) => any;
+export declare const GenerationConfigurationFilterSensitiveLog: (
+  obj: GenerationConfiguration
+) => any;
+export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (
+  obj: KnowledgeBaseRetrieveAndGenerateConfiguration
+) => any;
+export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (
+  obj: RetrieveAndGenerateConfiguration
+) => any;
 export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (
   obj: RetrieveAndGenerateRequest
 ) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "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.535.0",
+  "version": "3.542.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent-runtime",
@@ -20,16 +20,16 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.535.0",
+    "@aws-sdk/client-sts": "3.540.0",
     "@aws-sdk/core": "3.535.0",
-    "@aws-sdk/credential-provider-node": "3.535.0",
+    "@aws-sdk/credential-provider-node": "3.540.0",
     "@aws-sdk/middleware-host-header": "3.535.0",
     "@aws-sdk/middleware-logger": "3.535.0",
     "@aws-sdk/middleware-recursion-detection": "3.535.0",
-    "@aws-sdk/middleware-user-agent": "3.535.0",
+    "@aws-sdk/middleware-user-agent": "3.540.0",
     "@aws-sdk/region-config-resolver": "3.535.0",
     "@aws-sdk/types": "3.535.0",
-    "@aws-sdk/util-endpoints": "3.535.0",
+    "@aws-sdk/util-endpoints": "3.540.0",
     "@aws-sdk/util-user-agent-browser": "3.535.0",
     "@aws-sdk/util-user-agent-node": "3.535.0",
     "@smithy/config-resolver": "^2.2.0",