Class: Aws::BedrockRuntime::Types::Tool

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

Overview

Note:

Tool is a union - when making an API calls you must set exactly one of the members.

Information about a tool that you can use with the Converse API. 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:

Direct Known Subclasses

CachePoint, SystemTool, ToolSpec, Unknown

Defined Under Namespace

Classes: CachePoint, SystemTool, ToolSpec, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_point ⇒ Types::CachePointBlock

CachePoint to include in the tool configuration.

Returns:



4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4204

class Tool < Struct.new(
  :tool_spec,
  :system_tool,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ToolSpec < Tool; end
  class SystemTool < Tool; end
  class CachePoint < Tool; end
  class Unknown < Tool; end
end

#system_tool ⇒ Types::SystemTool

Specifies the system-defined tool that you want use.

Returns:



4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4204

class Tool < Struct.new(
  :tool_spec,
  :system_tool,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ToolSpec < Tool; end
  class SystemTool < Tool; end
  class CachePoint < Tool; end
  class Unknown < Tool; end
end

#tool_spec ⇒ Types::ToolSpecification

The specfication for the tool.

Returns:



4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4204

class Tool < Struct.new(
  :tool_spec,
  :system_tool,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ToolSpec < Tool; end
  class SystemTool < Tool; end
  class CachePoint < Tool; end
  class Unknown < Tool; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



4204
4205
4206
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 4204

def unknown
  @unknown
end