pub struct JsonSchema(/* private fields */);Expand description
A JSON Schema document used for structured output or tool parameters.
Wraps a serde_json::Value and provides validation via the
jsonschema crate. The inner value is private — use
as_value for read access.
§Construction
use llm_stack::JsonSchema;
// From a raw JSON value
let schema = JsonSchema::new(serde_json::json!({
"type": "object",
"properties": { "name": { "type": "string" } },
"required": ["name"]
}));
// From a Rust type that implements schemars::JsonSchema
// let schema = JsonSchema::from_type::<MyStruct>()?;Implementations§
Source§impl JsonSchema
impl JsonSchema
Sourcepub fn from_type<T: JsonSchema>() -> Result<Self, Error>
pub fn from_type<T: JsonSchema>() -> Result<Self, Error>
Derives a JSON Schema from a Rust type that implements
schemars::JsonSchema.
Returns an error if the generated schema cannot be serialized to
serde_json::Value (should not happen in practice).
Requires the schema feature (enabled by default).
Sourcepub fn validate(&self, value: &Value) -> Result<(), LlmError>
pub fn validate(&self, value: &Value) -> Result<(), LlmError>
Validates value against this schema.
Requires the schema feature (enabled by default).
Returns Ok(()) if validation passes, or
LlmError::SchemaValidation with details on failure. Returns
LlmError::InvalidRequest if the schema itself is malformed.
Trait Implementations§
Source§impl Clone for JsonSchema
impl Clone for JsonSchema
Source§fn clone(&self) -> JsonSchema
fn clone(&self) -> JsonSchema
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for JsonSchema
impl Debug for JsonSchema
Source§impl<'de> Deserialize<'de> for JsonSchema
impl<'de> Deserialize<'de> for JsonSchema
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl PartialEq for JsonSchema
impl PartialEq for JsonSchema
Source§impl Serialize for JsonSchema
impl Serialize for JsonSchema
impl StructuralPartialEq for JsonSchema
Auto Trait Implementations§
impl Freeze for JsonSchema
impl RefUnwindSafe for JsonSchema
impl Send for JsonSchema
impl Sync for JsonSchema
impl Unpin for JsonSchema
impl UnwindSafe for JsonSchema
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more