Skip to main content

ToolSchema

Struct ToolSchema 

Source
pub struct ToolSchema {
    pub name: String,
    pub description: String,
    pub parameters: Value,
}
Expand description

A function the model may call, described with JSON Schema.

Fields§

§name: String§description: String§parameters: Value

A JSON Schema object describing the arguments.

Implementations§

Source§

impl ToolSchema

Source

pub fn new( name: impl Into<String>, description: impl Into<String>, parameters: Value, ) -> Self

Examples found in repository?
examples/tools.rs (lines 15-26)
14fn schemas() -> Vec<ToolSchema> {
15    vec![ToolSchema::new(
16        "distance_km",
17        "Straight-line distance between two cities, in kilometres.",
18        json!({
19            "type": "object",
20            "properties": {
21                "from": { "type": "string" },
22                "to": { "type": "string" },
23            },
24            "required": ["from", "to"],
25        }),
26    )]
27}
More examples
Hide additional examples
examples/agent.rs (lines 14-25)
13    fn schemas(&self) -> Vec<ToolSchema> {
14        vec![ToolSchema::new(
15            "add",
16            "Add two numbers and return the sum.",
17            json!({
18                "type": "object",
19                "properties": {
20                    "a": { "type": "number" },
21                    "b": { "type": "number" },
22                },
23                "required": ["a", "b"],
24            }),
25        )]
26    }

Trait Implementations§

Source§

impl Clone for ToolSchema

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ToolSchema

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ToolSchema

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.