Class CfnPromptPropsMixin.ToolProperty

Information about a tool that you can use with the Converse API.

Inheritance

object

CfnPromptPropsMixin.ToolProperty

Implements

CfnPromptPropsMixin.IToolProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Bedrock

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnPromptPropsMixin.ToolProperty : CfnPromptPropsMixin.IToolProperty

Syntax (vb)

Public Class CfnPromptPropsMixin.ToolProperty Implements CfnPromptPropsMixin.IToolProperty

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-prompt-tool.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.CfnPropertyMixins.AWS.Bedrock;

             var json;

             var toolProperty = new ToolProperty {
                 CachePoint = new CachePointBlockProperty {
                     Type = "type"
                 },
                 ToolSpec = new ToolSpecificationProperty {
                     Description = "description",
                     InputSchema = new ToolInputSchemaProperty {
                         Json = json
                     },
                     Name = "name"
                 }
             };

Synopsis

Constructors

ToolProperty()

Information about a tool that you can use with the Converse API.

Properties

CachePoint	CachePoint to include in the tool configuration.
ToolSpec	The specfication for the tool.

Constructors

ToolProperty()

Information about a tool that you can use with the Converse API.

public ToolProperty()

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-prompt-tool.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.CfnPropertyMixins.AWS.Bedrock;

             var json;

             var toolProperty = new ToolProperty {
                 CachePoint = new CachePointBlockProperty {
                     Type = "type"
                 },
                 ToolSpec = new ToolSpecificationProperty {
                     Description = "description",
                     InputSchema = new ToolInputSchemaProperty {
                         Json = json
                     },
                     Name = "name"
                 }
             };

Properties

CachePoint

CachePoint to include in the tool configuration.

public object? CachePoint { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnPromptPropsMixin.ICachePointBlockProperty

ToolSpec

The specfication for the tool.

public object? ToolSpec { get; set; }