Struct JsonSpec 

pub struct JsonSpec {
    pub name: String,
    pub description: Option<String>,
    pub schema: Value,
}

JSON specification used to enforce structured output.

Fields

name: String

Specification name (primarily used by OpenAI). IMPORTANT: For OpenAI, only - and _ are allowed; no spaces or other special characters.

description: Option<String>

Human-readable description (used by some adapters in the future). NOTE: Currently ignored by the OpenAI adapter.

schema: Value

Simplified JSON schema forwarded to the provider.

Implementations

impl JsonSpec

Constructors

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

Create a JsonSpec with a name and schema.

impl JsonSpec

Setters

pub fn with_description(self, description: impl Into<String>) -> Self

Set an optional description (builder-style).

impl JsonSpec

Helpers

pub fn schema_with_additional_properties_false(&self) -> Value

Returns a clone of the schema with "additionalProperties": false injected into every object node. Required by several providers (Anthropic, OpenAI) whose structured-output APIs reject schemas that omit this constraint.

Trait Implementations

impl Clone for JsonSpec

fn clone(&self) -> JsonSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsonSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(String, Option<String>, Value)> for JsonSpec

fn from(value: (String, Option<String>, Value)) -> Self

Converts to this type from the input type.

impl From<JsonSpec> for ChatResponseFormat

fn from(value: JsonSpec) -> Self

Converts to this type from the input type.

impl Serialize for JsonSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.