Enum Instructions 

#[non_exhaustive]
pub enum Instructions {
    System(SystemMessage),
    Messages(Vec<SystemMessage>),
}

One system message or an ordered sequence of system messages.

String conversions create a single message. Use Self::messages for several instruction messages with independent provider options.

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(SystemMessage)

A single system message.

Messages(Vec<SystemMessage>)

System messages in prompt order (an empty vector adds none).

Implementations

impl Instructions

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

Creates a single system instruction from text.

pub fn messages(messages: impl IntoIterator<Item = SystemMessage>) -> Self

Creates ordered instructions with independent message metadata.

Examples

use ferrin_core::Instructions;
use ferrin_message::SystemMessage;
let instructions = Instructions::messages([
    SystemMessage { content: "Be concise.".into(), provider_options: None },
    SystemMessage { content: "Use supplied sources.".into(), provider_options: None },
]);
assert_eq!(instructions.as_messages().len(), 2);

pub fn with_provider_options(self, options: ProviderOptions) -> Self

Replaces provider options on every configured system message.

pub fn as_messages(&self) -> &[SystemMessage]

Borrows instruction messages in prompt order.

pub fn into_messages(self) -> Vec<SystemMessage>

Consumes the instructions into ordered system messages.

Trait Implementations

impl Clone for Instructions

fn clone(&self) -> Instructions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instructions

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

Formats the value using the given formatter.

impl Default for Instructions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Instructions

impl From<&str> for Instructions

fn from(content: &str) -> Self

Converts to this type from the input type.

impl From<String> for Instructions

fn from(content: String) -> Self

Converts to this type from the input type.

impl From<SystemMessage> for Instructions

fn from(message: SystemMessage) -> Self

Converts to this type from the input type.

impl From<Vec<SystemMessage>> for Instructions

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

Converts to this type from the input type.

impl PartialEq for Instructions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instructions