Enum Annotation 

pub enum Annotation {
    FileCitation {
        text: String,
        file_citation: FileCitationAnnotation,
        start_index: u32,
        end_index: u32,
    },
    UrlCitation {
        url: String,
        title: String,
        start_index: u32,
        end_index: u32,
    },
    FilePath {
        text: String,
        file_path: FilePathAnnotation,
        start_index: u32,
        end_index: u32,
    },
}

Represents annotations embedded within output text content. These annotations provide context or references for parts of the text.

Used By

• OutputContentPart::Text
• MessageContentTextObject (within assistants_shared.rs)
• MessageDeltaTextContent (within assistants_shared.rs)
• ResponseTextAnnotationDeltaEvent (within realtime_shared.rs)

Variants

FileCitation

A citation within the message that points to a specific quote from a specific File.

Fields

text: String

The text in the message content that needs to be replaced.

file_citation: FileCitationAnnotation

The details of the file citation.

start_index: u32

The start index of the citation in the text.

end_index: u32

The end index of the citation in the text.

UrlCitation

A citation for a web resource used to generate a model response.

Fields

url: String

The URL of the web resource.

title: String

The title of the web resource.

start_index: u32

The start index of the citation in the text.

end_index: u32

The end index of the citation in the text.

FilePath

A URL for the file that’s generated when the assistant used the code_interpreter tool.

Fields

text: String

The text in the message content that needs to be replaced.

file_path: FilePathAnnotation

The details of the file path.

start_index: u32

The start index of the file path in the text.

end_index: u32

The end index of the file path in the text.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Annotation

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Annotation

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

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 Annotation