Enum ResponseFormat 

pub enum ResponseFormat {
    Yaml,
    JsonSchema,
}

Whether the response should be formatted as YAML (default) or JSON matching a schema.

Used by the prompts module to swap the format-specific portion of a structured prompt without rewriting the semantic instructions.

Variants

Yaml

Plain YAML, with the prompt asking the model to emit a fenced or bare YAML document.

JsonSchema

JSON object that matches a schema attached via RequestOptions::response_schema. The prompt drops the YAML structure literal and tells the model to return only the JSON object.

Implementations

impl ResponseFormat

pub fn from_capabilities(caps: &AiClientCapabilities) -> Self

Returns the response format that should be used given a backend’s capabilities.

Trait Implementations

impl Clone for ResponseFormat

fn clone(&self) -> ResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ResponseFormat

impl Debug for ResponseFormat

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

Formats the value using the given formatter.

impl Default for ResponseFormat

fn default() -> ResponseFormat

Returns the “default value” for a type.

impl Eq for ResponseFormat

impl PartialEq for ResponseFormat

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