Struct CitableSource 

pub struct CitableSource {
    pub content: String,
    pub id: String,
    pub path: Option<String>,
    pub title: Option<String>,
    pub url: Option<String>,
}

A source supplied by a tool that should be made available to the model as citable content.

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

Fields

content: String

The source text made available to the model as citable content.

id: String

Stable identifier for this source within the tool result. Used for deduplication and may be used by future provider integrations to correlate response citations back to the originating source.

path: Option<String>

File path relative to the agent’s workspace root, when the source is a file.

title: Option<String>

Human-readable title of the source.

url: Option<String>

URL of the source, when it is a web resource.

Trait Implementations

impl Clone for CitableSource

fn clone(&self) -> CitableSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CitableSource

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

Formats the value using the given formatter.

impl Default for CitableSource

fn default() -> CitableSource

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CitableSource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CitableSource

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

where __S: Serializer,

Serialize this value into the given Serde serializer.