Struct Annotations

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

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

JSON schema

{
 "description": "Optional annotations for the client. The client can use annotations to inform how objects are used or displayed",
 "type": "object",
 "properties": {
   "audience": {
     "description": "Describes who the intended customer of this object or data is.\n\nIt can include multiple entries to indicate content useful for multiple audiences (e.g., [\"user\", \"assistant\"]).",
     "type": "array",
     "items": {
       "$ref": "#/definitions/Role"
     }
   },
   "priority": {
     "description": "Describes how important this data is for operating the server.\n\nA value of 1 means \"most important,\" and indicates that the data is\neffectively required, while 0 means \"least important,\" and indicates that\nthe data is entirely optional.",
     "type": "number",
     "maximum": 1.0,
     "minimum": 0.0
   }
 }
}

Fields

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

Trait Implementations

impl Clone for Annotations

fn clone(&self) -> Annotations

Returns a copy 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 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.