Enum Annotation 

pub enum Annotation {
    FileCitation {
        file_id: String,
        filename: String,
        index: u32,
    },
    UrlCitation {
        url: String,
        title: String,
        start_index: u32,
        end_index: u32,
    },
    ContainerFileCitation {
        container_id: String,
        file_id: String,
        filename: String,
        start_index: u32,
        end_index: u32,
    },
    FilePath {
        file_id: String,
        index: u32,
    },
}

Typed annotation attached to ResponseContentPart::OutputText. Matches the OpenAI Responses API Annotation union; a type discriminator selects the variant on the wire.

Variants

FileCitation

type: "file_citation" — points at a file previously uploaded.

Fields

file_id: String

filename: String

index: u32

UrlCitation

type: "url_citation" — citation back to a URL in a web-search result.

Fields

url: String

title: String

start_index: u32

end_index: u32

ContainerFileCitation

type: "container_file_citation" — citation to a file inside a code-interpreter / computer-use container.

Fields

container_id: String

file_id: String

filename: String

start_index: u32

end_index: u32

FilePath

type: "file_path" — reference to a generated file path.

Fields

file_id: String

index: u32

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 JsonSchema for Annotation

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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.