Skip to main content

Message

Enum Message 

Source
pub enum Message {
    System {
        content: String,
        id: Option<String>,
        name: Option<String>,
        additional_kwargs: HashMap<String, Value>,
        response_metadata: HashMap<String, Value>,
        content_blocks: Vec<ContentBlock>,
    },
    Human {
        content: String,
        id: Option<String>,
        name: Option<String>,
        additional_kwargs: HashMap<String, Value>,
        response_metadata: HashMap<String, Value>,
        content_blocks: Vec<ContentBlock>,
    },
    AI {
        content: String,
        tool_calls: Vec<ToolCall>,
        id: Option<String>,
        name: Option<String>,
        additional_kwargs: HashMap<String, Value>,
        response_metadata: HashMap<String, Value>,
        content_blocks: Vec<ContentBlock>,
        usage_metadata: Option<TokenUsage>,
        invalid_tool_calls: Vec<InvalidToolCall>,
    },
    Tool {
        content: String,
        tool_call_id: String,
        id: Option<String>,
        name: Option<String>,
        additional_kwargs: HashMap<String, Value>,
        response_metadata: HashMap<String, Value>,
        content_blocks: Vec<ContentBlock>,
    },
    Chat {
        custom_role: String,
        content: String,
        id: Option<String>,
        name: Option<String>,
        additional_kwargs: HashMap<String, Value>,
        response_metadata: HashMap<String, Value>,
        content_blocks: Vec<ContentBlock>,
    },
    Remove {
        id: String,
    },
}
Expand description

Represents a chat message. Tagged enum with System, Human, AI, and Tool variants.

Variants§

§

System

Fields

§content: String
§additional_kwargs: HashMap<String, Value>
§response_metadata: HashMap<String, Value>
§content_blocks: Vec<ContentBlock>
§

Human

Fields

§content: String
§additional_kwargs: HashMap<String, Value>
§response_metadata: HashMap<String, Value>
§content_blocks: Vec<ContentBlock>
§

AI

Fields

§content: String
§tool_calls: Vec<ToolCall>
§additional_kwargs: HashMap<String, Value>
§response_metadata: HashMap<String, Value>
§content_blocks: Vec<ContentBlock>
§usage_metadata: Option<TokenUsage>
§invalid_tool_calls: Vec<InvalidToolCall>
§

Tool

Fields

§content: String
§tool_call_id: String
§additional_kwargs: HashMap<String, Value>
§response_metadata: HashMap<String, Value>
§content_blocks: Vec<ContentBlock>
§

Chat

Fields

§custom_role: String
§content: String
§additional_kwargs: HashMap<String, Value>
§response_metadata: HashMap<String, Value>
§content_blocks: Vec<ContentBlock>
§

Remove

A special message that signals removal of a message by its ID. Used in message history management.

Fields

§id: String

ID of the message to remove.

Implementations§

Source§

impl Message

Source

pub fn system(content: impl Into<String>) -> Self

Source

pub fn human(content: impl Into<String>) -> Self

Source

pub fn ai(content: impl Into<String>) -> Self

Source

pub fn ai_with_tool_calls( content: impl Into<String>, tool_calls: Vec<ToolCall>, ) -> Self

Source

pub fn tool(content: impl Into<String>, tool_call_id: impl Into<String>) -> Self

Source

pub fn chat(role: impl Into<String>, content: impl Into<String>) -> Self

Source

pub fn remove(id: impl Into<String>) -> Self

Create a Remove message that signals removal of a message by its ID.

Source

pub fn with_id(self, value: impl Into<String>) -> Self

Source

pub fn with_name(self, value: impl Into<String>) -> Self

Source

pub fn with_additional_kwarg(self, key: impl Into<String>, value: Value) -> Self

Source

pub fn with_response_metadata_entry( self, key: impl Into<String>, value: Value, ) -> Self

Source

pub fn with_content_blocks(self, blocks: Vec<ContentBlock>) -> Self

Source

pub fn with_usage_metadata(self, usage: TokenUsage) -> Self

Source

pub fn content(&self) -> &str

Source

pub fn role(&self) -> &str

Source

pub fn is_system(&self) -> bool

Source

pub fn is_human(&self) -> bool

Source

pub fn is_ai(&self) -> bool

Source

pub fn is_tool(&self) -> bool

Source

pub fn is_chat(&self) -> bool

Source

pub fn is_remove(&self) -> bool

Source

pub fn tool_calls(&self) -> &[ToolCall]

Source

pub fn tool_call_id(&self) -> Option<&str>

Source

pub fn id(&self) -> Option<&str>

Source

pub fn name(&self) -> Option<&str>

Source

pub fn additional_kwargs(&self) -> &HashMap<String, Value>

Source

pub fn response_metadata(&self) -> &HashMap<String, Value>

Source

pub fn content_blocks(&self) -> &[ContentBlock]

Source

pub fn remove_id(&self) -> Option<&str>

Return the remove ID if this is a Remove message.

Source

pub fn usage_metadata(&self) -> Option<&TokenUsage>

Source

pub fn invalid_tool_calls(&self) -> &[InvalidToolCall]

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Message

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Message

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Message

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Message

Source§

impl StructuralPartialEq for Message

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,