Struct CitationsDelta 

#[non_exhaustive]
pub struct CitationsDelta {
    pub title: Option<String>,
    pub source_content: Option<Vec<CitationSourceContentDelta>>,
    pub location: Option<CitationLocation>,
}

Contains incremental updates to citation information during streaming responses. This allows clients to build up citation data progressively as the response is generated.

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.

title: Option<String>

The title or identifier of the source document being cited.

source_content: Option<Vec<CitationSourceContentDelta>>

The specific content from the source document that was referenced or cited in the generated response.

location: Option<CitationLocation>

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.

Implementations

impl CitationsDelta

pub fn title(&self) -> Option<&str>

The title or identifier of the source document being cited.

pub fn source_content(&self) -> &[CitationSourceContentDelta]

The specific content from the source document that was referenced or cited in the generated response.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .source_content.is_none().

pub fn location(&self) -> Option<&CitationLocation>

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.

impl CitationsDelta

pub fn builder() -> CitationsDeltaBuilder

Creates a new builder-style object to manufacture CitationsDelta.

Trait Implementations

impl Clone for CitationsDelta

fn clone(&self) -> CitationsDelta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CitationsDelta

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

Formats the value using the given formatter.

impl PartialEq for CitationsDelta

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