AWS CDK Reference

Appearance

v2.275.0

ToolChoiceProperty Struct ​

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.

Source
Generated code
Type last changed
v2.177.0 · 25 Jan 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';

declare const any: any;
declare const auto: any;
const toolChoiceProperty: bedrock.CfnPromptVersion.ToolChoiceProperty = {
  any: any,
  auto: auto,
  tool: {
    name: 'name',
  },
};

Properties ​

anyoptionalanyanyoptionalAnyanyoptionalObjectAnyoptionalobjectAnyoptionalinterface{}#
The model must request at least one tool (no text is generated).
autooptionalanyautooptionalAnyautooptionalObjectAutooptionalobjectAutooptionalinterface{}#
(Default).

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

tooloptionalIResolvable | CfnPromptVersion.SpecificToolChoicePropertytooloptionaltyping.Union[IResolvable, SpecificToolChoiceProperty]tooloptionalIResolvableTooloptionalIResolvableTooloptionalinterface{}#
The Model must request the specified tool.

Only supported by Anthropic Claude 3 and Amazon Nova models.