Struct Annotations 

#[non_exhaustive]
pub struct Annotations {
    pub audience: Option<Vec<Role>>,
    pub last_modified: Option<String>,
    pub priority: Option<f64>,
    pub meta: Option<Meta>,
}

Optional annotations for the client. The client can use annotations to inform how objects are used or displayed

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

audience: Option<Vec<Role>>

Intended recipients for this content, such as the user or assistant.

last_modified: Option<String>

Timestamp indicating when the underlying resource was last modified.

priority: Option<f64>

Relative importance of this content when clients choose what to surface.

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl Annotations

pub fn new() -> Self

Creates annotations with no audience, priority, or timestamp hints set.

pub fn audience(self, audience: impl IntoOption<Vec<Role>>) -> Self

Sets or clears the optional audience field.

pub fn last_modified(self, last_modified: impl IntoOption<String>) -> Self

Sets or clears the optional lastModified field.

pub fn priority(self, priority: impl IntoOption<f64>) -> Self

Sets or clears the optional priority field.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for Annotations

fn clone(&self) -> Annotations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotations

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

Formats the value using the given formatter.

impl Default for Annotations

fn default() -> Annotations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Annotations

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV2 for Annotations

Available on crate feature unstable_protocol_v2 only.

type Output = Annotations

The corresponding v2 draft type.

fn into_v2(self) -> Result<Self::Output>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for Annotations

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Annotations

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

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 Annotations