Enum OutputMode 

pub enum OutputMode {
    Instruction,
    JsonSchema,
    ToolCall,
}

The method used to constrain LLM output to valid response keys.

In vector completions, the model must select from a predefined set of responses. This enum controls how that constraint is enforced.

Note: This setting is only relevant for vector completions and is completely ignored for agent completions.

Variants

Instruction

The model is instructed via the prompt to output a specific key.

This is the default and most widely supported mode.

JsonSchema

A JSON schema response format is used with an enum of possible keys.

Requires model support for structured JSON output.

ToolCall

A forced tool call with an argument schema containing possible keys.

Requires model support for tool/function calling.

Trait Implementations

impl Clone for OutputMode

fn clone(&self) -> OutputMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputMode

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

Formats the value using the given formatter.

impl Default for OutputMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutputMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OutputMode> for OutputMode

fn from(mode: OutputMode) -> Self

Converts to this type from the input type.

impl From<OutputMode> for OutputMode

fn from(mode: OutputMode) -> Self

Converts to this type from the input type.

impl From<OutputMode> for OutputMode

fn from(mode: OutputMode) -> Self

Converts to this type from the input type.

impl From<OutputMode> for OutputMode

fn from(mode: OutputMode) -> Self

Converts to this type from the input type.

impl Hash for OutputMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for OutputMode

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for OutputMode

fn eq(&self, other: &OutputMode) -> 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 Serialize for OutputMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for OutputMode

impl StructuralPartialEq for OutputMode