Enum PromptMessage 

#[non_exhaustive]
pub enum PromptMessage {
    System {
        content: String,
        provider_options: Option<ProviderOptions>,
    },
    User {
        content: Vec<UserPromptPart>,
        provider_options: Option<ProviderOptions>,
    },
    Assistant {
        content: Vec<AssistantPromptPart>,
        provider_options: Option<ProviderOptions>,
    },
    Tool {
        content: Vec<ToolPromptPart>,
        provider_options: Option<ProviderOptions>,
    },
}

A message in a specification prompt, tagged by role.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

System

System instructions.

Fields

content: String

Instruction text.

provider_options: Option<ProviderOptions>

Provider-specific options for this message.

User

User input.

Fields

content: Vec<UserPromptPart>

Text and file parts.

provider_options: Option<ProviderOptions>

Provider-specific options for this message.

Assistant

Previous assistant output.

Fields

content: Vec<AssistantPromptPart>

Assistant parts, including tool calls and provider-executed results.

provider_options: Option<ProviderOptions>

Provider-specific options for this message.

Tool

Tool results and approval responses.

Fields

content: Vec<ToolPromptPart>

Tool parts.

provider_options: Option<ProviderOptions>

Provider-specific options for this message.

Implementations

impl PromptMessage

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

Creates a system message.

pub fn user_text(text: impl Into<String>) -> Self

Creates a user message with a single text part.

pub fn user(content: Vec<UserPromptPart>) -> Self

Creates a user message from parts.

pub fn assistant_text(text: impl Into<String>) -> Self

Creates an assistant message with a single text part.

pub fn assistant(content: Vec<AssistantPromptPart>) -> Self

Creates an assistant message from parts.

pub fn tool(content: Vec<ToolPromptPart>) -> Self

Creates a tool message from parts.

pub fn role(&self) -> &'static str

Returns the role name (system, user, assistant, tool).

pub fn provider_options(&self) -> Option<&ProviderOptions>

Returns the provider options attached to the message.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PromptMessage