Struct Annotations 

pub struct Annotations {
    pub audience: Option<Vec<Role>>,
    pub priority: Option<f64>,
}

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

Fields

audience: Option<Vec<Role>>

Describes who the intended customer of this object or data is.

It can include multiple entries to indicate content useful for multiple audiences (e.g., ["user", "assistant"]).

priority: Option<f64>

Describes how important this data is for operating the server.

A value of 1 means “most important,” and indicates that the data is effectively required, while 0 means “least important,” and indicates that the data is entirely optional.

Implementations

impl Annotations

pub fn new() -> Self

Create new empty annotations

pub fn with_audience(audience: Vec<Role>) -> Self

Create new annotations with audience

pub fn with_priority(priority: f64) -> Self

Create new annotations with priority

pub fn with_audience_and_priority(audience: Vec<Role>, priority: f64) -> Self

Create new annotations with audience and priority

pub fn add_audience(&mut self, role: Role)

Add an audience role to the annotations

pub fn set_priority(&mut self, priority: f64)

Set the priority of the annotations

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 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