interface ToolChoiceProperty

Language	Type name
.NET	`Amazon.CDK.aws_bedrock.CfnPrompt.ToolChoiceProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnPrompt_ToolChoiceProperty`
Java	`software.amazon.awscdk.services.bedrock.CfnPrompt.ToolChoiceProperty`
Python	`aws_cdk.aws_bedrock.CfnPrompt.ToolChoiceProperty`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnPrompt` » `ToolChoiceProperty`

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.

Example

// 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.CfnPrompt.ToolChoiceProperty = {
  any: any,
  auto: auto,
  tool: {
    name: 'name',
  },
};

Properties

Name	Type	Description
any?	`any`	The model must request at least one tool (no text is generated).
auto?	`any`	(Default).
tool?	`IResolvable` `\|` `SpecificToolChoiceProperty`	The Model must request the specified tool.

any?

Type: any (optional)

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

auto?

Type: any (optional)

(Default).

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

tool?

Type: IResolvable | SpecificToolChoiceProperty (optional)

The Model must request the specified tool.

Only supported by Anthropic Claude 3 models.