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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockRuntime::Types::ToolResultContentBlock

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. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

See Also:

• AWS API Documentation

Direct Known Subclasses

Document, Image, Json, SearchResult, Text, Unknown, Video

Defined Under Namespace

Classes: Document, Image, Json, SearchResult, Text, Unknown, Video

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #document ⇒ Types::DocumentBlock

  A tool result that is a document.

• #image ⇒ Types::ImageBlock

  A tool result that is an image.

• #json ⇒ Hash, ...

  A tool result that is JSON format data.

• #search_result ⇒ Types::SearchResultBlock

  A tool result that is a search result.

• #text ⇒ String

  A tool result that is text.

• #unknown ⇒ Object

  Returns the value of attribute unknown.

• #video ⇒ Types::VideoBlock

  A tool result that is video.

Instance Attribute Details

#document ⇒ Types::DocumentBlock

A tool result that is a document.

Returns:

• (Types::DocumentBlock)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4602

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :video,
  :search_result,
  :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 Video < ToolResultContentBlock; end
  class SearchResult < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#image ⇒ Types::ImageBlock

A tool result that is an image.

This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

Returns:

• (Types::ImageBlock)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4602

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :video,
  :search_result,
  :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 Video < ToolResultContentBlock; end
  class SearchResult < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#json ⇒ Hash, ...

A tool result that is JSON format data.

Returns:

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

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4602

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :video,
  :search_result,
  :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 Video < ToolResultContentBlock; end
  class SearchResult < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#search_result ⇒ Types::SearchResultBlock

A tool result that is a search result.

Returns:

• (Types::SearchResultBlock)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4602

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :video,
  :search_result,
  :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 Video < ToolResultContentBlock; end
  class SearchResult < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#text ⇒ String

A tool result that is text.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4602

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :video,
  :search_result,
  :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 Video < ToolResultContentBlock; end
  class SearchResult < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

• (Object) —

  the current value of unknown

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4602

def unknown
  @unknown
end

#video ⇒ Types::VideoBlock

A tool result that is video.

Returns:

• (Types::VideoBlock)

# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 4602

class ToolResultContentBlock < Struct.new(
  :json,
  :text,
  :image,
  :document,
  :video,
  :search_result,
  :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 Video < ToolResultContentBlock; end
  class SearchResult < ToolResultContentBlock; end
  class Unknown < ToolResultContentBlock; end
end