Struct FileCitation 

pub struct FileCitation {

    pub citation_id: Option<String>,
    pub index: Option<u32>,
    pub document_id: String,
    pub document_name: String,
    pub document_title: Option<String>,
    pub source: Option<String>,
    pub quote: String,
    pub char_start: Option<i64>,
    pub char_end: Option<i64>,
    pub chunk_id: Option<String>,
    pub chunk_preview: Option<String>,
    pub chunk_content: Option<String>,
    pub chunk_type: String,
    pub page: Option<i32>,
    pub timestamp: Option<f64>,
    pub highlights: Vec<Value>,
    pub reference_type: Option<String>,
    pub text_positions: Vec<u32>,
    pub text_position_anchors: Vec<TextPositionAnchor>,
    pub meta: Option<Value>,
}

A citation into a retrieved document, attached to a text message part.

Supplied by the backend plugin and stored verbatim — Chat Engine does not generate or interpret citations. index matches a [N] marker in the part text (1-indexed), sharing one namespace with LinkCitation.

Fields

citation_id: Option<String>

Plugin-assigned id, unique per message.

index: Option<u32>

Matches the [N] token in the part text (1-indexed).

document_id: String

Source document id.

document_name: String

Source document name.

document_title: Option<String>

Human-readable document title, when known.

source: Option<String>

Document source / venue, when known.

quote: String

Quoted text from the document.

char_start: Option<i64>

Zero-indexed start offset into the source plain text.

char_end: Option<i64>

Exclusive end offset into the source plain text.

chunk_id: Option<String>

Source chunk identifier.

chunk_preview: Option<String>

First ~200 chars of the chunk, for hover.

chunk_content: Option<String>

Full chunk body (text) or image URL (when chunk_type = "image").

chunk_type: String

Content type of the cited chunk: "text" (default) or "image".

page: Option<i32>

Source page number (1-indexed), when applicable.

timestamp: Option<f64>

Video timestamp in seconds, when applicable.

highlights: Vec<Value>

Highlighted spans within the cited chunk (plugin-defined shape).

reference_type: Option<String>

direct_quote / paraphrase / data_reference / methodology_reference.

text_positions: Vec<u32>

Character offsets in the part text where this citation’s [index] marker appears. Pre-computed by the plugin; the engine forwards them verbatim.

text_position_anchors: Vec<TextPositionAnchor>

Per-marker source anchors, parallel to text_positions.

meta: Option<Value>

Opaque plugin metadata; forwarded but not interpreted.

Trait Implementations

impl Clone for FileCitation

fn clone(&self) -> FileCitation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileCitation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileCitation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileCitation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.