Enum SourceLocation 

#[non_exhaustive]
pub enum SourceLocation {
    Document {
        index: Option<u32>,
        id: Option<String>,
        within: Option<DocumentRange>,
    },
    Url {
        url: String,
    },
    File {
        file_id: String,
        filename: Option<String>,
        container_id: Option<String>,
    },
    SearchResult {
        index: u32,
        source: String,
        blocks: Option<Range<u32>>,
    },
    ToolOutput {
        id: String,
    },
}

Where a cited source is.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Document

A document of the request, by position or id, and where in it.

Fields

index: Option<u32>

The document’s position in the request.

id: Option<String>

The document’s id.

within: Option<DocumentRange>

The part of the document cited.

Url

A web page.

Fields

url: String

The page’s address.

File

A file the provider stores.

Fields

file_id: String

The provider’s file id.

filename: Option<String>

The file’s name.

container_id: Option<String>

The container holding the file.

SearchResult

A search result the request supplied.

Fields

index: u32

The result’s position in the request.

source: String

The result’s source, as the request named it.

blocks: Option<Range<u32>>

The content blocks of the result cited.

ToolOutput

A tool’s output.

Fields

id: String

The tool call or output id.

Trait Implementations

impl Clone for SourceLocation

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 SourceLocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceLocation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SourceLocation

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SourceLocation

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 SourceLocation