Struct StructuredOutputParser 

pub struct StructuredOutputParser<T> { /* private fields */ }

Schema-driven output parser.

Build a parser via:

use serde::Deserialize;
use schemars::JsonSchema;
use cognis_core::output_parsers::StructuredOutputParser;

#[derive(Deserialize, JsonSchema)]
struct Answer { topic: String, summary: String }

let p: StructuredOutputParser<Answer> = StructuredOutputParser::new();
let instructions = p.format_instructions().unwrap();
// ... feed instructions into your prompt, then parse model output:
let parsed: Answer = p.parse(model_output).unwrap();

Implementations

impl<T> StructuredOutputParser<T>

pub fn new() -> Self

New parser with default config.

pub fn with_config(config: StructuredOutputConfig) -> Self

New parser with caller-supplied config.

pub fn config(&self) -> &StructuredOutputConfig

Borrow the active config (read-only).

impl<T> StructuredOutputParser<T>

where T: JsonSchema,

pub fn schema_string(&self) -> String

Render the JSON Schema for T as a pretty string. Used by format_instructions and exposed for advanced callers that want to embed the schema themselves.

Trait Implementations

impl<T> Clone for StructuredOutputParser<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Default for StructuredOutputParser<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> OutputParser<T> for StructuredOutputParser<T>

where T: DeserializeOwned + JsonSchema + Send + 'static,

fn parse(&self, text: &str) -> Result<T>

Attempt to parse the LLM output.

fn format_instructions(&self) -> Option<String>

Optional human-readable instructions to embed in a prompt to tell the LLM how to format its output.

impl<T> Runnable<String, T> for StructuredOutputParser<T>

where T: DeserializeOwned + JsonSchema + Send + 'static,

fn invoke<'life0, 'async_trait>( &'life0 self, input: String, __arg2: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<T>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

One-shot invocation. The hot path.

fn name(&self) -> &str

Friendly name for telemetry / introspection.

fn batch<'life0, 'async_trait>( &'life0 self, inputs: Vec<I>, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<O>>> + Send + 'async_trait>>

where I: 'static, O: 'static, Self: Sized + Sync + 'async_trait, 'life0: 'async_trait,

Run multiple inputs in parallel. Defaults to buffer_unordered honouring config.max_concurrency.

fn stream<'life0, 'async_trait>( &'life0 self, input: I, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<RunnableStream<O>>> + Send + 'async_trait>>

where Self: Sized + Sync + 'async_trait, 'life0: 'async_trait,

Stream the final output (chunks of O). Default emits one item via invoke — non-streaming runnables are correct without override.

fn stream_events<'life0, 'async_trait>( &'life0 self, input: I, config: RunnableConfig, ) -> Pin<Box<dyn Future<Output = Result<EventStream>> + Send + 'async_trait>>

where I: Serialize, O: Serialize, Self: Sized + Sync + 'async_trait, 'life0: 'async_trait,

Stream structured events. Default emits OnStart + OnEnd around an invoke call. Graph engines override to surface per-node events.

fn input_schema(&self) -> Option<Value>

JSON Schema for the input type, if known.

fn output_schema(&self) -> Option<Value>

JSON Schema for the output type, if known.