Class CfnPromptPropsMixin.SpecificToolChoiceProperty

The model must request a specific tool.

Inheritance

object

CfnPromptPropsMixin.SpecificToolChoiceProperty

Implements

CfnPromptPropsMixin.ISpecificToolChoiceProperty

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 CfnPromptPropsMixin.SpecificToolChoiceProperty : CfnPromptPropsMixin.ISpecificToolChoiceProperty

Syntax (vb)

Public Class CfnPromptPropsMixin.SpecificToolChoiceProperty Implements CfnPromptPropsMixin.ISpecificToolChoiceProperty

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-specifictoolchoice.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 specificToolChoiceProperty = new SpecificToolChoiceProperty {
                 Name = "name"
             };

Synopsis

Constructors

SpecificToolChoiceProperty()

The model must request a specific tool.

Properties

Name	The name of the tool that the model must request.

Constructors

SpecificToolChoiceProperty()

The model must request a specific tool.

public SpecificToolChoiceProperty()

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-specifictoolchoice.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 specificToolChoiceProperty = new SpecificToolChoiceProperty {
                 Name = "name"
             };

Properties

Name

The name of the tool that the model must request.

public string? Name { get; set; }

Property Value

string

Remarks

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

Implements

CfnPromptPropsMixin.ISpecificToolChoiceProperty