Class: Aws::BedrockRuntime::Types::CitationLocation

Inherits:

Struct

• Object
• Struct
• Aws::BedrockRuntime::Types::CitationLocation

Includes:

Structure, Structure::Union

Defined in:

lib/aws-sdk-bedrockruntime/types.rb

Overview

Note:

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

Note:

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

Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

See Also:

• AWS API Documentation

Direct Known Subclasses

DocumentChar, DocumentChunk, DocumentPage, SearchResultLocation, Unknown, Web

Defined Under Namespace

Classes: DocumentChar, DocumentChunk, DocumentPage, SearchResultLocation, Unknown, Web

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #document_char ⇒ Types::DocumentCharLocation

  The character-level location within the document where the cited content is found.

• #document_chunk ⇒ Types::DocumentChunkLocation

  The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

• #document_page ⇒ Types::DocumentPageLocation

  The page-level location within the document where the cited content is found.

• #search_result_location ⇒ Types::SearchResultLocation

  The search result location where the cited content is found, including the search result index and block positions within the content array.

• #unknown ⇒ Object

  Returns the value of attribute unknown.

• #web ⇒ Types::WebLocation

  The web URL that was cited for this reference.

Instance Attribute Details

#document_char ⇒ Types::DocumentCharLocation

The character-level location within the document where the cited content is found.

Returns:

• (Types::DocumentCharLocation)

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

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#document_chunk ⇒ Types::DocumentChunkLocation

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

Returns:

• (Types::DocumentChunkLocation)

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

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#document_page ⇒ Types::DocumentPageLocation

The page-level location within the document where the cited content is found.

Returns:

• (Types::DocumentPageLocation)

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

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#search_result_location ⇒ Types::SearchResultLocation

The search result location where the cited content is found, including the search result index and block positions within the content array.

Returns:

• (Types::SearchResultLocation)

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

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

• (Object) —

  the current value of unknown

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

def unknown
  @unknown
end

#web ⇒ Types::WebLocation

The web URL that was cited for this reference.

Returns:

• (Types::WebLocation)

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

class CitationLocation < Struct.new(
  :web,
  :document_char,
  :document_page,
  :document_chunk,
  :search_result_location,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Web < CitationLocation; end
  class DocumentChar < CitationLocation; end
  class DocumentPage < CitationLocation; end
  class DocumentChunk < CitationLocation; end
  class SearchResultLocation < CitationLocation; end
  class Unknown < CitationLocation; end
end