Struct CitationReference 

pub struct CitationReference {
    pub cited_text: Option<String>,
    pub location: Option<Value>,
    pub provider_metadata: Option<Value>,
    pub source_id: String,
}

A single citation occurrence linking a span of generated text to a supporting source.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

cited_text: Option<String>

The exact text from the source that supports the cited span, when provided by the model.

location: Option<Value>

Location within the source that supports the cited span, when the provider reports one.

provider_metadata: Option<Value>

Provider-native citation correlation data (e.g. Anthropic search_result_index / document_index), passed through opaquely for debugging and forward compatibility.

source_id: String

Identifier of the CitationSource this reference points to (CitationSource.id).

Trait Implementations

impl Clone for CitationReference

fn clone(&self) -> CitationReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CitationReference

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

Formats the value using the given formatter.

impl Default for CitationReference

fn default() -> CitationReference

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CitationReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CitationReference

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

where __S: Serializer,

Serialize this value into the given Serde serializer.