Struct PromptMessage 

#[non_exhaustive]
pub struct PromptMessage {
    pub role: Role,
    pub content: ContentBlock,
}

Available on crate features mcp and tools only.

A message returned as part of a prompt (spec PromptMessage).

Uses the unified ContentBlock for its content (text | image | audio | resource_link | resource).

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.

role: Role

content: ContentBlock

Implementations

impl PromptMessage

pub fn new(role: Role, content: ContentBlock) -> PromptMessage

pub fn new_text<S>(role: Role, text: S) -> PromptMessage

where S: Into<String>,

pub fn new_image( role: Role, data: &[u8], mime_type: &str, meta: Option<MetaObject>, annotations: Option<Annotations>, ) -> PromptMessage

Available on crate feature base64 only.

pub fn new_audio( role: Role, data: &[u8], mime_type: &str, meta: Option<MetaObject>, annotations: Option<Annotations>, ) -> PromptMessage

Available on crate feature base64 only.

pub fn new_resource( role: Role, uri: String, mime_type: Option<String>, text: Option<String>, resource_meta: Option<MetaObject>, resource_content_meta: Option<MetaObject>, annotations: Option<Annotations>, ) -> PromptMessage

pub fn new_text_with_meta<S>( role: Role, text: S, meta: Option<MetaObject>, ) -> PromptMessage

where S: Into<String>,

pub fn new_resource_link(role: Role, resource: Resource) -> PromptMessage

Trait Implementations

impl Clone for PromptMessage

fn clone(&self) -> PromptMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PromptMessage

fn deserialize<__D>( __deserializer: __D, ) -> Result<PromptMessage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PromptMessage

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 PromptMessage

fn eq(&self, other: &PromptMessage) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PromptMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PromptMessage