Struct Prompt 

pub struct Prompt {
    pub messages: Vec<Message>,
}

A collection of messages forming a prompt.

Prompt implements From<&str>, From<String>, From<Message>, and From<Vec<Message>>, so most call sites can pass their input directly to RequestBuilder::prompt.

Examples

use rai_sdk::{Message, Prompt};

let prompt = Prompt::single(Message::system("Be brief."))
    .with_message(Message::user("Define entropy."));

assert_eq!(prompt.system_message(), Some("Be brief."));
assert_eq!(prompt.conversation_messages().len(), 1);

Fields

messages: Vec<Message>

Messages in provider order; system messages usually come first.

Implementations

impl Prompt

pub fn new(messages: Vec<Message>) -> Self

Build a prompt from a full message list.

pub fn single(message: Message) -> Self

Build a prompt from a single message.

pub fn push_message(&mut self, message: Message)

Append a message to the prompt.

pub fn with_message(self, message: Message) -> Self

Return a new prompt with an additional message appended.

pub fn with_history(self, history: Vec<ConversationTurn>) -> Self

Add a history of conversation turns to the prompt.

pub fn push_turn(&mut self, turn: ConversationTurn)

Append a single conversation turn to the prompt.

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

Extract the system message if present (first system message).

pub fn conversation_messages(&self) -> Vec<&Message>

Get non-system messages.

pub fn is_multimodal(&self) -> bool

Check if this prompt contains any multimodal content.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Prompt

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Prompt> for Prompt

fn from(prompt: &Prompt) -> Self

Converts to this type from the input type.

impl From<&str> for Prompt

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<Message> for Prompt

fn from(message: Message) -> Self

Converts to this type from the input type.

impl From<String> for Prompt

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Vec<Message>> for Prompt

fn from(messages: Vec<Message>) -> Self

Converts to this type from the input type.

impl PartialEq for Prompt

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Prompt

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 Prompt