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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

The description for the tool.

Returns:

  • (String) 


4791
4792
4793
4794
4795
4796
4797
4798
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4791

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

#input_schema ⇒ Types::ToolInputSchema

The input schema for the tool in JSON format.

Returns:



4791
4792
4793
4794
4795
4796
4797
4798
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4791

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

#name ⇒ String

The name for the tool.

Returns:

  • (String) 


4791
4792
4793
4794
4795
4796
4797
4798
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4791

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

#strict ⇒ Boolean

Flag to enable structured output enforcement on a tool usage response.

Returns:

  • (Boolean) 


4791
4792
4793
4794
4795
4796
4797
4798
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4791

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