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. If a model has unique inference parameters, you can also pass those unique parameters to the model.

Amazon Bedrock doesn’t store any text, images, or documents that you provide as content. The data is only used to generate the response.

You can submit a prompt by including it in the messages field, specifying the modelId of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.

You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the promptVariables field. You can append more messages to the prompt by using the messages field. If you use a prompt from Prompt management, you can’t include the following fields in the request: additionalModelRequestFields , inferenceConfig , system , or toolConfig . Instead, these fields must be defined through Prompt management. For more information, see Use a prompt from Prompt management .

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.

For troubleshooting some of the common errors you might encounter when using the Converse API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

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>]
[--prompt-variables <value>]
[--additional-model-response-field-paths <value>]
[--request-metadata <value>]
[--performance-config <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)

--messages (list)

JSON Syntax:

[
  {
    "role": "user"|"assistant",
    "content": [
      {
        "text": "string",
        "image": {
          "format": "png"|"jpeg"|"gif"|"webp",
          "source": {
            "bytes": blob,
            "s3Location": {
              "uri": "string",
              "bucketOwner": "string"
            }
          }
        },
        "document": {
          "format": "pdf"|"csv"|"doc"|"docx"|"xls"|"xlsx"|"html"|"txt"|"md",
          "name": "string",
          "source": {
            "bytes": blob,
            "s3Location": {
              "uri": "string",
              "bucketOwner": "string"
            }
          }
        },
        "video": {
          "format": "mkv"|"mov"|"mp4"|"webm"|"flv"|"mpeg"|"mpg"|"wmv"|"three_gp",
          "source": {
            "bytes": blob,
            "s3Location": {
              "uri": "string",
              "bucketOwner": "string"
            }
          }
        },
        "toolUse": {
          "toolUseId": "string",
          "name": "string",
          "input": {...}
        },
        "toolResult": {
          "toolUseId": "string",
          "content": [
            {
              "json": {...},
              "text": "string",
              "image": {
                "format": "png"|"jpeg"|"gif"|"webp",
                "source": {
                  "bytes": blob,
                  "s3Location": {
                    "uri": "string",
                    "bucketOwner": "string"
                  }
                }
              },
              "document": {
                "format": "pdf"|"csv"|"doc"|"docx"|"xls"|"xlsx"|"html"|"txt"|"md",
                "name": "string",
                "source": {
                  "bytes": blob,
                  "s3Location": {
                    "uri": "string",
                    "bucketOwner": "string"
                  }
                }
              },
              "video": {
                "format": "mkv"|"mov"|"mp4"|"webm"|"flv"|"mpeg"|"mpg"|"wmv"|"three_gp",
                "source": {
                  "bytes": blob,
                  "s3Location": {
                    "uri": "string",
                    "bucketOwner": "string"
                  }
                }
              }
            }
            ...
          ],
          "status": "success"|"error"
        },
        "guardContent": {
          "text": {
            "text": "string",
            "qualifiers": ["grounding_source"|"query"|"guard_content", ...]
          },
          "image": {
            "format": "png"|"jpeg",
            "source": {
              "bytes": blob
            }
          }
        },
        "cachePoint": {
          "type": "default"
        },
        "reasoningContent": {
          "reasoningText": {
            "text": "string",
            "signature": "string"
          },
          "redactedContent": blob
        }
      }
      ...
    ]
  }
  ...
]

--system (list)

JSON Syntax:

[
  {
    "text": "string",
    "guardContent": {
      "text": {
        "text": "string",
        "qualifiers": ["grounding_source"|"query"|"guard_content", ...]
      },
      "image": {
        "format": "png"|"jpeg",
        "source": {
          "bytes": blob
        }
      }
    },
    "cachePoint": {
      "type": "default"
    }
  }
  ...
]

--inference-config (structure)

Shorthand Syntax:

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

JSON Syntax:

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

--tool-config (structure)

JSON Syntax:

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

    },
    "any": {

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

--guardrail-config (structure)

Shorthand Syntax:

guardrailIdentifier=string,guardrailVersion=string,trace=string

JSON Syntax:

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

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

JSON Syntax:

{...}

--prompt-variables (map)

Shorthand Syntax:

KeyName1=text=string,KeyName2=text=string

JSON Syntax:

{"string": {
      "text": "string"
    }
  ...}

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

Syntax:

"string" "string" ...

--request-metadata (map)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--performance-config (structure)

Shorthand Syntax:

latency=string

JSON Syntax:

{
  "latency": "standard"|"optimized"
}

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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)

stopReason -> (string)

usage -> (structure)

metrics -> (structure)

additionalModelResponseFields -> (document)

trace -> (structure)

performanceConfig -> (structure)