@aws-sdk/client-bedrock-runtime 3.686.0 → 3.691.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