Bedrock Runtime  >  Unions  >  CitationLocation

CitationLocation

Union Type

CitationLocation module-attribute

CitationLocation = Union[CitationLocationWeb | CitationLocationDocumentChar | CitationLocationDocumentPage | CitationLocationDocumentChunk | CitationLocationSearchResultLocation | CitationLocationUnknown]

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.

Union Member Types

CitationLocationWeb dataclass

The web URL that was cited for this reference.

Attributes

value instance-attribute

value: WebLocation

CitationLocationDocumentChar dataclass

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

Attributes

value instance-attribute

value: DocumentCharLocation

CitationLocationDocumentPage dataclass

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

Attributes

value instance-attribute

value: DocumentPageLocation

CitationLocationDocumentChunk dataclass

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

Attributes

value instance-attribute

value: DocumentChunkLocation

CitationLocationSearchResultLocation dataclass

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

Attributes

value instance-attribute

value: SearchResultLocation

CitationLocationUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Attributes

tag instance-attribute

tag: str