Class: Aws::BedrockRuntime::Types::ToolResultContentBlock

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

Overview

Note:

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

Note:

ToolResultContentBlock is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ToolResultContentBlock corresponding to the set member.

The tool result content block.

Direct Known Subclasses

Document, Image, Json, Text, Unknown

Defined Under Namespace

Classes: Document, Image, Json, Text, Unknown

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#documentTypes::DocumentBlock

A tool result that is a document.



2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2109

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Json < ToolResultContentBlock; end
  class Text < ToolResultContentBlock; end
  class Image < ToolResultContentBlock; end
  class Document < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#imageTypes::ImageBlock

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

Returns:



2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2109

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Json < ToolResultContentBlock; end
  class Text < ToolResultContentBlock; end
  class Image < ToolResultContentBlock; end
  class Document < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#jsonHash, ...

A tool result that is JSON format data.

Returns:

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


2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2109

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Json < ToolResultContentBlock; end
  class Text < ToolResultContentBlock; end
  class Image < ToolResultContentBlock; end
  class Document < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#textString

A tool result that is text.

Returns:

  • (String)


2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2109

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Json < ToolResultContentBlock; end
  class Text < ToolResultContentBlock; end
  class Image < ToolResultContentBlock; end
  class Document < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#unknownObject

Returns the value of attribute unknown

Returns:

  • (Object)

    the current value of unknown



2109
2110
2111
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2109

def unknown
  @unknown
end