Struct StructuredOutputSchema 

pub struct StructuredOutputSchema<T> {
    pub tool_name: String,
    pub tool_description: String,
    pub schema: ObjectJsonSchema,
    pub strict: Option<bool>,
    /* private fields */
}

Schema for structured output using serde.

This schema parses model output into a typed Rust struct using serde. It supports multiple output modes (tool, native, prompted, text).

Example

use serdes_ai_output::StructuredOutputSchema;
use serdes_ai_tools::ObjectJsonSchema;
use serde::Deserialize;

#[derive(Deserialize)]
struct Person {
    name: String,
    age: u32,
}

let schema = ObjectJsonSchema::new()
    .with_property("name", serdes_ai_tools::PropertySchema::string("Name").build(), true)
    .with_property("age", serdes_ai_tools::PropertySchema::integer("Age").build(), true);

let output_schema: StructuredOutputSchema<Person> = StructuredOutputSchema::new(schema);

Fields

tool_name: String

Tool name when using tool mode.

tool_description: String

Tool description.

schema: ObjectJsonSchema

JSON schema for the output.

strict: Option<bool>

Whether to use strict mode (for OpenAI).

Implementations

impl<T: DeserializeOwned + Send + Sync> StructuredOutputSchema<T>

pub fn new(schema: ObjectJsonSchema) -> Self

Create a new structured output schema.

pub fn with_tool_name(self, name: impl Into<String>) -> Self

Set the tool name.

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

Set the tool description.

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

Set strict mode (for OpenAI structured outputs).

pub fn with_mode(self, mode: OutputMode) -> Self

Set the preferred output mode.

Trait Implementations

impl<T: Clone> Clone for StructuredOutputSchema<T>

fn clone(&self) -> StructuredOutputSchema<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StructuredOutputSchema<T>

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

Formats the value using the given formatter.

impl<T: DeserializeOwned + Send + Sync + 'static> IntoOutputSpec<T> for StructuredOutputSchema<T>

fn into_output_spec(self) -> OutputSpec<T>

Convert into an output spec.

impl<T: DeserializeOwned + Send + Sync> OutputSchema<T> for StructuredOutputSchema<T>

fn mode(&self) -> OutputMode

The preferred output mode for this schema.

fn tool_definitions(&self) -> Vec<ToolDefinition>

Get tool definitions if using tool mode.

fn json_schema(&self) -> Option<ObjectJsonSchema>

Get JSON schema for native/prompted mode.

fn parse_text(&self, text: &str) -> Result<T, OutputParseError>

Parse output from text.

fn parse_tool_call( &self, name: &str, args: &JsonValue, ) -> Result<T, OutputParseError>

Parse output from a tool call.

fn parse_native(&self, value: &JsonValue) -> Result<T, OutputParseError>

Parse output from native structured response.

fn supports_mode(&self, mode: OutputMode) -> bool

Whether this schema supports a given output mode.

fn parse( &self, mode: OutputMode, text: Option<&str>, tool_name: Option<&str>, args: Option<&JsonValue>, ) -> Result<T, OutputParseError>

Parse output based on the mode.