agents 0.3.0

Facade crate for building typed Rust agents
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::fmt;
use std::marker::PhantomData;

/// Provider-facing response format payload.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RawResponseFormat {
    pub r#type: String,
    pub json_schema: Option<RawResponseJsonSchema>,
}

/// JSON Schema payload embedded in [`RawResponseFormat`].
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RawResponseJsonSchema {
    pub name: String,
    pub strict: Option<bool>,
    pub schema: serde_json::Value,
}

/// Typed structured-response description for one completion call.
///
/// ```rust
/// 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());
/// ```
#[derive(Clone)]
pub struct TypedResponse<R> {
    name: String,
    strict: bool,
    schema: serde_json::Value,
    _phantom: PhantomData<R>,
}

impl<R> TypedResponse<R>
where
    R: JsonSchema,
{
    /// Builds a strict JSON Schema response format for `R`.
    pub fn new(name: impl Into<String>) -> Self {
        let schema = schemars::schema_for!(R);
        let schema_json = serde_json::to_value(&schema).unwrap_or_default();

        Self {
            name: name.into(),
            strict: true,
            schema: schema_json,
            _phantom: PhantomData,
        }
    }

    /// Controls whether providers should enforce the schema strictly when supported.
    pub fn with_strict(mut self, strict: bool) -> Self {
        self.strict = strict;
        self
    }

    /// Converts the typed schema into the raw provider-facing payload.
    pub fn to_raw_response_format(&self) -> RawResponseFormat {
        RawResponseFormat {
            r#type: "json_schema".to_string(),
            json_schema: Some(RawResponseJsonSchema {
                name: self.name.clone(),
                strict: Some(self.strict),
                schema: self.schema.clone(),
            }),
        }
    }
}

impl<R> fmt::Debug for TypedResponse<R> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("TypedResponse")
            .field("name", &self.name)
            .field("strict", &self.strict)
            .finish()
    }
}