Class: Aws::BedrockRuntime::Types::ToolSpecification

Inherits:

Struct

• Object
• Struct
• Aws::BedrockRuntime::Types::ToolSpecification

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockruntime/types.rb

Overview

The specification for the tool. For more information, see [Call a tool with the Converse API] in the Amazon Bedrock User Guide.

[1]: docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description for the tool.

• #input_schema ⇒ Types::ToolInputSchema

  The input schema for the tool in JSON format.

• #name ⇒ String

  The name for the tool.

Instance Attribute Details

#description ⇒ String

The description for the tool.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4447

class ToolSpecification < Struct.new(
  :name,
  :description,
  :input_schema)
  SENSITIVE = []
  include Aws::Structure
end

#input_schema ⇒ Types::ToolInputSchema

The input schema for the tool in JSON format.

Returns:

• (Types::ToolInputSchema)

# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4447

class ToolSpecification < Struct.new(
  :name,
  :description,
  :input_schema)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for the tool.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4447

class ToolSpecification < Struct.new(
  :name,
  :description,
  :input_schema)
  SENSITIVE = []
  include Aws::Structure
end