ToolChoice - Amazon Bedrock
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

ToolChoice

Determines which tools the model should request in a call to Converse or ConverseStream. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

Contents

Important

This data type is a UNION, so only one of the following members can be specified when used or returned.

any

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

Type: AnyToolChoice object

Required: No

auto

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

Type: AutoToolChoice object

Required: No

tool

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

Type: SpecificToolChoice object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: