Struct StructuredDirective 

pub struct StructuredDirective {
    pub force_tool: Option<String>,
    pub response_format: Option<ResponseFormat>,
    pub validation_schema: Option<Value>,
}

Instruction telling a provider how to enforce structured output for a call.

Carries the union of intents; each provider honors what it supports and ignores the rest (e.g. Anthropic has no response_format, so it only acts on force_tool). Self::validation_schema is host-only metadata and must never be serialized into a provider request. The default reproduces an ordinary completion, which is why the trait’s default complete_structured implementation is behavior-preserving.

Fields

force_tool: Option<String>

Force the model to call exactly this tool (provider tool_choice).

response_format: Option<ResponseFormat>

Request a provider-native response_format (OpenAI-compatible only).

validation_schema: Option<Value>

Provider-facing response schema retained for composite-client stream validation, including prompt fallback and JSON-object modes where the provider directive itself does not carry a schema.

Trait Implementations

impl Clone for StructuredDirective

fn clone(&self) -> StructuredDirective

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredDirective

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

Formats the value using the given formatter.

impl Default for StructuredDirective

fn default() -> StructuredDirective

Returns the “default value” for a type.

impl PartialEq for StructuredDirective

fn eq(&self, other: &StructuredDirective) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StructuredDirective