Struct JsonSchemaResponseFormat 

pub struct JsonSchemaResponseFormat {
    pub description: Option<String>,
    pub name: String,
    pub schema: Value,
    pub strict: Option<bool>,
}

A JSON Schema output contract. OpenAI receives the name, description, schema and strict setting; Anthropic receives the schema in output_config.format and always uses its native strict enforcement.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

description: Option<String>

Optional description passed to OpenAI providers.

name: String

Name of the output schema, subject to the provider’s naming restrictions.

schema: Value

JSON Schema passed unchanged to the inference provider. Schemas larger than 32 MiB when JSON-encoded are rejected before admission, using the runtime’s existing request-size ceiling. This is not a guarantee that the entire model request fits. Supported keywords and schema restrictions are determined by the provider.

strict: Option<bool>

Optional strict enforcement setting for OpenAI providers. Omitted uses the provider default. Anthropic always enforces its supported schema subset.

Trait Implementations

impl Clone for JsonSchemaResponseFormat

fn clone(&self) -> JsonSchemaResponseFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonSchemaResponseFormat

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

Formats the value using the given formatter.

impl Default for JsonSchemaResponseFormat

fn default() -> JsonSchemaResponseFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonSchemaResponseFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JsonSchemaResponseFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.