Struct ResponseFormat 

pub struct ResponseFormat {
    pub json_schema: JsonSchemaSpec,
    pub strict: bool,
    pub strategy: OutputStrategy,
}

Structured-output directive attached to a ModelRequest.

strict requests the vendor’s strict-mode interpretation when available (OpenAI). Codecs that cannot enforce strict mode natively emit a LossyEncode warning.

strategy selects the dispatch shape (vendor-native channel / forced tool call / prompted). Auto (the default) lets each codec pick its preferred shape per auto_output_strategy(model) at codec-construction time — see OutputStrategy.

Fields

json_schema: JsonSchemaSpec

Schema the response must conform to.

strict: bool

Request strict-mode validation. Defaults to true — callers explicitly opt out with false when they want best-effort schema adherence (some Anthropic shim flows).

strategy: OutputStrategy

Dispatch shape — vendor-native, forced-tool, or prompted. Defaults to OutputStrategy::Auto which lets the codec pick per-vendor at construction time.

Implementations

impl ResponseFormat

pub fn strict(schema: JsonSchemaSpec) -> Self

Build a strict response format from the supplied schema. strategy defaults to Auto; chain Self::with_strategy to override.

pub fn best_effort(schema: JsonSchemaSpec) -> Self

Build a best-effort response format (no strict-mode validation requested). strategy defaults to Auto.

pub const fn with_strategy(self, strategy: OutputStrategy) -> Self

Override the dispatch OutputStrategy. Auto means “codec picks at construction time”; explicit Native / Tool / Prompted overrides per-codec defaulting.

pub fn strict_preflight(&self) -> Result<(), StrictSchemaError>

Validate the schema against the strict-mode constraints shared across OpenAI (Chat + Responses) and Anthropic native structured outputs. Returns the offending field path on failure so codecs can attach an actionable LossyEncode warning.

Constraints checked:

• every object schema declares additionalProperties: false
• every object schema’s required list contains every property defined in properties (OpenAI strict-mode requirement)

The check is a no-op when self.strict == false.

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 Debug for ResponseFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for ResponseFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ResponseFormat

impl StructuralPartialEq for ResponseFormat