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.

See Also:

Direct Known Subclasses

Document, Image, Json, Text, Unknown, Video

Defined Under Namespace

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ Types::DocumentBlock

A tool result that is a document.

Returns:



2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2950

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

#image ⇒ Types::ImageBlock

A tool result that is an image.

This field is only supported by Anthropic Claude 3 models.

Returns:



2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2950

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

#json ⇒ Hash, ...

A tool result that is JSON format data.

Returns:

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


2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2950

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

#text ⇒ String

A tool result that is text.

Returns:

  • (String) 


2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2950

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

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



2950
2951
2952
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2950

def unknown
  @unknown
end

#video ⇒ Types::VideoBlock

A tool result that is video.

Returns:



2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 2950

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