Enum TextCitation 

pub enum TextCitation {
    CharLocation {
        cited_text: String,
        document_index: usize,
        document_title: Option<String>,
        start_char_index: usize,
        end_char_index: usize,
    },
    PageLocation {
        cited_text: String,
        document_index: usize,
        document_title: Option<String>,
        start_page_number: usize,
        end_page_number: usize,
    },
    ContentBlockLocation {
        cited_text: String,
        document_index: usize,
        document_title: Option<String>,
        start_block_index: usize,
        end_block_index: usize,
    },
    WebSearchResultLocation {
        cited_text: String,
        encrypted_index: String,
        title: Option<String>,
        url: String,
    },
}

Citation information for text blocks.

Citations provide source attribution for generated text, with different types depending on the source document.

Variants

CharLocation

Citation pointing to character locations in plain text.

Fields

cited_text: String

The text being cited

document_index: usize

Index of the source document

document_title: Option<String>

Title of the source document (may be null)

start_char_index: usize

Starting character index

end_char_index: usize

Ending character index

PageLocation

Citation pointing to page locations in PDFs.

Fields

cited_text: String

The text being cited

document_index: usize

Index of the source document

document_title: Option<String>

Title of the source document (may be null)

start_page_number: usize

Starting page number

end_page_number: usize

Ending page number

ContentBlockLocation

Citation pointing to content block locations.

Fields

cited_text: String

The text being cited

document_index: usize

Index of the source document

document_title: Option<String>

Title of the source document (may be null)

start_block_index: usize

Starting content block index

end_block_index: usize

Ending content block index

WebSearchResultLocation

Citation pointing to web search results.

Fields

cited_text: String

The text being cited

encrypted_index: String

Encrypted index for the search result

title: Option<String>

Title of the web page (may be null)

url: String

URL of the web page

Trait Implementations

impl Clone for TextCitation

fn clone(&self) -> TextCitation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextCitation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextCitation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TextCitation

fn eq(&self, other: &TextCitation) -> 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 Serialize for TextCitation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextCitation