Class: Aws::BedrockRuntime::Types::DocumentSource

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

Overview

Note:

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

Note:

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

Contains the content of a document.

See Also:

Direct Known Subclasses

Bytes, Content, S3Location, Text, Unknown

Defined Under Namespace

Classes: Bytes, Content, S3Location, Text, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bytes ⇒ String

The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.

Returns:

  • (String) 


1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1707

class DocumentSource < Struct.new(
  :bytes,
  :s3_location,
  :text,
  :content,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < DocumentSource; end
  class S3Location < DocumentSource; end
  class Text < DocumentSource; end
  class Content < DocumentSource; end
  class Unknown < DocumentSource; end
end

#content ⇒ Array<Types::DocumentContentBlock>

The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

Returns:



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1707

class DocumentSource < Struct.new(
  :bytes,
  :s3_location,
  :text,
  :content,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < DocumentSource; end
  class S3Location < DocumentSource; end
  class Text < DocumentSource; end
  class Content < DocumentSource; end
  class Unknown < DocumentSource; end
end

#s3_location ⇒ Types::S3Location

The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

Returns:



1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1707

class DocumentSource < Struct.new(
  :bytes,
  :s3_location,
  :text,
  :content,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < DocumentSource; end
  class S3Location < DocumentSource; end
  class Text < DocumentSource; end
  class Content < DocumentSource; end
  class Unknown < DocumentSource; end
end

#text ⇒ String

The text content of the document source.

Returns:

  • (String) 


1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1707

class DocumentSource < Struct.new(
  :bytes,
  :s3_location,
  :text,
  :content,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Bytes < DocumentSource; end
  class S3Location < DocumentSource; end
  class Text < DocumentSource; end
  class Content < DocumentSource; end
  class Unknown < DocumentSource; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



1707
1708
1709
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 1707

def unknown
  @unknown
end