Class CfnPromptPropsMixin.ToolConfigurationProperty

Configuration information for the tools that you pass to a model.

Inheritance

object

CfnPromptPropsMixin.ToolConfigurationProperty

Implements

CfnPromptPropsMixin.IToolConfigurationProperty

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.ToolConfigurationProperty : CfnPromptPropsMixin.IToolConfigurationProperty

Syntax (vb)

Public Class CfnPromptPropsMixin.ToolConfigurationProperty Implements CfnPromptPropsMixin.IToolConfigurationProperty

Remarks

For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

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

             var toolConfigurationProperty = new ToolConfigurationProperty {
                 ToolChoice = new ToolChoiceProperty {
                     Any = any,
                     Auto = auto,
                     Tool = new SpecificToolChoiceProperty {
                         Name = "name"
                     }
                 },
                 Tools = new [] { new ToolProperty {
                     CachePoint = new CachePointBlockProperty {
                         Type = "type"
                     },
                     ToolSpec = new ToolSpecificationProperty {
                         Description = "description",
                         InputSchema = new ToolInputSchemaProperty {
                             Json = json
                         },
                         Name = "name"
                     }
                 } }
             };

Synopsis

Constructors

ToolConfigurationProperty()

Configuration information for the tools that you pass to a model.

Properties

ToolChoice	If supported by model, forces the model to request a tool.
Tools	An array of tools that you want to pass to a model.

Constructors

ToolConfigurationProperty()

Configuration information for the tools that you pass to a model.

public ToolConfigurationProperty()

Remarks

For more information, see Tool use (function calling) in the Amazon Bedrock User Guide.

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

             var toolConfigurationProperty = new ToolConfigurationProperty {
                 ToolChoice = new ToolChoiceProperty {
                     Any = any,
                     Auto = auto,
                     Tool = new SpecificToolChoiceProperty {
                         Name = "name"
                     }
                 },
                 Tools = new [] { new ToolProperty {
                     CachePoint = new CachePointBlockProperty {
                         Type = "type"
                     },
                     ToolSpec = new ToolSpecificationProperty {
                         Description = "description",
                         InputSchema = new ToolInputSchemaProperty {
                             Json = json
                         },
                         Name = "name"
                     }
                 } }
             };

Properties

ToolChoice

If supported by model, forces the model to request a tool.

public object? ToolChoice { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnPromptPropsMixin.IToolChoiceProperty

Tools

An array of tools that you want to pass to a model.

public object? Tools { get; set; }