Class CfnPromptVersionPropsMixin.ToolChoiceProperty
Determines which tools the model should request in a call to Converse or ConverseStream .
Implements
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnPromptVersionPropsMixin.ToolChoiceProperty : CfnPromptVersionPropsMixin.IToolChoiceProperty
Syntax (vb)
Public Class CfnPromptVersionPropsMixin.ToolChoiceProperty Implements CfnPromptVersionPropsMixin.IToolChoiceProperty
Remarks
For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.
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.Mixins.Preview.AWS.Bedrock.Mixins;
var any;
var auto;
var toolChoiceProperty = new ToolChoiceProperty {
Any = any,
Auto = auto,
Tool = new SpecificToolChoiceProperty {
Name = "name"
}
};
Synopsis
Constructors
| ToolChoiceProperty() | Determines which tools the model should request in a call to |
Properties
| Any | The model must request at least one tool (no text is generated). |
| Auto | (Default). |
| Tool | The Model must request the specified tool. |
Constructors
ToolChoiceProperty()
Determines which tools the model should request in a call to Converse or ConverseStream .
public ToolChoiceProperty()
Remarks
For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.
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.Mixins.Preview.AWS.Bedrock.Mixins;
var any;
var auto;
var toolChoiceProperty = new ToolChoiceProperty {
Any = any,
Auto = auto,
Tool = new SpecificToolChoiceProperty {
Name = "name"
}
};
Properties
Any
The model must request at least one tool (no text is generated).
public object? Any { get; set; }
Property Value
Remarks
Auto
(Default).
public object? Auto { get; set; }
Property Value
Remarks
The Model automatically decides if a tool should be called or whether to generate text instead.
Tool
The Model must request the specified tool.
public object? Tool { get; set; }
Property Value
Remarks
Only supported by Anthropic Claude 3 and Amazon Nova models.
Type union: either IResolvable or CfnPromptVersionPropsMixin.ISpecificToolChoiceProperty