ToolChoice - Amazon Bedrock
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

Defines which tools the model should request when invoked. For more information, see Use a tool to complete an Amazon Bedrock model response.

Contents

Important

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

any

Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.

Type: AnyToolChoice object

Required: No

auto

Defines tools. The model automatically decides whether to call a tool or to generate text instead.

Type: AutoToolChoice object

Required: No

tool

Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.

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: