Skip to main content

StructuredOutput

Struct StructuredOutput 

Source
pub struct StructuredOutput {
    pub raw: String,
    pub parsed: Option<Value>,
    pub validation_result: ValidationResult,
}
Expand description

Structured output result with validation.

Wraps the raw response from the AI model with parsed, validated, and formatted data.

Fields§

§raw: String

Raw response content as string

§parsed: Option<Value>

Parsed JSON data (None if parsing failed)

§validation_result: ValidationResult

Validation result (always populated)

Implementations§

Source§

impl StructuredOutput

Source

pub fn from_response_unvalidated(content: impl Into<String>) -> Self

Create a structured output from raw content without validation.

§Arguments
  • content - Raw response content

Returns: A StructuredOutput instance with parsed data but without validation.

Use .validate() method to add validation after creation.

Example:

use ai_lib_rust::structured::{StructuredOutput, OutputValidator};
use serde_json::json;

let schema = json!({"type": "object", "properties": {"name": {"type": "string"}}});
let validator = OutputValidator::lenient(schema);

let mut output = StructuredOutput::from_response_unvalidated(
    r#"{"name": "Alice"}"#
);

output.validate(&validator);
assert!(output.is_valid());
Source

pub fn validate(&mut self, validator: &OutputValidator)

Validate this output against a schema.

§Arguments
  • validator - The validator to use

Updates the validation_result with the schema check result.

Example:

use ai_lib_rust::structured::{StructuredOutput, OutputValidator};
use serde_json::json;

let schema = json!({"type": "object", "properties": {"name": {"type": "string"}}});
let validator = OutputValidator::lenient(schema);

let mut output = StructuredOutput::from_response_unvalidated(r#"{"name": "Alice"}"#);
output.validate(&validator);
Source

pub fn from_response( content: impl Into<String>, validator: &OutputValidator, ) -> Self

Create a structured output from raw content with validation.

§Arguments
  • content - Raw response content
  • validator - Validator to check the content

Returns: A StructuredOutput instance with parsed and validated data.

Example:

use ai_lib_rust::structured::{StructuredOutput, OutputValidator};
use serde_json::json;

let schema = json!({"type": "object", "properties": {"name": {"type": "string"}}});
let validator = OutputValidator::lenient(schema);

let output = StructuredOutput::from_response(
    r#"{"name": "Alice"}"#,
    &validator
);

assert!(output.is_valid());
Source

pub fn is_valid(&self) -> bool

Check if the output is valid.

Returns true if:

  1. JSON parsing succeeded
  2. Validation passed (if validation was performed)
Source

pub fn data(&self) -> Value

Get the best available data representation.

Priority:

  1. Validated data (if validation passed)
  2. Parsed data (if available)
  3. Raw content as string
Source

pub fn raw(&self) -> &str

Get the raw response content.

Source

pub fn parsed(&self) -> Option<&Value>

Get the parsed JSON data (if parsing succeeded).

Source

pub fn validation_result(&self) -> &ValidationResult

Get the validation result.

Source

pub fn errors(&self) -> Vec<ValidationError>

Get validation errors if validation failed.

Source

pub fn error_messages(&self) -> Vec<String>

Get error messages as strings.

Trait Implementations§

Source§

impl Clone for StructuredOutput

Source§

fn clone(&self) -> StructuredOutput

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StructuredOutput

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more