Struct ObjectJsonSchema 

pub struct ObjectJsonSchema {
    pub schema_type: String,
    pub properties: IndexMap<String, Value>,
    pub required: Vec<String>,
    pub description: Option<String>,
    pub additional_properties: Option<bool>,
    pub extra: HashMap<String, Value>,
}

JSON Schema for an object type (tool parameters).

This represents the parameters that a tool accepts, using JSON Schema format that is understood by language models for function calling.

Fields

schema_type: String

The schema type (always “object” for tool parameters).

properties: IndexMap<String, Value>

Property definitions.

required: Vec<String>

List of required property names.

description: Option<String>

Description of the schema.

additional_properties: Option<bool>

Whether additional properties are allowed.

extra: HashMap<String, Value>

Extra schema properties.

Implementations

impl ObjectJsonSchema

pub fn new() -> ObjectJsonSchema

Create a new empty object schema.

pub fn with_property( self, name: &str, schema: Value, required: bool, ) -> ObjectJsonSchema

Add a property to the schema.

pub fn add_property(&mut self, name: &str, schema: Value, required: bool)

Add a property without consuming self.

pub fn with_description(self, desc: &str) -> ObjectJsonSchema

Set the description.

pub fn with_additional_properties(self, allowed: bool) -> ObjectJsonSchema

Set whether additional properties are allowed.

pub fn with_extra(self, key: &str, value: Value) -> ObjectJsonSchema

Add an extra property to the schema.

pub fn is_required(&self, name: &str) -> bool

Check if a property is required.

pub fn get_property(&self, name: &str) -> Option<&Value>

Get a property schema.

pub fn property_count(&self) -> usize

Get the number of properties.

pub fn is_empty(&self) -> bool

Check if the schema has no properties.

pub fn to_json(&self) -> Result<Value, Error>

Convert to a JSON value.

Trait Implementations

impl Clone for ObjectJsonSchema

fn clone(&self) -> ObjectJsonSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectJsonSchema

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

Formats the value using the given formatter.

impl Default for ObjectJsonSchema

fn default() -> ObjectJsonSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObjectJsonSchema

fn deserialize<__D>( __deserializer: __D, ) -> Result<ObjectJsonSchema, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ObjectJsonSchema

fn eq(&self, other: &ObjectJsonSchema) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ObjectJsonSchema

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Value> for ObjectJsonSchema

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: Value, ) -> Result<ObjectJsonSchema, <ObjectJsonSchema as TryFrom<Value>>::Error>

Performs the conversion.

impl StructuralPartialEq for ObjectJsonSchema