Class: Aws::BedrockRuntime::Types::ToolUseBlock

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrockruntime/types.rb

Overview

A tool use content block. Contains information about a tool that the model is requesting be run., The model uses the result from the tool to generate a response. 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

#input ⇒ Hash, ...

The input to pass to the tool.

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


4372
4373
4374
4375
4376
4377
4378
4379
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4372

class ToolUseBlock < Struct.new(
  :tool_use_id,
  :name,
  :input,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the tool that the model wants to use.

Returns:

  • (String) 


4372
4373
4374
4375
4376
4377
4378
4379
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4372

class ToolUseBlock < Struct.new(
  :tool_use_id,
  :name,
  :input,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#tool_use_id ⇒ String

The ID for the tool request.

Returns:

  • (String) 


4372
4373
4374
4375
4376
4377
4378
4379
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4372

class ToolUseBlock < Struct.new(
  :tool_use_id,
  :name,
  :input,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type for the tool request.

Returns:

  • (String) 


4372
4373
4374
4375
4376
4377
4378
4379
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4372

class ToolUseBlock < Struct.new(
  :tool_use_id,
  :name,
  :input,
  :type)
  SENSITIVE = []
  include Aws::Structure
end