Struct StructuredDirective 

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

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). The default (force_tool: None, response_format: None) reproduces an ordinary completion, which is why the trait’s default complete_structured impl 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).

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StructuredDirective