@aws-sdk/client-bedrock-runtime 3.583.0 → 3.587.0

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

@@ -0,0 +1,208 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
+import { ConverseRequest, ConverseResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ConverseCommand}.
+ */
+export interface ConverseCommandInput extends ConverseRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ConverseCommand}.
+ */
+export interface ConverseCommandOutput extends ConverseResponse, __MetadataBearer {
+}
+declare const ConverseCommand_base: {
+    new (input: ConverseCommandInput): import("@smithy/smithy-client").CommandImpl<ConverseCommandInput, ConverseCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ConverseCommandInput): import("@smithy/smithy-client").CommandImpl<ConverseCommandInput, ConverseCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Sends messages to the specified Amazon Bedrock model. <code>Converse</code> provides
+ *          a consistent interface that works with all models that
+ *          support messages. This allows you to write code once and use it with different models.
+ *          Should a model have unique inference parameters, you can also pass those unique parameters
+ *          to the model. 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>
+ *          <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockRuntimeClient, ConverseCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
+ * // const { BedrockRuntimeClient, ConverseCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
+ * const client = new BedrockRuntimeClient(config);
+ * const input = { // ConverseRequest
+ *   modelId: "STRING_VALUE", // required
+ *   messages: [ // Messages // required
+ *     { // Message
+ *       role: "user" || "assistant", // required
+ *       content: [ // ContentBlocks // required
+ *         { // ContentBlock Union: only one key present
+ *           text: "STRING_VALUE",
+ *           image: { // ImageBlock
+ *             format: "png" || "jpeg" || "gif" || "webp", // required
+ *             source: { // ImageSource Union: only one key present
+ *               bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *             },
+ *           },
+ *           toolUse: { // ToolUseBlock
+ *             toolUseId: "STRING_VALUE", // required
+ *             name: "STRING_VALUE", // required
+ *             input: "DOCUMENT_VALUE", // required
+ *           },
+ *           toolResult: { // ToolResultBlock
+ *             toolUseId: "STRING_VALUE", // required
+ *             content: [ // ToolResultContentBlocks // required
+ *               { // ToolResultContentBlock Union: only one key present
+ *                 json: "DOCUMENT_VALUE",
+ *                 text: "STRING_VALUE",
+ *                 image: {
+ *                   format: "png" || "jpeg" || "gif" || "webp", // required
+ *                   source: {//  Union: only one key present
+ *                     bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *                   },
+ *                 },
+ *               },
+ *             ],
+ *             status: "success" || "error",
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   ],
+ *   system: [ // SystemContentBlocks
+ *     { // SystemContentBlock Union: only one key present
+ *       text: "STRING_VALUE",
+ *     },
+ *   ],
+ *   inferenceConfig: { // InferenceConfiguration
+ *     maxTokens: Number("int"),
+ *     temperature: Number("float"),
+ *     topP: Number("float"),
+ *     stopSequences: [ // NonEmptyStringList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   toolConfig: { // ToolConfiguration
+ *     tools: [ // Tools // required
+ *       { // Tool Union: only one key present
+ *         toolSpec: { // ToolSpecification
+ *           name: "STRING_VALUE", // required
+ *           description: "STRING_VALUE",
+ *           inputSchema: { // ToolInputSchema Union: only one key present
+ *             json: "DOCUMENT_VALUE",
+ *           },
+ *         },
+ *       },
+ *     ],
+ *     toolChoice: { // ToolChoice Union: only one key present
+ *       auto: {},
+ *       any: {},
+ *       tool: { // SpecificToolChoice
+ *         name: "STRING_VALUE", // required
+ *       },
+ *     },
+ *   },
+ *   additionalModelRequestFields: "DOCUMENT_VALUE",
+ *   additionalModelResponseFieldPaths: [ // AdditionalModelResponseFieldPaths
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new ConverseCommand(input);
+ * const response = await client.send(command);
+ * // { // ConverseResponse
+ * //   output: { // ConverseOutput Union: only one key present
+ * //     message: { // Message
+ * //       role: "user" || "assistant", // required
+ * //       content: [ // ContentBlocks // required
+ * //         { // ContentBlock Union: only one key present
+ * //           text: "STRING_VALUE",
+ * //           image: { // ImageBlock
+ * //             format: "png" || "jpeg" || "gif" || "webp", // required
+ * //             source: { // ImageSource Union: only one key present
+ * //               bytes: new Uint8Array(),
+ * //             },
+ * //           },
+ * //           toolUse: { // ToolUseBlock
+ * //             toolUseId: "STRING_VALUE", // required
+ * //             name: "STRING_VALUE", // required
+ * //             input: "DOCUMENT_VALUE", // required
+ * //           },
+ * //           toolResult: { // ToolResultBlock
+ * //             toolUseId: "STRING_VALUE", // required
+ * //             content: [ // ToolResultContentBlocks // required
+ * //               { // ToolResultContentBlock Union: only one key present
+ * //                 json: "DOCUMENT_VALUE",
+ * //                 text: "STRING_VALUE",
+ * //                 image: {
+ * //                   format: "png" || "jpeg" || "gif" || "webp", // required
+ * //                   source: {//  Union: only one key present
+ * //                     bytes: new Uint8Array(),
+ * //                   },
+ * //                 },
+ * //               },
+ * //             ],
+ * //             status: "success" || "error",
+ * //           },
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * //   stopReason: "end_turn" || "tool_use" || "max_tokens" || "stop_sequence" || "content_filtered", // required
+ * //   usage: { // TokenUsage
+ * //     inputTokens: Number("int"), // required
+ * //     outputTokens: Number("int"), // required
+ * //     totalTokens: Number("int"), // required
+ * //   },
+ * //   metrics: { // ConverseMetrics
+ * //     latencyMs: Number("long"), // required
+ * //   },
+ * //   additionalModelResponseFields: "DOCUMENT_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ConverseCommandInput - {@link ConverseCommandInput}
+ * @returns {@link ConverseCommandOutput}
+ * @see {@link ConverseCommandInput} for command's `input` shape.
+ * @see {@link ConverseCommandOutput} for command's `response` shape.
+ * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ModelErrorException} (client fault)
+ *  <p>The request failed due to an error while processing the model.</p>
+ *
+ * @throws {@link ModelNotReadyException} (client fault)
+ *  <p>The model specified in the request is not ready to serve inference requests.</p>
+ *
+ * @throws {@link ModelTimeoutException} (client fault)
+ *  <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
+ *
+ * @public
+ */
+export declare class ConverseCommand extends ConverseCommand_base {
+}

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

@@ -0,0 +1,221 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockRuntimeClient";
+import { ConverseStreamRequest, ConverseStreamResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ConverseStreamCommand}.
+ */
+export interface ConverseStreamCommandInput extends ConverseStreamRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ConverseStreamCommand}.
+ */
+export interface ConverseStreamCommandOutput extends ConverseStreamResponse, __MetadataBearer {
+}
+declare const ConverseStreamCommand_base: {
+    new (input: ConverseStreamCommandInput): import("@smithy/smithy-client").CommandImpl<ConverseStreamCommandInput, ConverseStreamCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ConverseStreamCommandInput): import("@smithy/smithy-client").CommandImpl<ConverseStreamCommandInput, ConverseStreamCommandOutput, BedrockRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Sends messages to the specified Amazon Bedrock model and returns
+ *          the response in a stream. <code>ConverseStream</code> provides a consistent API
+ *          that works with all Amazon Bedrock models that support messages.
+ *          This allows you to write code once and use it with different models. Should a
+ *          model have unique inference parameters, you can also pass those unique parameters to the
+ *          model. 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>
+ *          <p>To find out if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a>
+ *          and check the <code>responseStreamingSupported</code> field in the response.</p>
+ *          <p>For example code, see <i>Invoke model with streaming code
+ *          example</i> in the <i>Amazon Bedrock User Guide</i>.
+ *       </p>
+ *          <p>This operation requires permission for the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockRuntimeClient, ConverseStreamCommand } from "@aws-sdk/client-bedrock-runtime"; // ES Modules import
+ * // const { BedrockRuntimeClient, ConverseStreamCommand } = require("@aws-sdk/client-bedrock-runtime"); // CommonJS import
+ * const client = new BedrockRuntimeClient(config);
+ * const input = { // ConverseStreamRequest
+ *   modelId: "STRING_VALUE", // required
+ *   messages: [ // Messages // required
+ *     { // Message
+ *       role: "user" || "assistant", // required
+ *       content: [ // ContentBlocks // required
+ *         { // ContentBlock Union: only one key present
+ *           text: "STRING_VALUE",
+ *           image: { // ImageBlock
+ *             format: "png" || "jpeg" || "gif" || "webp", // required
+ *             source: { // ImageSource Union: only one key present
+ *               bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *             },
+ *           },
+ *           toolUse: { // ToolUseBlock
+ *             toolUseId: "STRING_VALUE", // required
+ *             name: "STRING_VALUE", // required
+ *             input: "DOCUMENT_VALUE", // required
+ *           },
+ *           toolResult: { // ToolResultBlock
+ *             toolUseId: "STRING_VALUE", // required
+ *             content: [ // ToolResultContentBlocks // required
+ *               { // ToolResultContentBlock Union: only one key present
+ *                 json: "DOCUMENT_VALUE",
+ *                 text: "STRING_VALUE",
+ *                 image: {
+ *                   format: "png" || "jpeg" || "gif" || "webp", // required
+ *                   source: {//  Union: only one key present
+ *                     bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
+ *                   },
+ *                 },
+ *               },
+ *             ],
+ *             status: "success" || "error",
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   ],
+ *   system: [ // SystemContentBlocks
+ *     { // SystemContentBlock Union: only one key present
+ *       text: "STRING_VALUE",
+ *     },
+ *   ],
+ *   inferenceConfig: { // InferenceConfiguration
+ *     maxTokens: Number("int"),
+ *     temperature: Number("float"),
+ *     topP: Number("float"),
+ *     stopSequences: [ // NonEmptyStringList
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   toolConfig: { // ToolConfiguration
+ *     tools: [ // Tools // required
+ *       { // Tool Union: only one key present
+ *         toolSpec: { // ToolSpecification
+ *           name: "STRING_VALUE", // required
+ *           description: "STRING_VALUE",
+ *           inputSchema: { // ToolInputSchema Union: only one key present
+ *             json: "DOCUMENT_VALUE",
+ *           },
+ *         },
+ *       },
+ *     ],
+ *     toolChoice: { // ToolChoice Union: only one key present
+ *       auto: {},
+ *       any: {},
+ *       tool: { // SpecificToolChoice
+ *         name: "STRING_VALUE", // required
+ *       },
+ *     },
+ *   },
+ *   additionalModelRequestFields: "DOCUMENT_VALUE",
+ *   additionalModelResponseFieldPaths: [ // AdditionalModelResponseFieldPaths
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new ConverseStreamCommand(input);
+ * const response = await client.send(command);
+ * // { // ConverseStreamResponse
+ * //   stream: { // ConverseStreamOutput Union: only one key present
+ * //     messageStart: { // MessageStartEvent
+ * //       role: "user" || "assistant", // required
+ * //     },
+ * //     contentBlockStart: { // ContentBlockStartEvent
+ * //       start: { // ContentBlockStart Union: only one key present
+ * //         toolUse: { // ToolUseBlockStart
+ * //           toolUseId: "STRING_VALUE", // required
+ * //           name: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //       contentBlockIndex: Number("int"), // required
+ * //     },
+ * //     contentBlockDelta: { // ContentBlockDeltaEvent
+ * //       delta: { // ContentBlockDelta Union: only one key present
+ * //         text: "STRING_VALUE",
+ * //         toolUse: { // ToolUseBlockDelta
+ * //           input: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //       contentBlockIndex: Number("int"), // required
+ * //     },
+ * //     contentBlockStop: { // ContentBlockStopEvent
+ * //       contentBlockIndex: Number("int"), // required
+ * //     },
+ * //     messageStop: { // MessageStopEvent
+ * //       stopReason: "end_turn" || "tool_use" || "max_tokens" || "stop_sequence" || "content_filtered", // required
+ * //       additionalModelResponseFields: "DOCUMENT_VALUE",
+ * //     },
+ * //     metadata: { // ConverseStreamMetadataEvent
+ * //       usage: { // TokenUsage
+ * //         inputTokens: Number("int"), // required
+ * //         outputTokens: Number("int"), // required
+ * //         totalTokens: Number("int"), // required
+ * //       },
+ * //       metrics: { // ConverseStreamMetrics
+ * //         latencyMs: Number("long"), // required
+ * //       },
+ * //     },
+ * //     internalServerException: { // InternalServerException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     modelStreamErrorException: { // ModelStreamErrorException
+ * //       message: "STRING_VALUE",
+ * //       originalStatusCode: Number("int"),
+ * //       originalMessage: "STRING_VALUE",
+ * //     },
+ * //     validationException: { // ValidationException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //     throttlingException: { // ThrottlingException
+ * //       message: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param ConverseStreamCommandInput - {@link ConverseStreamCommandInput}
+ * @returns {@link ConverseStreamCommandOutput}
+ * @see {@link ConverseStreamCommandInput} for command's `input` shape.
+ * @see {@link ConverseStreamCommandOutput} for command's `response` shape.
+ * @see {@link BedrockRuntimeClientResolvedConfig | config} for BedrockRuntimeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ModelErrorException} (client fault)
+ *  <p>The request failed due to an error while processing the model.</p>
+ *
+ * @throws {@link ModelNotReadyException} (client fault)
+ *  <p>The model specified in the request is not ready to serve inference requests.</p>
+ *
+ * @throws {@link ModelTimeoutException} (client fault)
+ *  <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockRuntimeServiceException}
+ * <p>Base exception class for all service exceptions from BedrockRuntime service.</p>
+ *
+ * @public
+ */
+export declare class ConverseStreamCommand extends ConverseStreamCommand_base {
+}

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

@@ -1,2 +1,4 @@
+export * from "./ConverseCommand";
+export * from "./ConverseStreamCommand";
 export * from "./InvokeModelCommand";
 export * from "./InvokeModelWithResponseStreamCommand";