class ToolChoice 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Bedrock.Alpha.ToolChoice`
Go	`github.com/aws/aws-cdk-go/awsbedrockalpha/v2#ToolChoice`
Java	`software.amazon.awscdk.services.bedrock.alpha.ToolChoice`
Python	`aws_cdk.aws_bedrock_alpha.ToolChoice`
TypeScript (source)	`@aws-cdk/aws-bedrock-alpha` » `ToolChoice`

Defines how the model should choose which tool to use.

Example

const cmk = new kms.Key(this, 'cmk', {});

const variantChat = bedrock.PromptVariant.chat({
  variantName: 'variant1',
  model: bedrock.BedrockFoundationModel.ANTHROPIC_CLAUDE_3_5_SONNET_V1_0,
  messages: [
    bedrock.ChatMessage.user('From now on, you speak Japanese!'),
    bedrock.ChatMessage.assistant('Konnichiwa!'),
    bedrock.ChatMessage.user('From now on, you speak {{language}}!'),
  ],
  system: 'You are a helpful assistant that only speaks the language you`re told.',
  promptVariables: ['language'],
  toolConfiguration: {
    toolChoice: bedrock.ToolChoice.AUTO,
    tools: [
      bedrock.Tool.function({
        name: 'top_song',
        description: 'Get the most popular song played on a radio station.',
        inputSchema: {
          type: 'object',
          properties: {
            sign: {
              type: 'string',
              description: 'The call sign for the radio station for which you want the most popular song. Example calls signs are WZPZ and WKR.',
            },
          },
          required: ['sign'],
        },
      }),
    ],
  },
});

new bedrock.Prompt(this, 'prompt1', {
  promptName: 'prompt-chat',
  description: 'my first chat prompt',
  defaultVariant: variantChat,
  variants: [variantChat],
  kmsKey: cmk,
});

Initializer

new ToolChoice(any: any, auto: any, tool?: string)

Parameters

any any
auto any
tool string

Properties

Name	Type	Description
any?🔹	`any`	Configuration for ANY tool choice.
auto?🔹	`any`	Configuration for AUTO tool choice.
tool?🔹	`string`	The specific tool name if using specific tool choice.
static ANY🔹	`ToolChoice`	The model must request at least one tool (no text is generated).
static AUTO🔹	`ToolChoice`	(Default).

any?🔹

Type: any (optional)

Configuration for ANY tool choice.

auto?🔹

Type: any (optional)

Configuration for AUTO tool choice.

tool?🔹

Type: string (optional)

The specific tool name if using specific tool choice.

static ANY🔹

Type: ToolChoice

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

static AUTO🔹

Type: ToolChoice

(Default).

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

Methods

Name	Description
static specificTool(toolName)🔹	The Model must request the specified tool.

static specificTool(toolName)🔹

public static specificTool(toolName: string): ToolChoice

Parameters

toolName string — - The name of the specific tool to use.

Returns

ToolChoice

The Model must request the specified tool.

Only supported by some models like Anthropic Claude 3 models.