Struct OutputPolicy 

pub struct OutputPolicy { /* private fields */ }

Complete output behavior for one agent.

Implementations

impl OutputPolicy

pub fn new() -> Self

Create an empty output policy.

pub fn structured(schema: OutputSchema) -> Self

Create a policy with a structured output schema.

pub fn typed<T>() -> Self

where T: JsonSchema,

Create a structured output policy from a Rust type.

pub fn typed_named<T>(name: impl Into<String>) -> Self

where T: JsonSchema,

Create a named structured output policy from a Rust type.

pub fn text() -> Self

Create a plain text output policy.

pub fn auto(schema: OutputSchema) -> Self

Create an auto-selected structured output policy.

pub fn native_json_schema(schema: OutputSchema) -> Self

Create a provider-native JSON schema output policy.

pub fn native_json_object(schema: OutputSchema) -> Self

Create a provider-native JSON object output policy.

pub fn tool(schema: OutputSchema) -> Self

Create a tool-call structured output policy.

pub fn tool_or_text(schema: OutputSchema) -> Self

Create a tool-call structured output policy with text fallback.

pub fn prompted(schema: OutputSchema) -> Self

Create a prompted structured output policy.

pub fn image() -> Self

Create an image output policy.

pub fn with_schema(self, schema: OutputSchema) -> Self

Attach a structured output schema.

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

Select output mode for request preparation.

pub const fn allow_text_output(self, allow: bool) -> Self

Configure whether text output is allowed.

pub const fn allow_image_output(self, allow: bool) -> Self

Configure whether image output is allowed.

pub fn with_validator(self, validator: Arc<dyn OutputValidator>) -> Self

Attach a validator.

pub fn with_function(self, function: DynOutputFunction) -> Self

Attach an output function.

pub const fn with_retries(self, retries: usize) -> Self

Set output retry budget.

pub const fn schema(&self) -> Option<&OutputSchema>

Return configured schema.

pub fn validators(&self) -> &[Arc<dyn OutputValidator>]

Return configured validators.

pub fn functions(&self) -> &[DynOutputFunction]

Return configured output functions.

pub const fn retries(&self) -> Option<usize>

Return configured retry budget.

pub const fn mode(&self) -> Option<OutputMode>

Return configured output mode.

pub const fn text_output_allowed(&self) -> Option<bool>

Return configured text-output allowance.

pub const fn image_output_allowed(&self) -> Option<bool>

Return configured image-output allowance.

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 Default for OutputPolicy

fn default() -> OutputPolicy

Returns the “default value” for a type.