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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockruntime/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.

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:



4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4343

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:



4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4343

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:



4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4343

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



4343
4344
4345
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4343

def unknown
  @unknown
end