CitationLocationDict¶
Union Type¶
CitationLocationDict
module-attribute
¶
CitationLocationDict = Union[CitationLocationWebDict | CitationLocationDocumentCharDict | CitationLocationDocumentPageDict | CitationLocationDocumentChunkDict | CitationLocationSearchResultLocationDict]
Dictionary form of CitationLocation, setting exactly one variant.
Union Member Types¶
CitationLocationWebDict
¶
Bases: TypedDict
Attributes¶
web
instance-attribute
¶
web: WebLocation | WebLocationDict
The web URL that was cited for this reference.
CitationLocationDocumentCharDict
¶
Bases: TypedDict
Attributes¶
document_char
instance-attribute
¶
document_char: DocumentCharLocation | DocumentCharLocationDict
The character-level location within the document where the cited content is found.
CitationLocationDocumentPageDict
¶
Bases: TypedDict
Attributes¶
document_page
instance-attribute
¶
document_page: DocumentPageLocation | DocumentPageLocationDict
The page-level location within the document where the cited content is found.
CitationLocationDocumentChunkDict
¶
Bases: TypedDict
Attributes¶
document_chunk
instance-attribute
¶
document_chunk: DocumentChunkLocation | DocumentChunkLocationDict
The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.
CitationLocationSearchResultLocationDict
¶
Bases: TypedDict
Attributes¶
search_result_location
instance-attribute
¶
search_result_location: SearchResultLocation | SearchResultLocationDict
The search result location where the cited content is found, including the search result index and block positions within the content array.