@aws-sdk/client-bedrock-agent-runtime 3.572.0 → 3.574.0

package/dist-cjs/index.js

@@ -44,6 +44,7 @@ __export(src_exports, {
   FinalResponseFilterSensitiveLog: () => FinalResponseFilterSensitiveLog,
   GeneratedResponsePartFilterSensitiveLog: () => GeneratedResponsePartFilterSensitiveLog,
   GenerationConfigurationFilterSensitiveLog: () => GenerationConfigurationFilterSensitiveLog,
+  GuadrailAction: () => GuadrailAction,
   InternalServerException: () => InternalServerException,
   InvocationInputFilterSensitiveLog: () => InvocationInputFilterSensitiveLog,
   InvocationInputMember: () => InvocationInputMember,
@@ -586,6 +587,10 @@ var RetrieveAndGenerateType = {
   EXTERNAL_SOURCES: "EXTERNAL_SOURCES",
   KNOWLEDGE_BASE: "KNOWLEDGE_BASE"
 };
+var GuadrailAction = {
+  INTERVENED: "INTERVENED",
+  NONE: "NONE"
+};
 var RetrievalFilter;
 ((RetrievalFilter2) => {
   RetrievalFilter2.visit = /* @__PURE__ */ __name((value, visitor) => {
@@ -1074,6 +1079,7 @@ var de_RetrieveAndGenerateCommand = /* @__PURE__ */ __name(async (output, contex
   const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
   const doc = (0, import_smithy_client.take)(data, {
     citations: (_) => de_Citations(_, context),
+    guardrailAction: import_smithy_client.expectString,
     output: import_smithy_client._json,
     sessionId: import_smithy_client.expectString
   });
@@ -1398,6 +1404,18 @@ var de_ValidationException_event = /* @__PURE__ */ __name(async (output, context
   };
   return de_ValidationExceptionRes(parsedOutput, context);
 }, "de_ValidationException_event");
+var se_AdditionalModelRequestFields = /* @__PURE__ */ __name((input, context) => {
+  return Object.entries(input).reduce((acc, [key, value]) => {
+    if (value === null) {
+      return acc;
+    }
+    acc[key] = se_AdditionalModelRequestFieldsValue(value, context);
+    return acc;
+  }, {});
+}, "se_AdditionalModelRequestFields");
+var se_AdditionalModelRequestFieldsValue = /* @__PURE__ */ __name((input, context) => {
+  return input;
+}, "se_AdditionalModelRequestFieldsValue");
 var se_ByteContentDoc = /* @__PURE__ */ __name((input, context) => {
   return (0, import_smithy_client.take)(input, {
     contentType: [],
@@ -1417,9 +1435,17 @@ var se_ExternalSources = /* @__PURE__ */ __name((input, context) => {
     return se_ExternalSource(entry, context);
   });
 }, "se_ExternalSources");
+var se_ExternalSourcesGenerationConfiguration = /* @__PURE__ */ __name((input, context) => {
+  return (0, import_smithy_client.take)(input, {
+    additionalModelRequestFields: (_) => se_AdditionalModelRequestFields(_, context),
+    guardrailConfiguration: import_smithy_client._json,
+    inferenceConfig: (_) => se_InferenceConfig(_, context),
+    promptTemplate: import_smithy_client._json
+  });
+}, "se_ExternalSourcesGenerationConfiguration");
 var se_ExternalSourcesRetrieveAndGenerateConfiguration = /* @__PURE__ */ __name((input, context) => {
   return (0, import_smithy_client.take)(input, {
-    generationConfiguration: import_smithy_client._json,
+    generationConfiguration: (_) => se_ExternalSourcesGenerationConfiguration(_, context),
     modelArn: [],
     sources: (_) => se_ExternalSources(_, context)
   });
@@ -1433,6 +1459,19 @@ var se_FilterAttribute = /* @__PURE__ */ __name((input, context) => {
 var se_FilterValue = /* @__PURE__ */ __name((input, context) => {
   return input;
 }, "se_FilterValue");
+var se_GenerationConfiguration = /* @__PURE__ */ __name((input, context) => {
+  return (0, import_smithy_client.take)(input, {
+    additionalModelRequestFields: (_) => se_AdditionalModelRequestFields(_, context),
+    guardrailConfiguration: import_smithy_client._json,
+    inferenceConfig: (_) => se_InferenceConfig(_, context),
+    promptTemplate: import_smithy_client._json
+  });
+}, "se_GenerationConfiguration");
+var se_InferenceConfig = /* @__PURE__ */ __name((input, context) => {
+  return (0, import_smithy_client.take)(input, {
+    textInferenceConfig: (_) => se_TextInferenceConfig(_, context)
+  });
+}, "se_InferenceConfig");
 var se_KnowledgeBaseRetrievalConfiguration = /* @__PURE__ */ __name((input, context) => {
   return (0, import_smithy_client.take)(input, {
     vectorSearchConfiguration: (_) => se_KnowledgeBaseVectorSearchConfiguration(_, context)
@@ -1440,7 +1479,7 @@ var se_KnowledgeBaseRetrievalConfiguration = /* @__PURE__ */ __name((input, cont
 }, "se_KnowledgeBaseRetrievalConfiguration");
 var se_KnowledgeBaseRetrieveAndGenerateConfiguration = /* @__PURE__ */ __name((input, context) => {
   return (0, import_smithy_client.take)(input, {
-    generationConfiguration: import_smithy_client._json,
+    generationConfiguration: (_) => se_GenerationConfiguration(_, context),
     knowledgeBaseId: [],
     modelArn: [],
     retrievalConfiguration: (_) => se_KnowledgeBaseRetrievalConfiguration(_, context)
@@ -1481,6 +1520,14 @@ var se_RetrieveAndGenerateConfiguration = /* @__PURE__ */ __name((input, context
     type: []
   });
 }, "se_RetrieveAndGenerateConfiguration");
+var se_TextInferenceConfig = /* @__PURE__ */ __name((input, context) => {
+  return (0, import_smithy_client.take)(input, {
+    maxTokens: [],
+    stopSequences: import_smithy_client._json,
+    temperature: import_smithy_client.serializeFloat,
+    topP: import_smithy_client.serializeFloat
+  });
+}, "se_TextInferenceConfig");
 var de_Attribution = /* @__PURE__ */ __name((output, context) => {
   return (0, import_smithy_client.take)(output, {
     citations: (_) => de_Citations(_, context)
@@ -1777,6 +1824,7 @@ var paginateRetrieve = (0, import_core.createPaginator)(BedrockAgentRuntimeClien
   ExternalSourceType,
   SearchType,
   RetrieveAndGenerateType,
+  GuadrailAction,
   RetrievalFilter,
   ActionGroupInvocationInputFilterSensitiveLog,
   ActionGroupInvocationOutputFilterSensitiveLog,

package/dist-es/models/models_0.js

@@ -254,6 +254,10 @@ export const RetrieveAndGenerateType = {
     EXTERNAL_SOURCES: "EXTERNAL_SOURCES",
     KNOWLEDGE_BASE: "KNOWLEDGE_BASE",
 };
+export const GuadrailAction = {
+    INTERVENED: "INTERVENED",
+    NONE: "NONE",
+};
 export var RetrievalFilter;
 (function (RetrievalFilter) {
     RetrievalFilter.visit = (value, visitor) => {

package/dist-es/protocols/Aws_restJson1.js

@@ -1,6 +1,6 @@
 import { awsExpectUnion as __expectUnion, loadRestJsonErrorCode, parseJsonBody as parseBody, parseJsonErrorBody as parseErrorBody, } from "@aws-sdk/core";
 import { requestBuilder as rb } from "@smithy/core";
-import { _json, collectBody, decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, limitedParseDouble as __limitedParseDouble, limitedParseFloat32 as __limitedParseFloat32, map, take, withBaseException, } from "@smithy/smithy-client";
+import { _json, collectBody, decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectNonNull as __expectNonNull, expectObject as __expectObject, expectString as __expectString, limitedParseDouble as __limitedParseDouble, limitedParseFloat32 as __limitedParseFloat32, map, serializeFloat as __serializeFloat, take, withBaseException, } from "@smithy/smithy-client";
 import { BedrockAgentRuntimeServiceException as __BaseException } from "../models/BedrockAgentRuntimeServiceException";
 import { AccessDeniedException, BadGatewayException, ConflictException, DependencyFailedException, InternalServerException, ResourceNotFoundException, RetrievalFilter, ServiceQuotaExceededException, ThrottlingException, ValidationException, } from "../models/models_0";
 export const se_InvokeAgentCommand = async (input, context) => {
@@ -92,6 +92,7 @@ export const de_RetrieveAndGenerateCommand = async (output, context) => {
     const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
     const doc = take(data, {
         citations: (_) => de_Citations(_, context),
+        guardrailAction: __expectString,
         output: _json,
         sessionId: __expectString,
     });
@@ -407,6 +408,18 @@ const de_ValidationException_event = async (output, context) => {
     };
     return de_ValidationExceptionRes(parsedOutput, context);
 };
+const se_AdditionalModelRequestFields = (input, context) => {
+    return Object.entries(input).reduce((acc, [key, value]) => {
+        if (value === null) {
+            return acc;
+        }
+        acc[key] = se_AdditionalModelRequestFieldsValue(value, context);
+        return acc;
+    }, {});
+};
+const se_AdditionalModelRequestFieldsValue = (input, context) => {
+    return input;
+};
 const se_ByteContentDoc = (input, context) => {
     return take(input, {
         contentType: [],
@@ -428,9 +441,17 @@ const se_ExternalSources = (input, context) => {
         return se_ExternalSource(entry, context);
     });
 };
+const se_ExternalSourcesGenerationConfiguration = (input, context) => {
+    return take(input, {
+        additionalModelRequestFields: (_) => se_AdditionalModelRequestFields(_, context),
+        guardrailConfiguration: _json,
+        inferenceConfig: (_) => se_InferenceConfig(_, context),
+        promptTemplate: _json,
+    });
+};
 const se_ExternalSourcesRetrieveAndGenerateConfiguration = (input, context) => {
     return take(input, {
-        generationConfiguration: _json,
+        generationConfiguration: (_) => se_ExternalSourcesGenerationConfiguration(_, context),
         modelArn: [],
         sources: (_) => se_ExternalSources(_, context),
     });
@@ -444,6 +465,19 @@ const se_FilterAttribute = (input, context) => {
 const se_FilterValue = (input, context) => {
     return input;
 };
+const se_GenerationConfiguration = (input, context) => {
+    return take(input, {
+        additionalModelRequestFields: (_) => se_AdditionalModelRequestFields(_, context),
+        guardrailConfiguration: _json,
+        inferenceConfig: (_) => se_InferenceConfig(_, context),
+        promptTemplate: _json,
+    });
+};
+const se_InferenceConfig = (input, context) => {
+    return take(input, {
+        textInferenceConfig: (_) => se_TextInferenceConfig(_, context),
+    });
+};
 const se_KnowledgeBaseRetrievalConfiguration = (input, context) => {
     return take(input, {
         vectorSearchConfiguration: (_) => se_KnowledgeBaseVectorSearchConfiguration(_, context),
@@ -451,7 +485,7 @@ const se_KnowledgeBaseRetrievalConfiguration = (input, context) => {
 };
 const se_KnowledgeBaseRetrieveAndGenerateConfiguration = (input, context) => {
     return take(input, {
-        generationConfiguration: _json,
+        generationConfiguration: (_) => se_GenerationConfiguration(_, context),
         knowledgeBaseId: [],
         modelArn: [],
         retrievalConfiguration: (_) => se_KnowledgeBaseRetrievalConfiguration(_, context),
@@ -494,6 +528,14 @@ const se_RetrieveAndGenerateConfiguration = (input, context) => {
         type: [],
     });
 };
+const se_TextInferenceConfig = (input, context) => {
+    return take(input, {
+        maxTokens: [],
+        stopSequences: _json,
+        temperature: __serializeFloat,
+        topP: __serializeFloat,
+    });
+};
 const de_Attribution = (output, context) => {
     return take(output, {
         citations: (_) => de_Citations(_, context),

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

@@ -26,10 +26,10 @@ declare const InvokeAgentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Sends a prompt for the agent to process and respond to. Use return control event type for function calling.</p>
- *          <note>
+ * <note>
  *             <p>The CLI doesn't support <code>InvokeAgent</code>.</p>
  *          </note>
+ *          <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p>
  *          <ul>
  *             <li>
  *                <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p>
@@ -41,10 +41,7 @@ declare const InvokeAgentCommand_base: {
  *                <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p>
  *             </li>
  *             <li>
- *                <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or parameters returned from the action group.</p>
- *             </li>
- *             <li>
- *                <p>Use return control event type for function calling.</p>
+ *                <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p>
  *             </li>
  *          </ul>
  *          <p>The response is returned in the <code>bytes</code> field of the <code>chunk</code> object.</p>
@@ -56,6 +53,9 @@ declare const InvokeAgentCommand_base: {
  *                <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p>
  *             </li>
  *             <li>
+ *                <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p>
+ *             </li>
+ *             <li>
  *                <p>Errors are also surfaced in the response.</p>
  *             </li>
  *          </ul>

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

@@ -101,6 +101,23 @@ declare const RetrieveAndGenerateCommand_base: {
  *         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: { // AdditionalModelRequestFields
+ *           "<keys>": "DOCUMENT_VALUE",
+ *         },
  *       },
  *     },
  *     externalSourcesConfiguration: { // ExternalSourcesRetrieveAndGenerateConfiguration
@@ -122,6 +139,23 @@ declare const RetrieveAndGenerateCommand_base: {
  *         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",
+ *         },
  *       },
  *     },
  *   },
@@ -165,6 +199,7 @@ declare const RetrieveAndGenerateCommand_base: {
  * //       ],
  * //     },
  * //   ],
+ * //   guardrailAction: "INTERVENED" || "NONE",
  * // };
  *
  * ```

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

@@ -155,7 +155,7 @@ export declare class InternalServerException extends __BaseException {
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
- *                <p>In the <code>returnControlInvocationResults</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a>
+ *                <p>In the <code>returnControlInvocationResults</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -185,7 +185,7 @@ export type ResponseState = (typeof ResponseState)[keyof typeof ResponseState];
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
- *                <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a>
+ *                <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -208,7 +208,7 @@ export interface ApiResult {
      */
     apiPath?: string;
     /**
-     * <p>The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.</p>
+     * <p>The response body from the API operation. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
      * @public
      */
     responseBody?: Record<string, ContentBody>;
@@ -228,7 +228,7 @@ export interface ApiResult {
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
- *                <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a>
+ *                <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -246,7 +246,7 @@ export interface FunctionResult {
      */
     function?: string;
     /**
-     * <p>The response from the function call using the parameters. The response may be returned directly or from the Lambda function.</p>
+     * <p>The response from the function call using the parameters. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
      * @public
      */
     responseBody?: Record<string, ContentBody>;
@@ -257,12 +257,12 @@ export interface FunctionResult {
     responseState?: ResponseState;
 }
 /**
- * <p>A result from the action group invocation.</p>
+ * <p>A result from the invocation of an action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -322,12 +322,15 @@ export interface SessionState {
      */
     promptSessionAttributes?: Record<string, string>;
     /**
-     * <p>Contains information about the results from the action group invocation.</p>
+     * <p>Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
+     *          <note>
+     *             <p>If you include this field, the <code>inputText</code> field will be ignored.</p>
+     *          </note>
      * @public
      */
     returnControlInvocationResults?: InvocationResultMember[];
     /**
-     * <p>The identifier of the invocation.</p>
+     * <p>The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeAgent</code> response for the action whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
      * @public
      */
     invocationId?: string;
@@ -338,6 +341,9 @@ export interface SessionState {
 export interface InvokeAgentRequest {
     /**
      * <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>
+     *          <note>
+     *             <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
+     *          </note>
      * @public
      */
     sessionState?: SessionState;
@@ -368,6 +374,9 @@ export interface InvokeAgentRequest {
     enableTrace?: boolean;
     /**
      * <p>The prompt text to send the agent.</p>
+     *          <note>
+     *             <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
+     *          </note>
      * @public
      */
     inputText?: string;
@@ -382,7 +391,7 @@ export interface InvokeAgentRequest {
  *             </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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>span</code> field</p>
  *             </li>
  *          </ul>
  * @public
@@ -409,7 +418,7 @@ export interface Span {
  *             </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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>textResponsePart</code> field</p>
  *             </li>
  *          </ul>
  * @public
@@ -432,7 +441,7 @@ export interface TextResponsePart {
  *          <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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>generatedResponsePart</code> field</p>
  *             </li>
  *             <li>
  *                <p>
@@ -462,7 +471,7 @@ export interface GeneratedResponsePart {
  *             </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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>content</code> field</p>
  *             </li>
  *          </ul>
  * @public
@@ -488,7 +497,7 @@ export interface RetrievalResultContent {
  *             </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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>s3Location</code> field</p>
  *             </li>
  *          </ul>
  * @public
@@ -525,7 +534,7 @@ export type RetrievalResultLocationType = (typeof RetrievalResultLocationType)[k
  *             </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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>locatino</code> field</p>
  *             </li>
  *          </ul>
  * @public
@@ -552,7 +561,7 @@ export interface RetrievalResultLocation {
  *             </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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>retrievedReferences</code> field</p>
  *             </li>
  *          </ul>
  * @public
@@ -580,7 +589,7 @@ export interface RetrievedReference {
  *          <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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>citations</code> field</p>
  *             </li>
  *             <li>
  *                <p>
@@ -646,7 +655,7 @@ export declare class ResourceNotFoundException extends __BaseException {
  *          <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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -686,7 +695,7 @@ export interface PropertyParameters {
  *          <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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -704,7 +713,7 @@ export interface ApiRequestBody {
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
- *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
+ *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -742,7 +751,7 @@ export interface ApiInvocationInput {
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
- *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
+ *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -770,7 +779,7 @@ export interface FunctionParameter {
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
- *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
+ *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -794,11 +803,11 @@ export interface FunctionInvocationInput {
     function?: string;
 }
 /**
- * <p>Contains details about the API operation or function that the agent predicts should be called.</p>
+ * <p>Contains details about the API operation or function that the agent predicts should be called. </p>
  *          <p>This data type is used in the following API operations:</p>
  *          <ul>
  *             <li>
- *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
+ *                <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -848,7 +857,7 @@ export declare namespace InvocationInputMember {
  *          <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>
+ *                   <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
  *                </p>
  *             </li>
  *          </ul>
@@ -1883,6 +1892,72 @@ export interface RetrieveAndGenerateInput {
      */
     text: string | undefined;
 }
+/**
+ * <p>The configuration details for the guardrail.</p>
+ * @public
+ */
+export interface GuardrailConfiguration {
+    /**
+     * <p>The unique identifier for the guardrail.</p>
+     * @public
+     */
+    guardrailId: string | undefined;
+    /**
+     * <p>The version of the guardrail.</p>
+     * @public
+     */
+    guardrailVersion: string | undefined;
+}
+/**
+ * <p>Configuration settings for text generation using a language model via the
+ *       RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token
+ *       count, and stop sequences. </p>
+ *          <note>
+ *             <p>The valid range of <code>maxTokens</code> depends on the accepted values for your chosen
+ *         model's inference parameters. To see the inference parameters for your model, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference
+ *           parameters for foundation models.</a>
+ *             </p>
+ *          </note>
+ * @public
+ */
+export interface TextInferenceConfig {
+    /**
+     * <p> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.  </p>
+     * @public
+     */
+    temperature?: number;
+    /**
+     * <p> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </p>
+     * @public
+     */
+    topP?: number;
+    /**
+     * <p>The maximum number of tokens to generate in the output text. Do not use the minimum of 0
+     *       or the maximum of 65536. The limit values described here are arbitary values, for actual
+     *       values consult the limits defined by your specific model.</p>
+     * @public
+     */
+    maxTokens?: number;
+    /**
+     * <p>A list of sequences of characters that, if generated, will cause the model to stop
+     *       generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The
+     *       limit values described here are arbitary values, for actual values consult the limits defined
+     *       by your specific model.</p>
+     * @public
+     */
+    stopSequences?: string[];
+}
+/**
+ * <p> The configuration for inference settings when generating responses using RetrieveAndGenerate. </p>
+ * @public
+ */
+export interface InferenceConfig {
+    /**
+     * <p> Configuration settings specific to text generation while generating responses using RetrieveAndGenerate. </p>
+     * @public
+     */
+    textInferenceConfig?: TextInferenceConfig;
+}
 /**
  * <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>
@@ -1924,6 +1999,21 @@ export interface ExternalSourcesGenerationConfiguration {
      * @public
      */
     promptTemplate?: PromptTemplate;
+    /**
+     * <p>The configuration details for the guardrail.</p>
+     * @public
+     */
+    guardrailConfiguration?: GuardrailConfiguration;
+    /**
+     * <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.</p>
+     * @public
+     */
+    inferenceConfig?: InferenceConfig;
+    /**
+     * <p> Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used. </p>
+     * @public
+     */
+    additionalModelRequestFields?: Record<string, __DocumentType>;
 }
 /**
  * <p>This property contains the document to chat with, along with its attributes.</p>
@@ -2029,6 +2119,21 @@ export interface GenerationConfiguration {
      * @public
      */
     promptTemplate?: PromptTemplate;
+    /**
+     * <p>The configuration details for the guardrail.</p>
+     * @public
+     */
+    guardrailConfiguration?: GuardrailConfiguration;
+    /**
+     * <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
+     * @public
+     */
+    inferenceConfig?: InferenceConfig;
+    /**
+     * <p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>
+     * @public
+     */
+    additionalModelRequestFields?: Record<string, __DocumentType>;
 }
 /**
  * <p>Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
@@ -2096,6 +2201,18 @@ export interface RetrieveAndGenerateSessionConfiguration {
      */
     kmsKeyArn: string | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const GuadrailAction: {
+    readonly INTERVENED: "INTERVENED";
+    readonly NONE: "NONE";
+};
+/**
+ * @public
+ */
+export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction];
 /**
  * <p>Contains the response generated from querying the knowledge base.</p>
  *          <p>This data type is used in the following API operations:</p>
@@ -2133,6 +2250,11 @@ export interface RetrieveAndGenerateResponse {
      * @public
      */
     citations?: Citation[];
+    /**
+     * <p>Specifies if there is a guardrail intervention in the response.</p>
+     * @public
+     */
+    guardrailAction?: GuadrailAction;
 }
 /**
  * <p>Contains the query made to the knowledge base.</p>

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

@@ -746,11 +746,27 @@ export interface InvokeAgentResponse {
 export interface RetrieveAndGenerateInput {
   text: string | undefined;
 }
+export interface GuardrailConfiguration {
+  guardrailId: string | undefined;
+  guardrailVersion: string | undefined;
+}
+export interface TextInferenceConfig {
+  temperature?: number;
+  topP?: number;
+  maxTokens?: number;
+  stopSequences?: string[];
+}
+export interface InferenceConfig {
+  textInferenceConfig?: TextInferenceConfig;
+}
 export interface PromptTemplate {
   textPromptTemplate?: string;
 }
 export interface ExternalSourcesGenerationConfiguration {
   promptTemplate?: PromptTemplate;
+  guardrailConfiguration?: GuardrailConfiguration;
+  inferenceConfig?: InferenceConfig;
+  additionalModelRequestFields?: Record<string, __DocumentType>;
 }
 export interface ByteContentDoc {
   identifier: string | undefined;
@@ -778,6 +794,9 @@ export interface ExternalSourcesRetrieveAndGenerateConfiguration {
 }
 export interface GenerationConfiguration {
   promptTemplate?: PromptTemplate;
+  guardrailConfiguration?: GuardrailConfiguration;
+  inferenceConfig?: InferenceConfig;
+  additionalModelRequestFields?: Record<string, __DocumentType>;
 }
 export interface FilterAttribute {
   key: string | undefined;
@@ -797,6 +816,12 @@ export type RetrieveAndGenerateType =
 export interface RetrieveAndGenerateSessionConfiguration {
   kmsKeyArn: string | undefined;
 }
+export declare const GuadrailAction: {
+  readonly INTERVENED: "INTERVENED";
+  readonly NONE: "NONE";
+};
+export type GuadrailAction =
+  (typeof GuadrailAction)[keyof typeof GuadrailAction];
 export interface RetrieveAndGenerateOutput {
   text: string | undefined;
 }
@@ -804,6 +829,7 @@ export interface RetrieveAndGenerateResponse {
   sessionId: string | undefined;
   output: RetrieveAndGenerateOutput | undefined;
   citations?: Citation[];
+  guardrailAction?: GuadrailAction;
 }
 export interface KnowledgeBaseQuery {
   text: string | undefined;

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.572.0",
+  "version": "3.574.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent-runtime",
@@ -20,8 +20,8 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sso-oidc": "3.572.0",
-    "@aws-sdk/client-sts": "3.572.0",
+    "@aws-sdk/client-sso-oidc": "3.574.0",
+    "@aws-sdk/client-sts": "3.574.0",
     "@aws-sdk/core": "3.572.0",
     "@aws-sdk/credential-provider-node": "3.572.0",
     "@aws-sdk/middleware-host-header": "3.567.0",