Struct ImageContent

pub struct ImageContent {
    pub annotations: Option<ImageContentAnnotations>,
    pub data: String,
    pub mime_type: String,
    /* private fields */
}

An image provided to or from an LLM.

JSON schema

{
 "description": "An image provided to or from an LLM.",
 "type": "object",
 "required": [
   "data",
   "mimeType",
   "type"
 ],
 "properties": {
   "annotations": {
     "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
       }
     }
   },
   "data": {
     "description": "The base64-encoded image data.",
     "type": "string",
     "format": "byte"
   },
   "mimeType": {
     "description": "The MIME type of the image. Different providers may support different image types.",
     "type": "string"
   },
   "type": {
     "type": "string",
     "const": "image"
   }
 }
}

Fields

annotations: Option<ImageContentAnnotations>

data: String

The base64-encoded image data.

mime_type: String

The MIME type of the image. Different providers may support different image types.

Implementations

impl ImageContent

pub fn new( data: String, mime_type: String, annotations: Option<ImageContentAnnotations>, ) -> Self

pub fn type_(&self) -> &String

pub fn type_name() -> String

Trait Implementations

impl Clone for ImageContent

fn clone(&self) -> ImageContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ImageContent> for CallToolResultContentItem

fn from(value: ImageContent) -> Self

Converts to this type from the input type.

impl From<ImageContent> for CreateMessageResultContent

fn from(value: ImageContent) -> Self

Converts to this type from the input type.

impl From<ImageContent> for PromptMessageContent

fn from(value: ImageContent) -> Self

Converts to this type from the input type.

impl From<ImageContent> for SamplingMessageContent

fn from(value: ImageContent) -> Self

Converts to this type from the input type.

impl Serialize for ImageContent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.