Enum SystemInstructions 

#[non_exhaustive]
pub enum SystemInstructions {
    Custom(String),
    Templated {
        identity: Option<String>,
        sections: Vec<SystemInstructionSection>,
    },
}

System instruction configuration, mirroring the Python SDK’s union type.

Uses internal tagging via #[serde(untagged)] so each variant is distinguishable by its "mode" field in JSON (e.g. {"mode": "Custom", "text": "..."}).

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.

Custom(String)

Completely replace the default system instructions (advanced usage).

Templated

Override identity and/or append sections to the defaults (recommended).

Fields

identity: Option<String>

Optional identity string that replaces the agent’s default persona.

sections: Vec<SystemInstructionSection>

Sections appended to the default system instructions.

Implementations

impl SystemInstructions

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

Create custom system instructions from a plain text string.

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<'de> Deserialize<'de> for SystemInstructions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for SystemInstructions

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for SystemInstructions

fn from(s: String) -> Self

Converts to this type from the input type.

impl Serialize for SystemInstructions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.