Struct EmbeddedResource

pub struct EmbeddedResource {
    pub annotations: Option<Annotations>,
    pub resource: EmbeddedResourceResource,
    pub type_: String,
}

The contents of a resource, embedded into a prompt or tool call result.

It is up to the client how best to render embedded resources for the benefit of the LLM and/or the user.

JSON schema

{
 "description": "The contents of a resource, embedded into a prompt or tool call result.\n\nIt is up to the client how best to render embedded resources for the benefit\nof the LLM and/or the user.",
 "type": "object",
 "required": [
   "resource",
   "type"
 ],
 "properties": {
   "annotations": {
     "description": "Optional annotations for the client.",
     "$ref": "#/definitions/Annotations"
   },
   "resource": {
     "anyOf": [
       {
         "$ref": "#/definitions/TextResourceContents"
       },
       {
         "$ref": "#/definitions/BlobResourceContents"
       }
     ]
   },
   "type": {
     "type": "string",
     "const": "resource"
   }
 }
}

Fields

annotations: Option<Annotations>

Optional annotations for the client.

resource: EmbeddedResourceResource

type_: String

Implementations

impl EmbeddedResource

pub fn new(resource: impl Into<EmbeddedResourceResource>) -> Self

Trait Implementations

impl Clone for EmbeddedResource

fn clone(&self) -> EmbeddedResource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddedResource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmbeddedResource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&EmbeddedResource> for CallToolResult

fn from(value: &EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<&EmbeddedResource> for CallToolResultContentItem

fn from(value: &EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<&EmbeddedResource> for EmbeddedResource

fn from(value: &EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<&EmbeddedResource> for GetPromptResult

fn from(value: &EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<&EmbeddedResource> for PromptMessage

fn from(value: &EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<&EmbeddedResource> for PromptMessageContent

fn from(value: &EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<&EmbeddedResource> for ServerResult

fn from(value: &EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<EmbeddedResource> for CallToolResult

fn from(value: EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<EmbeddedResource> for CallToolResultContentItem

fn from(value: EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<EmbeddedResource> for GetPromptResult

fn from(value: EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<EmbeddedResource> for PromptMessage

fn from(value: EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<EmbeddedResource> for PromptMessageContent

fn from(value: EmbeddedResource) -> Self

Converts to this type from the input type.

impl From<EmbeddedResource> for ServerResult

fn from(value: EmbeddedResource) -> Self

Converts to this type from the input type.

impl PartialEq for EmbeddedResource

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

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 EmbeddedResource