@aws-sdk/client-bedrock-runtime 3.686.0 → 3.687.0

package/dist-cjs/index.js

@@ -32,9 +32,11 @@ __export(src_exports, {
   ConversationRole: () => ConversationRole,
   ConverseCommand: () => ConverseCommand,
   ConverseOutput: () => ConverseOutput,
+  ConverseRequestFilterSensitiveLog: () => ConverseRequestFilterSensitiveLog,
   ConverseStreamCommand: () => ConverseStreamCommand,
   ConverseStreamOutput: () => ConverseStreamOutput,
   ConverseStreamOutputFilterSensitiveLog: () => ConverseStreamOutputFilterSensitiveLog,
+  ConverseStreamRequestFilterSensitiveLog: () => ConverseStreamRequestFilterSensitiveLog,
   ConverseStreamResponseFilterSensitiveLog: () => ConverseStreamResponseFilterSensitiveLog,
   DocumentFormat: () => DocumentFormat,
   DocumentSource: () => DocumentSource,
@@ -72,6 +74,7 @@ __export(src_exports, {
   ModelStreamErrorException: () => ModelStreamErrorException,
   ModelTimeoutException: () => ModelTimeoutException,
   PayloadPartFilterSensitiveLog: () => PayloadPartFilterSensitiveLog,
+  PromptVariableValues: () => PromptVariableValues,
   ResourceNotFoundException: () => ResourceNotFoundException,
   ResponseStream: () => ResponseStream,
   ResponseStreamFilterSensitiveLog: () => ResponseStreamFilterSensitiveLog,
@@ -552,6 +555,14 @@ var ConversationRole = {
   ASSISTANT: "assistant",
   USER: "user"
 };
+var PromptVariableValues;
+((PromptVariableValues3) => {
+  PromptVariableValues3.visit = /* @__PURE__ */ __name((value, visitor) => {
+    if (value.text !== void 0)
+      return visitor.text(value.text);
+    return visitor._(value.$unknown[0], value.$unknown[1]);
+  }, "visit");
+})(PromptVariableValues || (PromptVariableValues = {}));
 var SystemContentBlock;
 ((SystemContentBlock3) => {
   SystemContentBlock3.visit = /* @__PURE__ */ __name((value, visitor) => {
@@ -770,6 +781,20 @@ var ResponseStream;
     return visitor._(value.$unknown[0], value.$unknown[1]);
   }, "visit");
 })(ResponseStream || (ResponseStream = {}));
+var ConverseRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.messages && { messages: obj.messages.map((item) => item) },
+  ...obj.system && { system: obj.system.map((item) => item) },
+  ...obj.toolConfig && { toolConfig: obj.toolConfig },
+  ...obj.promptVariables && { promptVariables: import_smithy_client.SENSITIVE_STRING }
+}), "ConverseRequestFilterSensitiveLog");
+var ConverseStreamRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
+  ...obj,
+  ...obj.messages && { messages: obj.messages.map((item) => item) },
+  ...obj.system && { system: obj.system.map((item) => item) },
+  ...obj.toolConfig && { toolConfig: obj.toolConfig },
+  ...obj.promptVariables && { promptVariables: import_smithy_client.SENSITIVE_STRING }
+}), "ConverseStreamRequestFilterSensitiveLog");
 var ConverseStreamOutputFilterSensitiveLog = /* @__PURE__ */ __name((obj) => {
   if (obj.messageStart !== void 0)
     return { messageStart: obj.messageStart };
@@ -873,6 +898,7 @@ var se_ConverseCommand = /* @__PURE__ */ __name(async (input, context) => {
       guardrailConfig: (_) => (0, import_smithy_client._json)(_),
       inferenceConfig: (_) => se_InferenceConfiguration(_, context),
       messages: (_) => se_Messages(_, context),
+      promptVariables: (_) => (0, import_smithy_client._json)(_),
       system: (_) => (0, import_smithy_client._json)(_),
       toolConfig: (_) => se_ToolConfiguration(_, context)
     })
@@ -895,6 +921,7 @@ var se_ConverseStreamCommand = /* @__PURE__ */ __name(async (input, context) =>
       guardrailConfig: (_) => (0, import_smithy_client._json)(_),
       inferenceConfig: (_) => se_InferenceConfiguration(_, context),
       messages: (_) => se_Messages(_, context),
+      promptVariables: (_) => (0, import_smithy_client._json)(_),
       system: (_) => (0, import_smithy_client._json)(_),
       toolConfig: (_) => se_ToolConfiguration(_, context)
     })
@@ -1774,7 +1801,7 @@ var _ConverseCommand = class _ConverseCommand extends import_smithy_client.Comma
     (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
     (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
   ];
-}).s("AmazonBedrockFrontendService", "Converse", {}).n("BedrockRuntimeClient", "ConverseCommand").f(void 0, void 0).ser(se_ConverseCommand).de(de_ConverseCommand).build() {
+}).s("AmazonBedrockFrontendService", "Converse", {}).n("BedrockRuntimeClient", "ConverseCommand").f(ConverseRequestFilterSensitiveLog, void 0).ser(se_ConverseCommand).de(de_ConverseCommand).build() {
 };
 __name(_ConverseCommand, "ConverseCommand");
 var ConverseCommand = _ConverseCommand;
@@ -1795,7 +1822,7 @@ var _ConverseStreamCommand = class _ConverseStreamCommand extends import_smithy_
   eventStream: {
     output: true
   }
-}).n("BedrockRuntimeClient", "ConverseStreamCommand").f(void 0, ConverseStreamResponseFilterSensitiveLog).ser(se_ConverseStreamCommand).de(de_ConverseStreamCommand).build() {
+}).n("BedrockRuntimeClient", "ConverseStreamCommand").f(ConverseStreamRequestFilterSensitiveLog, ConverseStreamResponseFilterSensitiveLog).ser(se_ConverseStreamCommand).de(de_ConverseStreamCommand).build() {
 };
 __name(_ConverseStreamCommand, "ConverseStreamCommand");
 var ConverseStreamCommand = _ConverseStreamCommand;
@@ -1894,6 +1921,7 @@ var BedrockRuntime = _BedrockRuntime;
   ToolResultStatus,
   ContentBlock,
   ConversationRole,
+  PromptVariableValues,
   SystemContentBlock,
   ToolChoice,
   ToolInputSchema,
@@ -1911,6 +1939,8 @@ var BedrockRuntime = _BedrockRuntime;
   ConverseStreamOutput,
   Trace,
   ResponseStream,
+  ConverseRequestFilterSensitiveLog,
+  ConverseStreamRequestFilterSensitiveLog,
   ConverseStreamOutputFilterSensitiveLog,
   ConverseStreamResponseFilterSensitiveLog,
   InvokeModelRequestFilterSensitiveLog,

package/dist-es/commands/ConverseCommand.js

@@ -2,6 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { commonParams } from "../endpoint/EndpointParameters";
+import { ConverseRequestFilterSensitiveLog } from "../models/models_0";
 import { de_ConverseCommand, se_ConverseCommand } from "../protocols/Aws_restJson1";
 export { $Command };
 export class ConverseCommand extends $Command
@@ -15,7 +16,7 @@ export class ConverseCommand extends $Command
 })
     .s("AmazonBedrockFrontendService", "Converse", {})
     .n("BedrockRuntimeClient", "ConverseCommand")
-    .f(void 0, void 0)
+    .f(ConverseRequestFilterSensitiveLog, void 0)
     .ser(se_ConverseCommand)
     .de(de_ConverseCommand)
     .build() {

package/dist-es/commands/ConverseStreamCommand.js

@@ -2,7 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
 import { getSerdePlugin } from "@smithy/middleware-serde";
 import { Command as $Command } from "@smithy/smithy-client";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { ConverseStreamResponseFilterSensitiveLog, } from "../models/models_0";
+import { ConverseStreamRequestFilterSensitiveLog, ConverseStreamResponseFilterSensitiveLog, } from "../models/models_0";
 import { de_ConverseStreamCommand, se_ConverseStreamCommand } from "../protocols/Aws_restJson1";
 export { $Command };
 export class ConverseStreamCommand extends $Command
@@ -20,7 +20,7 @@ export class ConverseStreamCommand extends $Command
     },
 })
     .n("BedrockRuntimeClient", "ConverseStreamCommand")
-    .f(void 0, ConverseStreamResponseFilterSensitiveLog)
+    .f(ConverseStreamRequestFilterSensitiveLog, ConverseStreamResponseFilterSensitiveLog)
     .ser(se_ConverseStreamCommand)
     .de(de_ConverseStreamCommand)
     .build() {

package/dist-es/models/models_0.js

@@ -263,6 +263,14 @@ export const ConversationRole = {
     ASSISTANT: "assistant",
     USER: "user",
 };
+export var PromptVariableValues;
+(function (PromptVariableValues) {
+    PromptVariableValues.visit = (value, visitor) => {
+        if (value.text !== undefined)
+            return visitor.text(value.text);
+        return visitor._(value.$unknown[0], value.$unknown[1]);
+    };
+})(PromptVariableValues || (PromptVariableValues = {}));
 export var SystemContentBlock;
 (function (SystemContentBlock) {
     SystemContentBlock.visit = (value, visitor) => {
@@ -456,6 +464,20 @@ export var ResponseStream;
         return visitor._(value.$unknown[0], value.$unknown[1]);
     };
 })(ResponseStream || (ResponseStream = {}));
+export const ConverseRequestFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.messages && { messages: obj.messages.map((item) => item) }),
+    ...(obj.system && { system: obj.system.map((item) => item) }),
+    ...(obj.toolConfig && { toolConfig: obj.toolConfig }),
+    ...(obj.promptVariables && { promptVariables: SENSITIVE_STRING }),
+});
+export const ConverseStreamRequestFilterSensitiveLog = (obj) => ({
+    ...obj,
+    ...(obj.messages && { messages: obj.messages.map((item) => item) }),
+    ...(obj.system && { system: obj.system.map((item) => item) }),
+    ...(obj.toolConfig && { toolConfig: obj.toolConfig }),
+    ...(obj.promptVariables && { promptVariables: SENSITIVE_STRING }),
+});
 export const ConverseStreamOutputFilterSensitiveLog = (obj) => {
     if (obj.messageStart !== undefined)
         return { messageStart: obj.messageStart };

package/dist-es/protocols/Aws_restJson1.js

@@ -33,6 +33,7 @@ export const se_ConverseCommand = async (input, context) => {
         guardrailConfig: (_) => _json(_),
         inferenceConfig: (_) => se_InferenceConfiguration(_, context),
         messages: (_) => se_Messages(_, context),
+        promptVariables: (_) => _json(_),
         system: (_) => _json(_),
         toolConfig: (_) => se_ToolConfiguration(_, context),
     }));
@@ -53,6 +54,7 @@ export const se_ConverseStreamCommand = async (input, context) => {
         guardrailConfig: (_) => _json(_),
         inferenceConfig: (_) => se_InferenceConfiguration(_, context),
         messages: (_) => se_Messages(_, context),
+        promptVariables: (_) => _json(_),
         system: (_) => _json(_),
         toolConfig: (_) => se_ToolConfiguration(_, context),
     }));

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

@@ -33,6 +33,8 @@ declare const ConverseCommand_base: {
  *          If a model has unique inference parameters, you can also pass those unique parameters
  *          to the model.</p>
  *          <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p>
+ *          <p>You can submit a prompt by including it in the <code>messages</code> field, specifying the <code>modelId</code> of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.</p>
+ *          <p>You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the <code>promptVariables</code> field. You can append more messages to the prompt by using the <code>messages</code> field. If you use a prompt from Prompt management, you can't include the following fields in the request: <code>additionalModelRequestFields</code>, <code>inferenceConfig</code>, <code>system</code>, or <code>toolConfig</code>. Instead, these fields must be defined through Prompt management. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html">Use a prompt from Prompt management</a>.</p>
  *          <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  *             To use a guardrail, see  <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  *             To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
@@ -48,7 +50,7 @@ declare const ConverseCommand_base: {
  * const client = new BedrockRuntimeClient(config);
  * const input = { // ConverseRequest
  *   modelId: "STRING_VALUE", // required
- *   messages: [ // Messages // required
+ *   messages: [ // Messages
  *     { // Message
  *       role: "user" || "assistant", // required
  *       content: [ // ContentBlocks // required
@@ -154,6 +156,11 @@ declare const ConverseCommand_base: {
  *     trace: "enabled" || "disabled",
  *   },
  *   additionalModelRequestFields: "DOCUMENT_VALUE",
+ *   promptVariables: { // PromptVariableMap
+ *     "<keys>": { // PromptVariableValues Union: only one key present
+ *       text: "STRING_VALUE",
+ *     },
+ *   },
  *   additionalModelResponseFieldPaths: [ // AdditionalModelResponseFieldPaths
  *     "STRING_VALUE",
  *   ],

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

@@ -39,6 +39,8 @@ declare const ConverseStreamCommand_base: {
  *             <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>ConverseStream</code>.</p>
  *          </note>
  *          <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p>
+ *          <p>You can submit a prompt by including it in the <code>messages</code> field, specifying the <code>modelId</code> of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.</p>
+ *          <p>You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the <code>promptVariables</code> field. You can append more messages to the prompt by using the <code>messages</code> field. If you use a prompt from Prompt management, you can't include the following fields in the request: <code>additionalModelRequestFields</code>, <code>inferenceConfig</code>, <code>system</code>, or <code>toolConfig</code>. Instead, these fields must be defined through Prompt management. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html">Use a prompt from Prompt management</a>.</p>
  *          <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  *          To use a guardrail, see  <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  *          To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
@@ -54,7 +56,7 @@ declare const ConverseStreamCommand_base: {
  * const client = new BedrockRuntimeClient(config);
  * const input = { // ConverseStreamRequest
  *   modelId: "STRING_VALUE", // required
- *   messages: [ // Messages // required
+ *   messages: [ // Messages
  *     { // Message
  *       role: "user" || "assistant", // required
  *       content: [ // ContentBlocks // required
@@ -161,6 +163,11 @@ declare const ConverseStreamCommand_base: {
  *     streamProcessingMode: "sync" || "async",
  *   },
  *   additionalModelRequestFields: "DOCUMENT_VALUE",
+ *   promptVariables: { // PromptVariableMap
+ *     "<keys>": { // PromptVariableValues Union: only one key present
+ *       text: "STRING_VALUE",
+ *     },
+ *   },
  *   additionalModelResponseFieldPaths: [ // AdditionalModelResponseFieldPaths
  *     "STRING_VALUE",
  *   ],

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

@@ -12,7 +12,7 @@ export { $Command };
  * @public
  */
 export type InvokeModelCommandInputType = Omit<InvokeModelRequest, "body"> & {
-    body: BlobPayloadInputTypes;
+    body?: BlobPayloadInputTypes;
 };
 /**
  * @public
@@ -52,7 +52,7 @@ declare const InvokeModelCommand_base: {
  * // const { BedrockRuntimeClient, InvokeModelCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
  * const client = new BedrockRuntimeClient(config);
  * const input = { // InvokeModelRequest
- *   body: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ *   body: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  *   contentType: "STRING_VALUE",
  *   accept: "STRING_VALUE",
  *   modelId: "STRING_VALUE", // required

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

@@ -11,7 +11,7 @@ export { $Command };
  * @public
  */
 export type InvokeModelWithResponseStreamCommandInputType = Omit<InvokeModelWithResponseStreamRequest, "body"> & {
-    body: BlobPayloadInputTypes;
+    body?: BlobPayloadInputTypes;
 };
 /**
  * @public
@@ -50,7 +50,7 @@ declare const InvokeModelWithResponseStreamCommand_base: {
  * // const { BedrockRuntimeClient, InvokeModelWithResponseStreamCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
  * const client = new BedrockRuntimeClient(config);
  * const input = { // InvokeModelWithResponseStreamRequest
- *   body: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")   // required
+ *   body: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
  *   contentType: "STRING_VALUE",
  *   accept: "STRING_VALUE",
  *   modelId: "STRING_VALUE", // required

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

@@ -1322,6 +1322,36 @@ export interface Message {
      */
     content: ContentBlock[] | undefined;
 }
+/**
+ * <p>Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-how.html">How Prompt management works</a>.</p>
+ * @public
+ */
+export type PromptVariableValues = PromptVariableValues.TextMember | PromptVariableValues.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace PromptVariableValues {
+    /**
+     * <p>The text value that the variable maps to.</p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: string) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: PromptVariableValues, visitor: Visitor<T>) => T;
+}
 /**
  * <p>A system content block.</p>
  * @public
@@ -1556,8 +1586,7 @@ export interface ToolConfiguration {
  */
 export interface ConverseRequest {
     /**
-     * <p>The identifier for the model that you want to call.</p>
-     *          <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
+     * <p>Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:</p>
      *          <ul>
      *             <li>
      *                <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
@@ -1571,6 +1600,9 @@ export interface ConverseRequest {
      *             <li>
      *                <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
      *             </li>
+     *             <li>
+     *                <p>To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.</p>
+     *             </li>
      *          </ul>
      *          <p>The Converse API doesn't support <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported models</a>.</p>
      * @public
@@ -1580,14 +1612,14 @@ export interface ConverseRequest {
      * <p>The messages that you want to send to the model.</p>
      * @public
      */
-    messages: Message[] | undefined;
+    messages?: Message[];
     /**
-     * <p>A system prompt to pass to the model.</p>
+     * <p>A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.</p>
      * @public
      */
     system?: SystemContentBlock[];
     /**
-     * <p>Inference parameters to pass to the model. <code>Converse</code> supports a base
+     * <p>Inference parameters to pass to the model. <code>Converse</code> and <code>ConverseStream</code> support a base
      *          set of inference parameters. If you need to pass additional parameters that the model
      *          supports, use the <code>additionalModelRequestFields</code> request field.</p>
      * @public
@@ -1602,20 +1634,25 @@ export interface ConverseRequest {
      */
     toolConfig?: ToolConfiguration;
     /**
-     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * <p>Configuration information for a guardrail that you want to use in the request. If you include <code>guardContent</code> blocks in the <code>content</code> field in the <code>messages</code> field, the guardrail operates only on those messages. If you include no <code>guardContent</code> blocks, the guardrail operates on all messages in the request body and in any included prompt resource.</p>
      * @public
      */
     guardrailConfig?: GuardrailConfiguration;
     /**
      * <p>Additional inference parameters that the model supports, beyond the
-     *          base set of inference parameters that <code>Converse</code> supports in the <code>inferenceConfig</code>
+     *          base set of inference parameters that <code>Converse</code> and <code>ConverseStream</code> support in the <code>inferenceConfig</code>
      *          field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Model parameters</a>.</p>
      * @public
      */
     additionalModelRequestFields?: __DocumentType;
+    /**
+     * <p>Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the <code>modelId</code> field.</p>
+     * @public
+     */
+    promptVariables?: Record<string, PromptVariableValues>;
     /**
      * <p>Additional model parameters field paths to return in the
-     *          response. <code>Converse</code> returns the requested fields as a JSON Pointer object in the
+     *          response. <code>Converse</code> and <code>ConverseStream</code> return the requested fields as a JSON Pointer object in the
      *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
      *          <p>
      *             <code>[
@@ -1623,9 +1660,9 @@ export interface ConverseRequest {
      *          ]</code>
      *          </p>
      *          <p>For information about the JSON Pointer syntax, see the
-     *          <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
+     *         <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
      *          <p>
-     *             <code>Converse</code> rejects an empty JSON Pointer or incorrectly structured
+     *             <code>Converse</code> and <code>ConverseStream</code> reject an empty JSON Pointer or incorrectly structured
      *          JSON Pointer with a <code>400</code> error code. if the JSON Pointer is valid, but the requested
      *          field is not in the model response, it is ignored by <code>Converse</code>.</p>
      * @public
@@ -1887,8 +1924,7 @@ export interface GuardrailStreamConfiguration {
  */
 export interface ConverseStreamRequest {
     /**
-     * <p>The ID for the model.</p>
-     *          <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
+     * <p>Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:</p>
      *          <ul>
      *             <li>
      *                <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
@@ -1902,6 +1938,9 @@ export interface ConverseStreamRequest {
      *             <li>
      *                <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
      *             </li>
+     *             <li>
+     *                <p>To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.</p>
+     *             </li>
      *          </ul>
      *          <p>The Converse API doesn't support <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported models</a>.</p>
      * @public
@@ -1911,14 +1950,14 @@ export interface ConverseStreamRequest {
      * <p>The messages that you want to send to the model.</p>
      * @public
      */
-    messages: Message[] | undefined;
+    messages?: Message[];
     /**
-     * <p>A system prompt to send to the model.</p>
+     * <p>A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.</p>
      * @public
      */
     system?: SystemContentBlock[];
     /**
-     * <p>Inference parameters to pass to the model. <code>ConverseStream</code> supports a base
+     * <p>Inference parameters to pass to the model. <code>Converse</code> and <code>ConverseStream</code> support a base
      *          set of inference parameters. If you need to pass additional parameters that the model
      *          supports, use the <code>additionalModelRequestFields</code> request field.</p>
      * @public
@@ -1933,20 +1972,25 @@ export interface ConverseStreamRequest {
      */
     toolConfig?: ToolConfiguration;
     /**
-     * <p>Configuration information for a guardrail that you want to use in the request. </p>
+     * <p>Configuration information for a guardrail that you want to use in the request. If you include <code>guardContent</code> blocks in the <code>content</code> field in the <code>messages</code> field, the guardrail operates only on those messages. If you include no <code>guardContent</code> blocks, the guardrail operates on all messages in the request body and in any included prompt resource.</p>
      * @public
      */
     guardrailConfig?: GuardrailStreamConfiguration;
     /**
      * <p>Additional inference parameters that the model supports, beyond the
-     *          base set of inference parameters that <code>ConverseStream</code> supports in the <code>inferenceConfig</code>
-     *          field.</p>
+     *          base set of inference parameters that <code>Converse</code> and <code>ConverseStream</code> support in the <code>inferenceConfig</code>
+     *          field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Model parameters</a>.</p>
      * @public
      */
     additionalModelRequestFields?: __DocumentType;
+    /**
+     * <p>Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the <code>modelId</code> field.</p>
+     * @public
+     */
+    promptVariables?: Record<string, PromptVariableValues>;
     /**
      * <p>Additional model parameters field paths to return in the
-     *          response. <code>ConverseStream</code> returns the requested fields as a JSON Pointer object in the
+     *          response. <code>Converse</code> and <code>ConverseStream</code> return the requested fields as a JSON Pointer object in the
      *          <code>additionalModelResponseFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
      *          <p>
      *             <code>[
@@ -1954,11 +1998,11 @@ export interface ConverseStreamRequest {
      *          ]</code>
      *          </p>
      *          <p>For information about the JSON Pointer syntax, see the
-     *          <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
+     *         <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
      *          <p>
-     *             <code>ConverseStream</code> rejects an empty JSON Pointer or incorrectly structured
+     *             <code>Converse</code> and <code>ConverseStream</code> reject an empty JSON Pointer or incorrectly structured
      *          JSON Pointer with a <code>400</code> error code. if the JSON Pointer is valid, but the requested
-     *          field is not in the model response, it is ignored by <code>ConverseStream</code>.</p>
+     *          field is not in the model response, it is ignored by <code>Converse</code>.</p>
      * @public
      */
     additionalModelResponseFieldPaths?: string[];
@@ -2467,7 +2511,7 @@ export interface InvokeModelRequest {
      * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
      * @public
      */
-    body: Uint8Array | undefined;
+    body?: Uint8Array;
     /**
      * <p>The MIME type of the input data in the request. You must specify
      *             <code>application/json</code>.</p>
@@ -2551,7 +2595,7 @@ export interface InvokeModelWithResponseStreamRequest {
      * <p>The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.</p>
      * @public
      */
-    body: Uint8Array | undefined;
+    body?: Uint8Array;
     /**
      * <p>The MIME type of the input data in the request. You must specify
      *             <code>application/json</code>.</p>
@@ -2771,6 +2815,14 @@ export interface InvokeModelWithResponseStreamResponse {
      */
     contentType: string | undefined;
 }
+/**
+ * @internal
+ */
+export declare const ConverseRequestFilterSensitiveLog: (obj: ConverseRequest) => any;
+/**
+ * @internal
+ */
+export declare const ConverseStreamRequestFilterSensitiveLog: (obj: ConverseStreamRequest) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/commands/InvokeModelCommand.d.ts

@@ -16,7 +16,7 @@ export type InvokeModelCommandInputType = Pick<
   InvokeModelRequest,
   Exclude<keyof InvokeModelRequest, "body">
 > & {
-  body: BlobPayloadInputTypes;
+  body?: BlobPayloadInputTypes;
 };
 export interface InvokeModelCommandInput extends InvokeModelCommandInputType {}
 export type InvokeModelCommandOutputType = Pick<

package/dist-types/ts3.4/commands/InvokeModelWithResponseStreamCommand.d.ts

@@ -18,7 +18,7 @@ export type InvokeModelWithResponseStreamCommandInputType = Pick<
   InvokeModelWithResponseStreamRequest,
   Exclude<keyof InvokeModelWithResponseStreamRequest, "body">
 > & {
-  body: BlobPayloadInputTypes;
+  body?: BlobPayloadInputTypes;
 };
 export interface InvokeModelWithResponseStreamCommandInput
   extends InvokeModelWithResponseStreamCommandInputType {}

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

@@ -558,6 +558,24 @@ export interface Message {
   role: ConversationRole | undefined;
   content: ContentBlock[] | undefined;
 }
+export type PromptVariableValues =
+  | PromptVariableValues.TextMember
+  | PromptVariableValues.$UnknownMember;
+export declare namespace PromptVariableValues {
+  interface TextMember {
+    text: string;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    text?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    text: (value: string) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: PromptVariableValues, visitor: Visitor<T>) => T;
+}
 export type SystemContentBlock =
   | SystemContentBlock.GuardContentMember
   | SystemContentBlock.TextMember
@@ -673,12 +691,13 @@ export interface ToolConfiguration {
 }
 export interface ConverseRequest {
   modelId: string | undefined;
-  messages: Message[] | undefined;
+  messages?: Message[];
   system?: SystemContentBlock[];
   inferenceConfig?: InferenceConfiguration;
   toolConfig?: ToolConfiguration;
   guardrailConfig?: GuardrailConfiguration;
   additionalModelRequestFields?: __DocumentType;
+  promptVariables?: Record<string, PromptVariableValues>;
   additionalModelResponseFieldPaths?: string[];
 }
 export interface ConverseMetrics {
@@ -777,12 +796,13 @@ export interface GuardrailStreamConfiguration {
 }
 export interface ConverseStreamRequest {
   modelId: string | undefined;
-  messages: Message[] | undefined;
+  messages?: Message[];
   system?: SystemContentBlock[];
   inferenceConfig?: InferenceConfiguration;
   toolConfig?: ToolConfiguration;
   guardrailConfig?: GuardrailStreamConfiguration;
   additionalModelRequestFields?: __DocumentType;
+  promptVariables?: Record<string, PromptVariableValues>;
   additionalModelResponseFieldPaths?: string[];
 }
 export interface ToolUseBlockDelta {
@@ -1082,7 +1102,7 @@ export declare const Trace: {
 };
 export type Trace = (typeof Trace)[keyof typeof Trace];
 export interface InvokeModelRequest {
-  body: Uint8Array | undefined;
+  body?: Uint8Array;
   contentType?: string;
   accept?: string;
   modelId: string | undefined;
@@ -1095,7 +1115,7 @@ export interface InvokeModelResponse {
   contentType: string | undefined;
 }
 export interface InvokeModelWithResponseStreamRequest {
-  body: Uint8Array | undefined;
+  body?: Uint8Array;
   contentType?: string;
   accept?: string;
   modelId: string | undefined;
@@ -1212,6 +1232,12 @@ export interface InvokeModelWithResponseStreamResponse {
   body: AsyncIterable<ResponseStream> | undefined;
   contentType: string | undefined;
 }
+export declare const ConverseRequestFilterSensitiveLog: (
+  obj: ConverseRequest
+) => any;
+export declare const ConverseStreamRequestFilterSensitiveLog: (
+  obj: ConverseStreamRequest
+) => any;
 export declare const ConverseStreamOutputFilterSensitiveLog: (
   obj: ConverseStreamOutput
 ) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-bedrock-runtime",
   "description": "AWS SDK for JavaScript Bedrock Runtime Client for Node.js, Browser and React Native",
-  "version": "3.686.0",
+  "version": "3.687.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-bedrock-runtime",
@@ -20,19 +20,19 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.686.0",
-    "@aws-sdk/client-sts": "3.686.0",
+    "@aws-sdk/client-sso-oidc": "3.687.0",
+    "@aws-sdk/client-sts": "3.687.0",
     "@aws-sdk/core": "3.686.0",
-    "@aws-sdk/credential-provider-node": "3.686.0",
+    "@aws-sdk/credential-provider-node": "3.687.0",
     "@aws-sdk/middleware-host-header": "3.686.0",
     "@aws-sdk/middleware-logger": "3.686.0",
     "@aws-sdk/middleware-recursion-detection": "3.686.0",
-    "@aws-sdk/middleware-user-agent": "3.686.0",
+    "@aws-sdk/middleware-user-agent": "3.687.0",
     "@aws-sdk/region-config-resolver": "3.686.0",
     "@aws-sdk/types": "3.686.0",
     "@aws-sdk/util-endpoints": "3.686.0",
     "@aws-sdk/util-user-agent-browser": "3.686.0",
-    "@aws-sdk/util-user-agent-node": "3.686.0",
+    "@aws-sdk/util-user-agent-node": "3.687.0",
     "@smithy/config-resolver": "^3.0.10",
     "@smithy/core": "^2.5.1",
     "@smithy/eventstream-serde-browser": "^3.0.11",