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

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

@@ -1,4 +1,5 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
 import { BedrockRuntimeServiceException as __BaseException } from "./BedrockRuntimeServiceException";
 /**
  * <p>The request is denied because of missing access permissions.</p>
@@ -12,17 +13,1417 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * <p>Base inference parameters to pass to a model in a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a>. For more information,
+ *          see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
+ *          <p>If you need to pass additional parameters that the model
+ *          supports, use the <code>additionalModelRequestFields</code> request field in the call to <code>Converse</code>
+ *          or <code>ConverseStream</code>.
+ *          For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Model parameters</a>.</p>
+ * @public
+ */
+export interface InferenceConfiguration {
+    /**
+     * <p>The maximum number of tokens to allow in the generated response. The default value is
+     *          the maximum allowed value for the model that you are using. For more information, see
+     *             <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundatio\{
+     *                 "messages": [
+     *                 \{
+     *                 "role": "user",
+     *                 "content": [
+     *                 \{
+     *                 "text": "what's the weather in Queens, NY and Austin, TX?"
+     *                 \}
+     *                 ]
+     *                 \},
+     *                 \{
+     *                 "role": "assistant",
+     *                 "content": [
+     *                 \{
+     *                 "toolUse": \{
+     *                 "toolUseId": "1",
+     *                 "name": "get_weather",
+     *                 "input": \{
+     *                 "city": "Queens",
+     *                 "state": "NY"
+     *                 \}
+     *                 \}
+     *                 \},
+     *                 \{
+     *                 "toolUse": \{
+     *                 "toolUseId": "2",
+     *                 "name": "get_weather",
+     *                 "input": \{
+     *                 "city": "Austin",
+     *                 "state": "TX"
+     *                 \}
+     *                 \}
+     *                 \}
+     *                 ]
+     *                 \},
+     *                 \{
+     *                 "role": "user",
+     *                 "content": [
+     *                 \{
+     *                 "toolResult": \{
+     *                 "toolUseId": "2",
+     *                 "content": [
+     *                 \{
+     *                 "json": \{
+     *                 "weather": "40"
+     *                 \}
+     *                 \}
+     *                 ]
+     *                 \}
+     *                 \},
+     *                 \{
+     *                 "text": "..."
+     *                 \},
+     *                 \{
+     *                 "toolResult": \{
+     *                 "toolUseId": "1",
+     *                 "content": [
+     *                 \{
+     *                 "text": "result text"
+     *                 \}
+     *                 ]
+     *                 \}
+     *                 \}
+     *                 ]
+     *                 \}
+     *                 ],
+     *                 "toolConfig": \{
+     *                 "tools": [
+     *                 \{
+     *                 "name": "get_weather",
+     *                 "description": "Get weather",
+     *                 "inputSchema": \{
+     *                 "type": "object",
+     *                 "properties": \{
+     *                 "city": \{
+     *                 "type": "string",
+     *                 "description": "City of location"
+     *                 \},
+     *                 "state": \{
+     *                 "type": "string",
+     *                 "description": "State of location"
+     *                 \}
+     *                 \},
+     *                 "required": ["city", "state"]
+     *                 \}
+     *                 \}
+     *                 ]
+     *                 \}
+     *                 \}
+     *                 n models</a>. </p>
+     * @public
+     */
+    maxTokens?: number;
+    /**
+     * <p>The likelihood of the model selecting higher-probability options while generating a
+     *          response. A lower value makes the model more likely to choose higher-probability options,
+     *          while a higher value makes the model more likely to choose lower-probability
+     *          options.</p>
+     *          <p>The default value is the default value for the model that
+     *          you are using. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation
+     *             models</a>. </p>
+     * @public
+     */
+    temperature?: number;
+    /**
+     * <p>The percentage of most-likely candidates that the model considers for the next token. For
+     *          example, if you choose a value of 0.8 for <code>topP</code>, the model selects from the top 80% of the
+     *          probability distribution of tokens that could be next in the sequence.</p>
+     *          <p>The default value is the default value for the model that you are using. For more information, see
+     *          <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>. </p>
+     * @public
+     */
+    topP?: number;
+    /**
+     * <p>A list of stop sequences. A stop sequence is a sequence of characters that causes the
+     *          model to stop generating the response. </p>
+     * @public
+     */
+    stopSequences?: string[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ImageFormat: {
+    readonly GIF: "gif";
+    readonly JPEG: "jpeg";
+    readonly PNG: "png";
+    readonly WEBP: "webp";
+};
+/**
+ * @public
+ */
+export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat];
+/**
+ * <p>The source for an image.</p>
+ * @public
+ */
+export type ImageSource = ImageSource.BytesMember | ImageSource.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ImageSource {
+    /**
+     * <p>The raw image bytes for the image. If you use an AWS SDK, you don't need to base64 encode the image bytes.</p>
+     * @public
+     */
+    interface BytesMember {
+        bytes: Uint8Array;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        bytes?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        bytes: (value: Uint8Array) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ImageSource, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Image content for a message.</p>
+ * @public
+ */
+export interface ImageBlock {
+    /**
+     * <p>The format of the image.</p>
+     * @public
+     */
+    format: ImageFormat | undefined;
+    /**
+     * <p>The source for the image.</p>
+     * @public
+     */
+    source: ImageSource | undefined;
+}
+/**
+ * <p>The tool result content block.</p>
+ * @public
+ */
+export type ToolResultContentBlock = ToolResultContentBlock.ImageMember | ToolResultContentBlock.JsonMember | ToolResultContentBlock.TextMember | ToolResultContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ToolResultContentBlock {
+    /**
+     * <p>A tool result that is JSON format data.</p>
+     * @public
+     */
+    interface JsonMember {
+        json: __DocumentType;
+        text?: never;
+        image?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A tool result that is text.</p>
+     * @public
+     */
+    interface TextMember {
+        json?: never;
+        text: string;
+        image?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A tool result that is an image.</p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    interface ImageMember {
+        json?: never;
+        text?: never;
+        image: ImageBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        json?: never;
+        text?: never;
+        image?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        json: (value: __DocumentType) => T;
+        text: (value: string) => T;
+        image: (value: ImageBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ToolResultContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ToolResultStatus: {
+    readonly ERROR: "error";
+    readonly SUCCESS: "success";
+};
+/**
+ * @public
+ */
+export type ToolResultStatus = (typeof ToolResultStatus)[keyof typeof ToolResultStatus];
+/**
+ * <p>A tool result block that contains the results for a tool request that
+ *       the model previously made.</p>
+ * @public
+ */
+export interface ToolResultBlock {
+    /**
+     * <p>The ID of the tool request that this is the result for.</p>
+     * @public
+     */
+    toolUseId: string | undefined;
+    /**
+     * <p>The content for tool result content block.</p>
+     * @public
+     */
+    content: ToolResultContentBlock[] | undefined;
+    /**
+     * <p>The status for the tool result content block.</p>
+     *          <note>
+     *             <p>This field is only supported Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    status?: ToolResultStatus;
+}
+/**
+ * <p>A tool use content block. Contains information about a tool that the model
+ *       is requesting be run., The model uses the result from the tool to generate a response. </p>
+ * @public
+ */
+export interface ToolUseBlock {
+    /**
+     * <p>The ID for the tool request.</p>
+     * @public
+     */
+    toolUseId: string | undefined;
+    /**
+     * <p>The name of the tool that the model wants to use.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The input to pass to the tool. </p>
+     * @public
+     */
+    input: __DocumentType | undefined;
+}
+/**
+ * <p>A block of content for a message.</p>
+ * @public
+ */
+export type ContentBlock = ContentBlock.ImageMember | ContentBlock.TextMember | ContentBlock.ToolResultMember | ContentBlock.ToolUseMember | ContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ContentBlock {
+    /**
+     * <p>Text to include in the message.</p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        image?: never;
+        toolUse?: never;
+        toolResult?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Image to include in the message. </p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    interface ImageMember {
+        text?: never;
+        image: ImageBlock;
+        toolUse?: never;
+        toolResult?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Information about a tool use request from a model. </p>
+     * @public
+     */
+    interface ToolUseMember {
+        text?: never;
+        image?: never;
+        toolUse: ToolUseBlock;
+        toolResult?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The result for a tool request that a model makes.</p>
+     * @public
+     */
+    interface ToolResultMember {
+        text?: never;
+        image?: never;
+        toolUse?: never;
+        toolResult: ToolResultBlock;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        image?: never;
+        toolUse?: never;
+        toolResult?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: string) => T;
+        image: (value: ImageBlock) => T;
+        toolUse: (value: ToolUseBlock) => T;
+        toolResult: (value: ToolResultBlock) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ConversationRole: {
+    readonly ASSISTANT: "assistant";
+    readonly USER: "user";
+};
+/**
+ * @public
+ */
+export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
+/**
+ * <p>A message in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Message.html">Message</a> field. Use to send a message in a call to
+ *          <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>. </p>
+ * @public
+ */
+export interface Message {
+    /**
+     * <p>The role that the message plays in the message.</p>
+     * @public
+     */
+    role: ConversationRole | undefined;
+    /**
+     * <p>The message content.</p>
+     * @public
+     */
+    content: ContentBlock[] | undefined;
+}
+/**
+ * <p>A system content block</p>
+ * @public
+ */
+export type SystemContentBlock = SystemContentBlock.TextMember | SystemContentBlock.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace SystemContentBlock {
+    /**
+     * <p>A system prompt for the model. </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: SystemContentBlock, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The model must request at least one tool (no text is generated).</p>
+ * @public
+ */
+export interface AnyToolChoice {
+}
+/**
+ * <p>The Model automatically decides if a tool should be called or to whether to generate text instead.</p>
+ * @public
+ */
+export interface AutoToolChoice {
+}
+/**
+ * <p>The model must request a specific tool.</p>
+ *          <note>
+ *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+ *          </note>
+ * @public
+ */
+export interface SpecificToolChoice {
+    /**
+     * <p>The name of the tool that the model must request. </p>
+     * @public
+     */
+    name: string | undefined;
+}
+/**
+ * <p>Forces a model to use a tool.</p>
+ * @public
+ */
+export type ToolChoice = ToolChoice.AnyMember | ToolChoice.AutoMember | ToolChoice.ToolMember | ToolChoice.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ToolChoice {
+    /**
+     * <p>The Model automatically decides if a tool should be called or to whether to generate text instead.</p>
+     * @public
+     */
+    interface AutoMember {
+        auto: AutoToolChoice;
+        any?: never;
+        tool?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The model must request at least one tool (no text is generated).</p>
+     * @public
+     */
+    interface AnyMember {
+        auto?: never;
+        any: AnyToolChoice;
+        tool?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The Model must request the specified tool.</p>
+     * @public
+     */
+    interface ToolMember {
+        auto?: never;
+        any?: never;
+        tool: SpecificToolChoice;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        auto?: never;
+        any?: never;
+        tool?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        auto: (value: AutoToolChoice) => T;
+        any: (value: AnyToolChoice) => T;
+        tool: (value: SpecificToolChoice) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ToolChoice, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The schema for the tool. The top level schema type must be <code>object</code>. </p>
+ * @public
+ */
+export type ToolInputSchema = ToolInputSchema.JsonMember | ToolInputSchema.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ToolInputSchema {
+    /**
+     * <p>The JSON schema for the tool. For more information, see <a href="https://json-schema.org/understanding-json-schema/reference">JSON Schema Reference</a>.</p>
+     * @public
+     */
+    interface JsonMember {
+        json: __DocumentType;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        json?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        json: (value: __DocumentType) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ToolInputSchema, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The specification for the tool.</p>
+ * @public
+ */
+export interface ToolSpecification {
+    /**
+     * <p>The name for the tool.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The description for the tool.</p>
+     * @public
+     */
+    description?: string;
+    /**
+     * <p>The input schema for the tool in JSON format.</p>
+     * @public
+     */
+    inputSchema: ToolInputSchema | undefined;
+}
+/**
+ * <p>Information about a tool that you can use with the Converse API.  </p>
+ * @public
+ */
+export type Tool = Tool.ToolSpecMember | Tool.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace Tool {
+    /**
+     * <p>The specfication for the tool.</p>
+     * @public
+     */
+    interface ToolSpecMember {
+        toolSpec: ToolSpecification;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        toolSpec?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        toolSpec: (value: ToolSpecification) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: Tool, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Configuration information for the tools that you pass to a model.</p>
+ *          <note>
+ *             <p>This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.</p>
+ *          </note>
+ * @public
+ */
+export interface ToolConfiguration {
+    /**
+     * <p>An array of tools that you want to pass to a model.</p>
+     * @public
+     */
+    tools: Tool[] | undefined;
+    /**
+     * <p>If supported by model, forces the model to request a tool.</p>
+     * @public
+     */
+    toolChoice?: ToolChoice;
+}
+/**
+ * @public
+ */
+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 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>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <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>
+     *          </ul>
+     * @public
+     */
+    modelId: string | undefined;
+    /**
+     * <p>The messages that you want to send to the model.</p>
+     * @public
+     */
+    messages: Message[] | undefined;
+    /**
+     * <p>A system prompt to pass to the model.</p>
+     * @public
+     */
+    system?: SystemContentBlock[];
+    /**
+     * <p>Inference parameters to pass to the model. <code>Converse</code> supports 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
+     */
+    inferenceConfig?: InferenceConfiguration;
+    /**
+     * <p>Configuration information for the tools that the model can use when generating a response. </p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.</p>
+     *          </note>
+     * @public
+     */
+    toolConfig?: ToolConfiguration;
+    /**
+     * <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>
+     *          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>Additional model parameters field paths to return in the
+     *          response. <code>Converse</code> returns the requested fields as a JSON Pointer object in the
+     *          <code>additionalModelResultFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
+     *          <p>
+     *             <code>[
+     *          "/stop_sequence"
+     *          ]</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>
+     *          <p>
+     *             <code>Converse</code> rejects 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
+     */
+    additionalModelResponseFieldPaths?: string[];
+}
+/**
+ * <p>Metrics for a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>.</p>
+ * @public
+ */
+export interface ConverseMetrics {
+    /**
+     * <p>The latency of the call to <code>Converse</code>, in milliseconds.
+     *          </p>
+     * @public
+     */
+    latencyMs: number | undefined;
+}
+/**
+ * <p>The output from a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>.</p>
+ * @public
+ */
+export type ConverseOutput = ConverseOutput.MessageMember | ConverseOutput.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ConverseOutput {
+    /**
+     * <p>The message that the model generates.</p>
+     * @public
+     */
+    interface MessageMember {
+        message: Message;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        message?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        message: (value: Message) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ConverseOutput, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const StopReason: {
+    readonly CONTENT_FILTERED: "content_filtered";
+    readonly END_TURN: "end_turn";
+    readonly MAX_TOKENS: "max_tokens";
+    readonly STOP_SEQUENCE: "stop_sequence";
+    readonly TOOL_USE: "tool_use";
+};
+/**
+ * @public
+ */
+export type StopReason = (typeof StopReason)[keyof typeof StopReason];
+/**
+ * <p>The tokens used in a message API inference call. </p>
+ * @public
+ */
+export interface TokenUsage {
+    /**
+     * <p>The number of tokens sent in the request to the model.</p>
+     * @public
+     */
+    inputTokens: number | undefined;
+    /**
+     * <p>The number of tokens that the model generated for the request.</p>
+     * @public
+     */
+    outputTokens: number | undefined;
+    /**
+     * <p>The total of input tokens and tokens generated by the model.</p>
+     * @public
+     */
+    totalTokens: number | undefined;
+}
+/**
+ * @public
+ */
+export interface ConverseResponse {
+    /**
+     * <p>The result from the call to <code>Converse</code>.</p>
+     * @public
+     */
+    output: ConverseOutput | undefined;
+    /**
+     * <p>The reason why the model stopped generating output.</p>
+     * @public
+     */
+    stopReason: StopReason | undefined;
+    /**
+     * <p>The total number of tokens used in the call to <code>Converse</code>. The total includes
+     *          the tokens input to the model and the tokens generated by the model.</p>
+     * @public
+     */
+    usage: TokenUsage | undefined;
+    /**
+     * <p>Metrics for the call to <code>Converse</code>.</p>
+     * @public
+     */
+    metrics: ConverseMetrics | undefined;
+    /**
+     * <p>Additional fields in the response that are unique to the model. </p>
+     * @public
+     */
+    additionalModelResponseFields?: __DocumentType;
+}
 /**
  * <p>An internal server error occurred. Retry your request.</p>
  * @public
  */
-export declare class InternalServerException extends __BaseException {
-    readonly name: "InternalServerException";
-    readonly $fault: "server";
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+/**
+ * <p>The request failed due to an error while processing the model.</p>
+ * @public
+ */
+export declare class ModelErrorException extends __BaseException {
+    readonly name: "ModelErrorException";
+    readonly $fault: "client";
+    /**
+     * <p>The original status code.</p>
+     * @public
+     */
+    originalStatusCode?: number;
+    /**
+     * <p>The resource name.</p>
+     * @public
+     */
+    resourceName?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ModelErrorException, __BaseException>);
+}
+/**
+ * <p>The model specified in the request is not ready to serve inference requests.</p>
+ * @public
+ */
+export declare class ModelNotReadyException extends __BaseException {
+    readonly name: "ModelNotReadyException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ModelNotReadyException, __BaseException>);
+}
+/**
+ * <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
+ * @public
+ */
+export declare class ModelTimeoutException extends __BaseException {
+    readonly name: "ModelTimeoutException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ModelTimeoutException, __BaseException>);
+}
+/**
+ * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
+ * @public
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ * @public
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
+ * @public
+ */
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface ConverseStreamRequest {
+    /**
+     * <p>The ID for the model.</p>
+     *          <p>The <code>modelId</code> to provide depends on the type of model 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>
+     *             </li>
+     *             <li>
+     *                <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
+     *             </li>
+     *             <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>
+     *          </ul>
+     * @public
+     */
+    modelId: string | undefined;
+    /**
+     * <p>The messages that you want to send to the model.</p>
+     * @public
+     */
+    messages: Message[] | undefined;
+    /**
+     * <p>A system prompt to send to the model.</p>
+     * @public
+     */
+    system?: SystemContentBlock[];
+    /**
+     * <p>Inference parameters to pass to the model. <code>ConverseStream</code> supports 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
+     */
+    inferenceConfig?: InferenceConfiguration;
+    /**
+     * <p>Configuration information for the tools that the model can use when generating a response.</p>
+     *          <note>
+     *             <p>This field is only supported by Anthropic Claude 3 models.</p>
+     *          </note>
+     * @public
+     */
+    toolConfig?: ToolConfiguration;
+    /**
+     * <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>
+     * @public
+     */
+    additionalModelRequestFields?: __DocumentType;
+    /**
+     * <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
+     *          <code>additionalModelResultFields</code> field. The following is example JSON for <code>additionalModelResponseFieldPaths</code>.</p>
+     *          <p>
+     *             <code>[
+     *          "/stop_sequence"
+     *          ]</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>
+     *          <p>
+     *             <code>ConverseStream</code> rejects 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>
+     * @public
+     */
+    additionalModelResponseFieldPaths?: string[];
+}
+/**
+ * <p>The delta for a tool use block.</p>
+ * @public
+ */
+export interface ToolUseBlockDelta {
+    /**
+     * <p>The input for a requested tool.</p>
+     * @public
+     */
+    input: string | undefined;
+}
+/**
+ * <p>A bock of content in a streaming response.</p>
+ * @public
+ */
+export type ContentBlockDelta = ContentBlockDelta.TextMember | ContentBlockDelta.ToolUseMember | ContentBlockDelta.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ContentBlockDelta {
+    /**
+     * <p>The content text.</p>
+     * @public
+     */
+    interface TextMember {
+        text: string;
+        toolUse?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Information about a tool that the model is requesting to use.</p>
+     * @public
+     */
+    interface ToolUseMember {
+        text?: never;
+        toolUse: ToolUseBlockDelta;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        text?: never;
+        toolUse?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        text: (value: string) => T;
+        toolUse: (value: ToolUseBlockDelta) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ContentBlockDelta, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>The content block delta event.</p>
+ * @public
+ */
+export interface ContentBlockDeltaEvent {
+    /**
+     * <p>The delta for a content block delta event.</p>
+     * @public
+     */
+    delta: ContentBlockDelta | undefined;
+    /**
+     * <p>The block index for a content block delta event. </p>
+     * @public
+     */
+    contentBlockIndex: number | undefined;
+}
+/**
+ * <p>The start of a tool use block.</p>
+ * @public
+ */
+export interface ToolUseBlockStart {
+    /**
+     * <p>The ID for the tool request.</p>
+     * @public
+     */
+    toolUseId: string | undefined;
+    /**
+     * <p>The name of the tool that the model is requesting to use.</p>
+     * @public
+     */
+    name: string | undefined;
+}
+/**
+ * <p>Content block start information.</p>
+ * @public
+ */
+export type ContentBlockStart = ContentBlockStart.ToolUseMember | ContentBlockStart.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ContentBlockStart {
+    /**
+     * <p>Information about a tool that the model is requesting to use.</p>
+     * @public
+     */
+    interface ToolUseMember {
+        toolUse: ToolUseBlockStart;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        toolUse?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        toolUse: (value: ToolUseBlockStart) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ContentBlockStart, visitor: Visitor<T>) => T;
+}
+/**
+ * <p>Content block start event.</p>
+ * @public
+ */
+export interface ContentBlockStartEvent {
+    /**
+     * <p>Start information about a content block start event.  </p>
+     * @public
+     */
+    start: ContentBlockStart | undefined;
+    /**
+     * <p>The index for a content block start event.</p>
+     * @public
+     */
+    contentBlockIndex: number | undefined;
+}
+/**
+ * <p>A content block stop event.</p>
+ * @public
+ */
+export interface ContentBlockStopEvent {
+    /**
+     * <p>The index for a content block.</p>
+     * @public
+     */
+    contentBlockIndex: number | undefined;
+}
+/**
+ * <p>The start of a message.</p>
+ * @public
+ */
+export interface MessageStartEvent {
+    /**
+     * <p>The role for the message.</p>
+     * @public
+     */
+    role: ConversationRole | undefined;
+}
+/**
+ * <p>The stop event for a message.</p>
+ * @public
+ */
+export interface MessageStopEvent {
+    /**
+     * <p>The reason why the model stopped generating output.</p>
+     * @public
+     */
+    stopReason: StopReason | undefined;
+    /**
+     * <p>The additional model response fields.</p>
+     * @public
+     */
+    additionalModelResponseFields?: __DocumentType;
+}
+/**
+ * <p>Metrics for the stream.</p>
+ * @public
+ */
+export interface ConverseStreamMetrics {
+    /**
+     * <p>The latency for the streaming request, in milliseconds.</p>
+     * @public
+     */
+    latencyMs: number | undefined;
+}
+/**
+ * <p>A conversation stream metadata event.</p>
+ * @public
+ */
+export interface ConverseStreamMetadataEvent {
+    /**
+     * <p>Usage information for the conversation stream event.</p>
+     * @public
+     */
+    usage: TokenUsage | undefined;
+    /**
+     * <p>The metrics for the conversation stream metadata event.</p>
+     * @public
+     */
+    metrics: ConverseStreamMetrics | undefined;
+}
+/**
+ * <p>An error occurred while streaming the response. Retry your request.</p>
+ * @public
+ */
+export declare class ModelStreamErrorException extends __BaseException {
+    readonly name: "ModelStreamErrorException";
+    readonly $fault: "client";
+    /**
+     * <p>The original status code.</p>
+     * @public
+     */
+    originalStatusCode?: number;
+    /**
+     * <p>The original message.</p>
+     * @public
+     */
+    originalMessage?: string;
     /**
      * @internal
      */
-    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+    constructor(opts: __ExceptionOptionType<ModelStreamErrorException, __BaseException>);
+}
+/**
+ * <p>The messages output stream</p>
+ * @public
+ */
+export type ConverseStreamOutput = ConverseStreamOutput.ContentBlockDeltaMember | ConverseStreamOutput.ContentBlockStartMember | ConverseStreamOutput.ContentBlockStopMember | ConverseStreamOutput.InternalServerExceptionMember | ConverseStreamOutput.MessageStartMember | ConverseStreamOutput.MessageStopMember | ConverseStreamOutput.MetadataMember | ConverseStreamOutput.ModelStreamErrorExceptionMember | ConverseStreamOutput.ThrottlingExceptionMember | ConverseStreamOutput.ValidationExceptionMember | ConverseStreamOutput.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ConverseStreamOutput {
+    /**
+     * <p>Message start information.</p>
+     * @public
+     */
+    interface MessageStartMember {
+        messageStart: MessageStartEvent;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Start information for a content block.</p>
+     * @public
+     */
+    interface ContentBlockStartMember {
+        messageStart?: never;
+        contentBlockStart: ContentBlockStartEvent;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The messages output content block delta.</p>
+     * @public
+     */
+    interface ContentBlockDeltaMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta: ContentBlockDeltaEvent;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Stop information for a content block.</p>
+     * @public
+     */
+    interface ContentBlockStopMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop: ContentBlockStopEvent;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Message stop information.</p>
+     * @public
+     */
+    interface MessageStopMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop: MessageStopEvent;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Metadata for the converse output stream.</p>
+     * @public
+     */
+    interface MetadataMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata: ConverseStreamMetadataEvent;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>An internal server error occurred. Retry your request.</p>
+     * @public
+     */
+    interface InternalServerExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException: InternalServerException;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>A streaming error occurred. Retry your request.</p>
+     * @public
+     */
+    interface ModelStreamErrorExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException: ModelStreamErrorException;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Input validation failed. Check your request parameters and retry the request.</p>
+     * @public
+     */
+    interface ValidationExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException: ValidationException;
+        throttlingException?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+     * @public
+     */
+    interface ThrottlingExceptionMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException: ThrottlingException;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        messageStart?: never;
+        contentBlockStart?: never;
+        contentBlockDelta?: never;
+        contentBlockStop?: never;
+        messageStop?: never;
+        metadata?: never;
+        internalServerException?: never;
+        modelStreamErrorException?: never;
+        validationException?: never;
+        throttlingException?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        messageStart: (value: MessageStartEvent) => T;
+        contentBlockStart: (value: ContentBlockStartEvent) => T;
+        contentBlockDelta: (value: ContentBlockDeltaEvent) => T;
+        contentBlockStop: (value: ContentBlockStopEvent) => T;
+        messageStop: (value: MessageStopEvent) => T;
+        metadata: (value: ConverseStreamMetadataEvent) => T;
+        internalServerException: (value: InternalServerException) => T;
+        modelStreamErrorException: (value: ModelStreamErrorException) => T;
+        validationException: (value: ValidationException) => T;
+        throttlingException: (value: ThrottlingException) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ConverseStreamOutput, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ */
+export interface ConverseStreamResponse {
+    /**
+     * <p>The output stream that the model generated.</p>
+     * @public
+     */
+    stream?: AsyncIterable<ConverseStreamOutput>;
 }
 /**
  * @public
@@ -117,64 +1518,6 @@ export interface InvokeModelResponse {
      */
     contentType: string | undefined;
 }
-/**
- * <p>The request failed due to an error while processing the model.</p>
- * @public
- */
-export declare class ModelErrorException extends __BaseException {
-    readonly name: "ModelErrorException";
-    readonly $fault: "client";
-    /**
-     * <p>The original status code.</p>
-     * @public
-     */
-    originalStatusCode?: number;
-    /**
-     * <p>The resource name.</p>
-     * @public
-     */
-    resourceName?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ModelErrorException, __BaseException>);
-}
-/**
- * <p>The model specified in the request is not ready to serve inference requests.</p>
- * @public
- */
-export declare class ModelNotReadyException extends __BaseException {
-    readonly name: "ModelNotReadyException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ModelNotReadyException, __BaseException>);
-}
-/**
- * <p>The request took too long to process. Processing time exceeded the model timeout length.</p>
- * @public
- */
-export declare class ModelTimeoutException extends __BaseException {
-    readonly name: "ModelTimeoutException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ModelTimeoutException, __BaseException>);
-}
-/**
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
- * @public
- */
-export declare class ResourceNotFoundException extends __BaseException {
-    readonly name: "ResourceNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
-}
 /**
  * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
  * @public
@@ -187,30 +1530,6 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
-/**
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
- * @public
- */
-export declare class ThrottlingException extends __BaseException {
-    readonly name: "ThrottlingException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
-}
-/**
- * <p>Input validation failed. Check your request parameters and retry the request.</p>
- * @public
- */
-export declare class ValidationException extends __BaseException {
-    readonly name: "ValidationException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
-}
 /**
  * @public
  */
@@ -289,28 +1608,6 @@ export interface PayloadPart {
      */
     bytes?: Uint8Array;
 }
-/**
- * <p>An error occurred while streaming the response. Retry your request.</p>
- * @public
- */
-export declare class ModelStreamErrorException extends __BaseException {
-    readonly name: "ModelStreamErrorException";
-    readonly $fault: "client";
-    /**
-     * <p>The original status code.</p>
-     * @public
-     */
-    originalStatusCode?: number;
-    /**
-     * <p>The original message.</p>
-     * @public
-     */
-    originalMessage?: string;
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ModelStreamErrorException, __BaseException>);
-}
 /**
  * <p>Definition of content in the response stream.</p>
  * @public
@@ -436,6 +1733,14 @@ export interface InvokeModelWithResponseStreamResponse {
      */
     contentType: string | undefined;
 }
+/**
+ * @internal
+ */
+export declare const ConverseStreamOutputFilterSensitiveLog: (obj: ConverseStreamOutput) => any;
+/**
+ * @internal
+ */
+export declare const ConverseStreamResponseFilterSensitiveLog: (obj: ConverseStreamResponse) => any;
 /**
  * @internal
  */