Enum CitationLocation 

#[non_exhaustive]
pub enum CitationLocation {
    DocumentChar(DocumentCharLocation),
    DocumentChunk(DocumentChunkLocation),
    DocumentPage(DocumentPageLocation),
    #[non_exhaustive]
    Unknown,
}

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.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DocumentChar(DocumentCharLocation)

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

DocumentChunk(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.

DocumentPage(DocumentPageLocation)

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

#[non_exhaustive]

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl CitationLocation

pub fn as_document_char(&self) -> Result<&DocumentCharLocation, &Self>

Tries to convert the enum instance into DocumentChar, extracting the inner DocumentCharLocation. Returns Err(&Self) if it can’t be converted.

pub fn is_document_char(&self) -> bool

Returns true if this is a DocumentChar.

pub fn as_document_chunk(&self) -> Result<&DocumentChunkLocation, &Self>

Tries to convert the enum instance into DocumentChunk, extracting the inner DocumentChunkLocation. Returns Err(&Self) if it can’t be converted.

pub fn is_document_chunk(&self) -> bool

Returns true if this is a DocumentChunk.

pub fn as_document_page(&self) -> Result<&DocumentPageLocation, &Self>

Tries to convert the enum instance into DocumentPage, extracting the inner DocumentPageLocation. Returns Err(&Self) if it can’t be converted.

pub fn is_document_page(&self) -> bool

Returns true if this is a DocumentPage.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for CitationLocation

fn clone(&self) -> CitationLocation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CitationLocation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CitationLocation

fn eq(&self, other: &CitationLocation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CitationLocation