Enum SystemInstructionsPlacement 

#[non_exhaustive]
pub enum SystemInstructionsPlacement {
    Instructions,
    AllInstructions,
    InputSystemMessages,
}

Controls where Rig system instructions are placed in an OpenAI Responses request.

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.

Instructions

Send the leading run of system instructions (the preamble and any system messages that open the conversation) through the official top-level instructions field. Mid-conversation system messages keep their position in input.

AllInstructions

Send every system message through the top-level instructions field, including mid-conversation ones.

Use this for backends that reject the system role in input entirely.

InputSystemMessages

Send system instructions as system messages in input.

Use this only for OpenAI-compatible providers that do not support top-level instructions.

Trait Implementations

impl Clone for SystemInstructionsPlacement

fn clone(&self) -> SystemInstructionsPlacement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SystemInstructionsPlacement

impl Debug for SystemInstructionsPlacement

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

Formats the value using the given formatter.

impl Default for SystemInstructionsPlacement

fn default() -> SystemInstructionsPlacement

Returns the “default value” for a type.

impl Eq for SystemInstructionsPlacement

impl PartialEq for SystemInstructionsPlacement

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SystemInstructionsPlacement