Struct TypedResponse 

pub struct TypedResponse<R> { /* private fields */ }

Typed structured-response description for one completion call.

use agents::response::TypedResponse;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
struct Answer {
    text: String,
}

let format = TypedResponse::<Answer>::new("answer");
let raw = format.to_raw_response_format();

assert_eq!(raw.r#type, "json_schema");
assert!(raw.json_schema.is_some());

Implementations

impl<R> TypedResponse<R>

where R: JsonSchema,

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

Builds a strict JSON Schema response format for R.

pub fn with_strict(self, strict: bool) -> Self

Controls whether providers should enforce the schema strictly when supported.

pub fn to_raw_response_format(&self) -> RawResponseFormat

Converts the typed schema into the raw provider-facing payload.

Trait Implementations

impl<R: Clone> Clone for TypedResponse<R>

fn clone(&self) -> TypedResponse<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R> Debug for TypedResponse<R>

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

Formats the value using the given formatter.