Struct SystemInstructions 

pub struct SystemInstructions { /* private fields */ }

LanguageModelSession instructions that have been checked for C-FFI compatibility.

Implementations

impl SystemInstructions

pub fn new(value: impl Into<String>) -> Result<Self, Error>

Creates session instructions, rejecting text containing interior null bytes.

SystemInstructions are developer-controlled system guidance that persists for the lifetime of a LanguageModelSession.

Examples

use aimx::SystemInstructions;

let instructions = SystemInstructions::new("Answer in one concise paragraph.")?;
assert_eq!(instructions.as_str(), "Answer in one concise paragraph.");

Errors

Returns Error::NullByte if value contains an interior null byte.

pub fn empty() -> Self

Empty system instructions.

This is equivalent to SystemInstructions::new("") without the fallible allocation path.

pub fn as_str(&self) -> &str

Borrows the instructions as UTF-8 text.

Trait Implementations

impl Clone for SystemInstructions

fn clone(&self) -> SystemInstructions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemInstructions

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

Formats the value using the given formatter.

impl Default for SystemInstructions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SystemInstructions

fn eq(&self, other: &SystemInstructions) -> 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 TryFrom<&str> for SystemInstructions

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InstructionsText> for SystemInstructions

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: InstructionsText) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for SystemInstructions

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SystemInstructions

impl StructuralPartialEq for SystemInstructions