Struct OutputPolicy 

pub struct OutputPolicy {
    pub format: OutputFormat,
    pub schema: Option<SchemaRef>,
    pub from_example: Option<SchemaRef>,
    pub max_retries: Option<u8>,
    pub source_structured_spec: Option<StructuredOutputSpec>,
}

Output policy configuration

Fields

format: OutputFormat

Output format (text or json)

schema: Option<SchemaRef>

JSON Schema for output validation (inline object or file path)

from_example: Option<SchemaRef>

JSON example — Nika auto-derives the JSON Schema from this at runtime. Alternative to schema. When set, takes precedence over schema.

max_retries: Option<u8>

Maximum retry attempts on validation failure (default: 2)

source_structured_spec: Option<StructuredOutputSpec>

Original StructuredOutputSpec when this policy was bridged from structured:. Preserves user’s layer toggle config (enable_tool_injection, enable_repair, etc.) that would otherwise be lost in the OutputPolicy→StructuredOutputSpec roundtrip.

Implementations

impl OutputPolicy

pub fn is_structured(&self) -> bool

Check if this policy requires structured output validation.

Returns true when format is JSON and a schema is provided. This is used by the executor to decide whether to use StructuredOutputEngine.

pub fn to_structured_spec(&self) -> Option<StructuredOutputSpec>

Convert to StructuredOutputSpec for use with StructuredOutputEngine.

Returns None if this policy doesn’t require structured output. If this policy was bridged from a structured: config (via to_output_policy()), returns the original spec with all user-configured layer toggles preserved. Otherwise, constructs a spec with permissive defaults (all layers enabled).

Trait Implementations

impl Clone for OutputPolicy

fn clone(&self) -> OutputPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputPolicy

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

Formats the value using the given formatter.

impl Default for OutputPolicy

fn default() -> OutputPolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OutputPolicy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.