Show / Hide Table of Contents

Class CfnPromptVersionPropsMixin.ToolChoiceProperty

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

Inheritance
object
CfnPromptVersionPropsMixin.ToolChoiceProperty
Implements
CfnPromptVersionPropsMixin.IToolChoiceProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-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.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 Converse or ConverseStream .

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-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.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

object

Remarks

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

Auto

(Default).

public object? Auto { get; set; }
Property Value

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-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-auto

Tool

The Model must request the specified tool.

public object? Tool { get; set; }
Property Value

object

Remarks

Only supported by Anthropic Claude 3 and Amazon Nova models.

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

Type union: either IResolvable or CfnPromptVersionPropsMixin.ISpecificToolChoiceProperty

Implements

CfnPromptVersionPropsMixin.IToolChoiceProperty
Back to top Generated by DocFX