Struct ResponseFormat 

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

A request to constrain the model’s output to a named JSON schema.

Construct with ResponseFormat::from_type from any StructuredOutput type, or manually from a raw schema + name via ResponseFormat::new. Passed to the provider via RequestOptions.

Fields

name: String

Logical name for the schema.

Copied from StructuredOutput::name when constructed via from_type. Used as the OpenAI json_schema.name and the Anthropic forced-tool name. Must match ^[a-zA-Z0-9_-]+$.

schema: Value

The JSON Schema the model’s output must satisfy.

Injected into the provider request verbatim: OpenAI emits it as response_format.json_schema.schema; Anthropic uses it as the forced tool’s input_schema.

strict: bool

Whether to enforce the schema server-side (“strict” mode).

When true (the default), OpenAI guarantees the output conforms to the schema. Providers that lack strict mode (Anthropic tool-forcing) ignore this flag.

Implementations

impl ResponseFormat

pub fn from_type<T: StructuredOutput>() -> Self

Build a ResponseFormat from a StructuredOutput type.

Example

use loopctl::structured::{ResponseFormat, StructuredOutput};

let rf = ResponseFormat::from_type::<MyOutput>();
assert_eq!(rf.name, MyOutput::name());
assert_eq!(rf.schema, MyOutput::schema());
assert!(rf.strict);

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

Build a ResponseFormat from raw parts.

Use this when the schema is constructed dynamically (e.g. at runtime from config or a database) rather than from a static type. For the common case of deriving the format from a StructuredOutput type, prefer from_type.

Sets strict: true by default — the model is constrained server-side where supported (OpenAI strict mode, Anthropic ignores the flag).

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.