Struct Message 

pub struct Message {
    pub role: Role,
    pub content: Option<String>,
    pub tool_calls: Option<Vec<ToolCall>>,
    pub tool_call_id: Option<String>,
}

A single message in a chat conversation.

All fields except role are optional; None fields are omitted from serialised JSON (skip_serializing_if = "Option::is_none").

Examples

use api_openai_compatible::Message;

let sys  = Message::system( "You are a helpful assistant." );
let user = Message::user( "What is 2 + 2?" );

Fields

role: Role

Who sent this message.

content: Option<String>

Text content of the message.

tool_calls: Option<Vec<ToolCall>>

Tool invocations requested by the assistant (assistant role only).

tool_call_id: Option<String>

ID of the ToolCall this message responds to (tool role only).

Implementations

impl Message

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

Creates a system-role message.

Examples

use api_openai_compatible::Message;

let msg = Message::system( "You are a helpful coding assistant." );

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

Creates a user-role message.

Examples

use api_openai_compatible::Message;

let msg = Message::user( "Explain monads." );

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

Creates an assistant-role message.

Examples

use api_openai_compatible::Message;

let msg = Message::assistant( "A monad is a design pattern…" );

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

Creates a tool-result message.

Arguments

• tool_call_id — Must match the id of the ToolCall being answered.
• content — Serialised result from the tool execution.

Examples

use api_openai_compatible::Message;

let msg = Message::tool( "call_abc123", r#"{"temperature":22}"# );

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

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 Message