Struct ToolInputSchema

pub struct ToolInputSchema {
    pub properties: BTreeMap<String, Map<String, Value>>,
    pub required: Vec<String>,
    pub type_: String,
}

A JSON Schema object defining the expected parameters for the tool.

JSON schema

{
 "description": "A JSON Schema object defining the expected parameters for the tool.",
 "type": "object",
 "required": [
   "type"
 ],
 "properties": {
   "properties": {
     "type": "object",
     "additionalProperties": {
       "type": "object",
       "additionalProperties": true
     }
   },
   "required": {
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "type": {
     "type": "string",
     "const": "object"
   }
 }
}

Fields

properties: BTreeMap<String, Map<String, Value>>

required: Vec<String>

type_: String

Implementations

impl ToolInputSchema

pub fn new() -> Self

pub fn insert_property<T: JsonSchema>( &mut self, name: &str, description: &str, required: bool, ) -> Result<()>

pub fn with_property<T: JsonSchema>( self, name: &str, description: &str, required: bool, ) -> Result<Self>

Trait Implementations

impl Clone for ToolInputSchema

fn clone(&self) -> ToolInputSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToolInputSchema

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

Formats the value using the given formatter.

impl Default for ToolInputSchema

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolInputSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ToolInputSchema> for ToolInputSchema

fn from(value: &ToolInputSchema) -> Self

Converts to this type from the input type.

impl PartialEq for ToolInputSchema

fn eq(&self, other: &ToolInputSchema) -> 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 ToolInputSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolInputSchema