Struct ToolSpec 

#[non_exhaustive]
pub struct ToolSpec {
    pub name: String,
    pub description: String,
    pub parameters: Value,
}

A tool the model is offered: a name, the instruction a model reads when deciding whether to call it, and the JSON Schema of the arguments object the call must carry (issue #665).

#[non_exhaustive]: build one with ToolSpec::new rather than a struct literal, the same rule Prompt and Completion follow — what a tool declares grows, and it should not break every caller.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

description: String

parameters: Value

A JSON Schema (draft 2020-12) of the arguments object a call must provide. run_tool_loop validates it up front and then validates every call’s arguments against it, and refuses a schema using a keyword it cannot honour rather than silently skipping the check.

Implementations

impl ToolSpec

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

A tool named name, described by description, taking arguments conforming to parameters.

Trait Implementations

impl Clone for ToolSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSpec

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

Formats the value using the given formatter.

impl PartialEq for ToolSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ToolSpec