Struct ResponseFormat 

pub struct ResponseFormat {
    pub name: String,
    pub schema: Value,
    pub strict: bool,
}

Requests that the model constrain its final answer to a JSON Schema.

This is the wire-level description of a structured-output request. The runtime maps it to each provider’s native capability:

• OpenAI / Gemini: native JSON-mode / structured-outputs (response_format / responseSchema).
• Anthropic: tool-forcing fallback — the runtime injects a single “respond” tool whose input_schema is schema and forces the model to call it.

The runtime validates the model’s final output against schema and, on mismatch, bounded-re-prompts before failing with a typed error.

Fields

name: String

Stable identifier for the schema. Surfaced to providers that require a name (OpenAI json_schema.name, the Anthropic fallback tool name).

schema: Value

The JSON Schema the final assistant output must satisfy.

This is a raw JSON Schema document (an object), not a Rust type. Callers that derive schemas from Rust types can plug in schemars upstream and pass the resulting document here.

strict: bool

Whether the provider should enforce strict schema adherence when it supports a strict mode (OpenAI strict: true). Has no effect on providers without a strict mode.

Implementations

impl ResponseFormat

pub fn new(name: impl Into<String>, schema: Value) -> ResponseFormat

Create a response format from a schema name and a JSON Schema document.

Defaults to strict = true so providers with a strict mode enforce the schema rather than treating it as a hint.

pub const fn with_strict(self, strict: bool) -> ResponseFormat

Set whether strict schema adherence is requested.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<ResponseFormat, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponseFormat