Interface CfnPrompt.IToolSpecificationProperty

The specification for the tool.

Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IToolSpecificationProperty
Syntax (vb)
Public Interface IToolSpecificationProperty
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-toolspecification.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.Aws_bedrock;

var json;

var toolSpecificationProperty = new ToolSpecificationProperty {
    InputSchema = new ToolInputSchemaProperty {
        Json = json
    },
    Name = "name",

    // the properties below are optional
    Description = "description"
};

Synopsis

Properties

Description

The description for the tool.
InputSchema

The input schema for the tool in JSON format.
Name

The name for the tool.

Properties

Description

The description for the tool.

virtual string Description { get; }
Property Value

System.String

Remarks

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

InputSchema

The input schema for the tool in JSON format.

object InputSchema { get; }
Property Value

System.Object

Remarks

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

Name

The name for the tool.

string Name { get; }
Property Value

System.String

Remarks

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