Struct Citation 

#[non_exhaustive]
pub struct Citation {
    pub source: CitationSource,
    pub span: Option<Range<usize>>,
    pub cited_text: Option<String>,
    pub provider_data: ProviderData,
}

A link from generated text to a source that supports it.

Citations annotate Text blocks of model output (see ADR 0007). They are read-only views: adapters replay the provider’s own annotations, kept in the block’s provider data, rather than re-encoding this list.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

source: CitationSource

What is cited.

span: Option<Range<usize>>

The supported part of the text, as a byte range into Text::text. None means the whole block.

cited_text: Option<String>

The quoted passage from the source, when the provider reports it.

provider_data: ProviderData

Provider-specific details (page numbers, indexes, confidence).

Implementations

impl Citation

pub fn new(source: CitationSource) -> Self

Cite source for the whole text block.

pub fn with_span(self, span: Range<usize>) -> Self

Limit the citation to a byte range of the text.

pub fn with_cited_text(self, cited_text: impl Into<String>) -> Self

Set the quoted source passage.

pub fn with_provider_data(self, provider_data: ProviderData) -> Self

Attach provider data.

Trait Implementations

impl Clone for Citation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Citation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Citation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Citation

impl Hash for Citation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Citation

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Citation

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 Citation