interface SpecificToolChoiceProperty

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

The model must request a specific tool.

For example, {"tool" : {"name" : "Your tool name"}} . For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide

This field is only supported by Anthropic Claude 3 models.

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';
const specificToolChoiceProperty: bedrock.CfnPrompt.SpecificToolChoiceProperty = {
  name: 'name',
};

Properties

Name	Type	Description
name	`string`	The name of the tool that the model must request.

name

Type: string

The name of the tool that the model must request.