Interface CfnPrompt.IToolChoiceProperty

Determines which tools the model should request in a call to Converse or ConverseStream .

Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IToolChoiceProperty
Syntax (vb)
Public Interface IToolChoiceProperty
Remarks

ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_bedrock;

var any;
var auto;

var toolChoiceProperty = new ToolChoiceProperty {
    Any = any,
    Auto = auto,
    Tool = new SpecificToolChoiceProperty {
        Name = "name"
    }
};

Synopsis

Properties

Any

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

(Default).
Tool

The Model must request the specified tool.

Properties

Any

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

virtual object Any { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-any

Auto

(Default).

virtual object Auto { get; }
Property Value

System.Object

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-auto

Tool

The Model must request the specified tool.

virtual object Tool { get; }
Property Value

System.Object

Remarks

Only supported by Anthropic Claude 3 models.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-tool