Struct SourceCitation 

pub struct SourceCitation { /* private fields */ }

A normalized citation associated with assistant text and an external source.

Implementations

impl SourceCitation

pub fn new(source: ExternalSource) -> Self

Creates a citation with no text range or provider continuation.

pub const fn with_tool_call_id(self, tool_call_id: ToolCallId) -> Self

Links the citation to one hosted tool activity.

pub fn with_range( self, start_index: u32, end_index: u32, ) -> Result<Self, ExternalContentError>

Adds a half-open UTF-8 byte range in the associated assistant text.

Errors

Returns an error when the range is empty or reversed.

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

Adds bounded provider-supplied cited text.

Errors

Returns an error for empty, oversized, or null-containing text.

pub fn with_continuation(self, continuation: ProviderContinuation) -> Self

Adds opaque provider citation state for same-provider continuation.

pub const fn tool_call_id(&self) -> Option<ToolCallId>

Returns the linked hosted tool activity, when known.

pub const fn source(&self) -> &ExternalSource

Returns the normalized cited source.

pub const fn range(&self) -> Option<(u32, u32)>

Returns the optional half-open text range.

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

Returns optional cited text supplied by the provider.

pub const fn continuation(&self) -> Option<&ProviderContinuation>

Returns opaque provider citation state.

Trait Implementations

impl Clone for SourceCitation

fn clone(&self) -> SourceCitation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceCitation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceCitation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SourceCitation

impl PartialEq for SourceCitation

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SourceCitation

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 SourceCitation