AWS CLI Command Reference

[ aws . bedrock-runtime ]

converse

Description

Sends messages to the specified Amazon Bedrock model. Converse 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 information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide . To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide . To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Converse API examples in the Amazon Bedrock User Guide .

This operation requires permission for the bedrock:InvokeModel action.

See also: AWS API Documentation

converse uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  converse
--model-id <value>
--messages <value>
[--system <value>]
[--inference-config <value>]
[--tool-config <value>]
[--guardrail-config <value>]
[--additional-model-request-fields <value>]
[--additional-model-response-field-paths <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--model-id (string)

The identifier for the model that you want to call.

The modelId to provide depends on the type of model that you use:

--messages (list)

The messages that you want to send to the model.

(structure)

A message input, or returned from, a call to Converse or ConverseStream .

role -> (string)

The role that the message plays in the message.

content -> (list)

The message content.

(tagged union structure)

A block of content for a message that you pass to, or receive from, a model with the Converse API ( Converse and ConverseStream ).

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, image, document, toolUse, toolResult, guardContent.

text -> (string)

Text to include in the message.

image -> (structure)

Image to include in the message.

Note

This field is only supported by Anthropic Claude 3 models.

format -> (string)

The format of the image.

source -> (tagged union structure)

The source for the image.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

The raw image bytes for the image. If you use an AWS SDK, you don’t need to base64 encode the image bytes.

document -> (structure)

A document to include in the message.

format -> (string)

The format of a document, or its extension.

name -> (string)

A name for the document.

source -> (tagged union structure)

Contains the content of the document.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

toolUse -> (structure)

Information about a tool use request from a model.

toolUseId -> (string)

The ID for the tool request.

name -> (string)

The name of the tool that the model wants to use.

input -> (document)

The input to pass to the tool.

toolResult -> (structure)

The result for a tool request that a model makes.

toolUseId -> (string)

The ID of the tool request that this is the result for.

content -> (list)

The content for tool result content block.

(tagged union structure)

The tool result content block.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: json, text, image, document.

json -> (document)

A tool result that is JSON format data.

text -> (string)

A tool result that is text.

image -> (structure)

A tool result that is an image.

Note

This field is only supported by Anthropic Claude 3 models.

format -> (string)

The format of the image.

source -> (tagged union structure)

The source for the image.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

The raw image bytes for the image. If you use an AWS SDK, you don’t need to base64 encode the image bytes.

document -> (structure)

A tool result that is a document.

format -> (string)

The format of a document, or its extension.

name -> (string)

A name for the document.

source -> (tagged union structure)

Contains the content of the document.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

status -> (string)

The status for the tool result content block.

Note

This field is only supported Anthropic Claude 3 models.

guardContent -> (tagged union structure)

Contains the content to assess with the guardrail. If you don’t specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide . </p>

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text.

text -> (structure)

The text to guard.

text -> (string)

The text that you want to guard.

JSON Syntax:

[
  {
    "role": "user"|"assistant",
    "content": [
      {
        "text": "string",
        "image": {
          "format": "png"|"jpeg"|"gif"|"webp",
          "source": {
            "bytes": blob
          }
        },
        "document": {
          "format": "pdf"|"csv"|"doc"|"docx"|"xls"|"xlsx"|"html"|"txt"|"md",
          "name": "string",
          "source": {
            "bytes": blob
          }
        },
        "toolUse": {
          "toolUseId": "string",
          "name": "string",
          "input": {...}
        },
        "toolResult": {
          "toolUseId": "string",
          "content": [
            {
              "json": {...},
              "text": "string",
              "image": {
                "format": "png"|"jpeg"|"gif"|"webp",
                "source": {
                  "bytes": blob
                }
              },
              "document": {
                "format": "pdf"|"csv"|"doc"|"docx"|"xls"|"xlsx"|"html"|"txt"|"md",
                "name": "string",
                "source": {
                  "bytes": blob
                }
              }
            }
            ...
          ],
          "status": "success"|"error"
        },
        "guardContent": {
          "text": {
            "text": "string"
          }
        }
      }
      ...
    ]
  }
  ...
]

--system (list)

A system prompt to pass to the model.

(tagged union structure)

A system content block.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, guardContent.

text -> (string)

A system prompt for the model.

guardContent -> (tagged union structure)

A content block to assess with the guardrail. Use with the Converse API ( Converse and ConverseStream ).

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text.

text -> (structure)

The text to guard.

text -> (string)

The text that you want to guard.

Shorthand Syntax:

text=string,guardContent={text={text=string}} ...

JSON Syntax:

[
  {
    "text": "string",
    "guardContent": {
      "text": {
        "text": "string"
      }
    }
  }
  ...
]

--inference-config (structure)

Inference parameters to pass to the model. Converse supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

maxTokens -> (integer)

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 Inference parameters for foundation models .

temperature -> (float)

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.

The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models .

topP -> (float)

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 topP , the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.

The default value is the default value for the model that you are using. For more information, see Inference parameters for foundation models .

stopSequences -> (list)

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

(string)

Shorthand Syntax:

maxTokens=integer,temperature=float,topP=float,stopSequences=string,string

JSON Syntax:

{
  "maxTokens": integer,
  "temperature": float,
  "topP": float,
  "stopSequences": ["string", ...]
}

--tool-config (structure)

Configuration information for the tools that the model can use when generating a response.

Note

This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.

tools -> (list)

An array of tools that you want to pass to a model.

(tagged union structure)

Information about a tool that you can use with the Converse API.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: toolSpec.

toolSpec -> (structure)

The specfication for the tool.

name -> (string)

The name for the tool.

description -> (string)

The description for the tool.

inputSchema -> (tagged union structure)

The input schema for the tool in JSON format.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: json.

json -> (document)

The JSON schema for the tool. For more information, see JSON Schema Reference .

toolChoice -> (tagged union structure)

If supported by model, forces the model to request a tool.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: auto, any, tool.

auto -> (structure)

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

any -> (structure)

The model must request at least one tool (no text is generated).

tool -> (structure)

The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

name -> (string)

The name of the tool that the model must request.

JSON Syntax:

{
  "tools": [
    {
      "toolSpec": {
        "name": "string",
        "description": "string",
        "inputSchema": {
          "json": {...}
        }
      }
    }
    ...
  ],
  "toolChoice": {
    "auto": {

    },
    "any": {

    },
    "tool": {
      "name": "string"
    }
  }
}

--guardrail-config (structure)

Configuration information for a guardrail that you want to use in the request.

guardrailIdentifier -> (string)

The identifier for the guardrail.

guardrailVersion -> (string)

The version of the guardrail.

trace -> (string)

The trace behavior for the guardrail.

Shorthand Syntax:

guardrailIdentifier=string,guardrailVersion=string,trace=string

JSON Syntax:

{
  "guardrailIdentifier": "string",
  "guardrailVersion": "string",
  "trace": "enabled"|"disabled"
}

--additional-model-request-fields (document)

Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse supports in the inferenceConfig field. For more information, see Model parameters .

JSON Syntax:

{...}

--additional-model-response-field-paths (list)

Additional model parameters field paths to return in the response. Converse returns the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths .

[ "/stop_sequence" ]

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

Converse rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by Converse .

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

output -> (tagged union structure)

The result from the call to Converse .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: message.

message -> (structure)

The message that the model generates.

role -> (string)

The role that the message plays in the message.

content -> (list)

The message content.

(tagged union structure)

A block of content for a message that you pass to, or receive from, a model with the Converse API ( Converse and ConverseStream ).

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text, image, document, toolUse, toolResult, guardContent.

text -> (string)

Text to include in the message.

image -> (structure)

Image to include in the message.

Note

This field is only supported by Anthropic Claude 3 models.

format -> (string)

The format of the image.

source -> (tagged union structure)

The source for the image.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

The raw image bytes for the image. If you use an AWS SDK, you don’t need to base64 encode the image bytes.

document -> (structure)

A document to include in the message.

format -> (string)

The format of a document, or its extension.

name -> (string)

A name for the document.

source -> (tagged union structure)

Contains the content of the document.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

toolUse -> (structure)

Information about a tool use request from a model.

toolUseId -> (string)

The ID for the tool request.

name -> (string)

The name of the tool that the model wants to use.

input -> (document)

The input to pass to the tool.

toolResult -> (structure)

The result for a tool request that a model makes.

toolUseId -> (string)

The ID of the tool request that this is the result for.

content -> (list)

The content for tool result content block.

(tagged union structure)

The tool result content block.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: json, text, image, document.

json -> (document)

A tool result that is JSON format data.

text -> (string)

A tool result that is text.

image -> (structure)

A tool result that is an image.

Note

This field is only supported by Anthropic Claude 3 models.

format -> (string)

The format of the image.

source -> (tagged union structure)

The source for the image.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

The raw image bytes for the image. If you use an AWS SDK, you don’t need to base64 encode the image bytes.

document -> (structure)

A tool result that is a document.

format -> (string)

The format of a document, or its extension.

name -> (string)

A name for the document.

source -> (tagged union structure)

Contains the content of the document.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: bytes.

bytes -> (blob)

A base64-encoded string of a UTF-8 encoded file, that is the document to include in the message.

status -> (string)

The status for the tool result content block.

Note

This field is only supported Anthropic Claude 3 models.

guardContent -> (tagged union structure)

Contains the content to assess with the guardrail. If you don’t specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide . </p>

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: text.

text -> (structure)

The text to guard.

text -> (string)

The text that you want to guard.

stopReason -> (string)

The reason why the model stopped generating output.

usage -> (structure)

The total number of tokens used in the call to Converse . The total includes the tokens input to the model and the tokens generated by the model.

inputTokens -> (integer)

The number of tokens sent in the request to the model.

outputTokens -> (integer)

The number of tokens that the model generated for the request.

totalTokens -> (integer)

The total of input tokens and tokens generated by the model.

metrics -> (structure)

Metrics for the call to Converse .

latencyMs -> (long)

The latency of the call to Converse , in milliseconds.

additionalModelResponseFields -> (document)

Additional fields in the response that are unique to the model.

trace -> (structure)

A trace object that contains information about the Guardrail behavior.

guardrail -> (structure)

The guardrail trace object.

modelOutput -> (list)

The output from the model.

(string)

inputAssessment -> (map)

The input assessment.

key -> (string)

value -> (structure)

A behavior assessment of the guardrail policies used in a call to the Converse API.

topicPolicy -> (structure)

The topic policy.

topics -> (list)

The topics in the assessment.

(structure)

Information about a topic guardrail.

name -> (string)

The name for the guardrail.

type -> (string)

The type behavior that the guardrail should perform when the model detects the topic.

action -> (string)

The action the guardrail should take when it intervenes on a topic.

contentPolicy -> (structure)

The content policy.

filters -> (list)

The content policy filters.

(structure)

The content filter for a guardrail.

type -> (string)

The guardrail type.

confidence -> (string)

The guardrail confidence.

action -> (string)

The guardrail action.

wordPolicy -> (structure)

The word policy.

customWords -> (list)

Custom words in the assessment.

(structure)

A custom word configured in a guardrail.

match -> (string)

The match for the custom word.

action -> (string)

The action for the custom word.

managedWordLists -> (list)

Managed word lists in the assessment.

(structure)

A managed word configured in a guardrail.

match -> (string)

The match for the managed word.

type -> (string)

The type for the managed word.

action -> (string)

The action for the managed word.

sensitiveInformationPolicy -> (structure)

The sensitive information policy.

piiEntities -> (list)

The PII entities in the assessment.

(structure)

A Personally Identifiable Information (PII) entity configured in a guardrail.

match -> (string)

The PII entity filter match.

type -> (string)

The PII entity filter type.

action -> (string)

The PII entity filter action.

regexes -> (list)

The regex queries in the assessment.

(structure)

A Regex filter configured in a guardrail.

name -> (string)

The regex filter name.

match -> (string)

The regesx filter match.

regex -> (string)

The regex query.

action -> (string)

The region filter action.

outputAssessments -> (map)

the output assessments.

key -> (string)

value -> (list)

(structure)

A behavior assessment of the guardrail policies used in a call to the Converse API.

topicPolicy -> (structure)

The topic policy.

topics -> (list)

The topics in the assessment.

(structure)

Information about a topic guardrail.

name -> (string)

The name for the guardrail.

type -> (string)

The type behavior that the guardrail should perform when the model detects the topic.

action -> (string)

The action the guardrail should take when it intervenes on a topic.

contentPolicy -> (structure)

The content policy.

filters -> (list)

The content policy filters.

(structure)

The content filter for a guardrail.

type -> (string)

The guardrail type.

confidence -> (string)

The guardrail confidence.

action -> (string)

The guardrail action.

wordPolicy -> (structure)

The word policy.

customWords -> (list)

Custom words in the assessment.

(structure)

A custom word configured in a guardrail.

match -> (string)

The match for the custom word.

action -> (string)

The action for the custom word.

managedWordLists -> (list)

Managed word lists in the assessment.

(structure)

A managed word configured in a guardrail.

match -> (string)

The match for the managed word.

type -> (string)

The type for the managed word.

action -> (string)

The action for the managed word.

sensitiveInformationPolicy -> (structure)

The sensitive information policy.

piiEntities -> (list)

The PII entities in the assessment.

(structure)

A Personally Identifiable Information (PII) entity configured in a guardrail.

match -> (string)

The PII entity filter match.

type -> (string)

The PII entity filter type.

action -> (string)

The PII entity filter action.

regexes -> (list)

The regex queries in the assessment.

(structure)

A Regex filter configured in a guardrail.

name -> (string)

The regex filter name.

match -> (string)

The regesx filter match.

regex -> (string)

The regex query.

action -> (string)

The region filter action.
© Copyright 2018, Amazon Web Services. Created using Sphinx.