Struct Tool 

pub struct Tool {
    pub typ: ToolType,
    pub name: Option<String>,
    pub description: Option<String>,
    pub parameters: Option<Value>,
}

A tool the model may call.

Fields

typ: ToolType

The type of the tool.

name: Option<String>

For function tools. The name of the function. Must be non-empty, at most 128 characters, match ^[a-zA-Z0-9_-]+$, and be unique across all tools.

description: Option<String>

For function tools. A description of what the function does.

parameters: Option<Value>

The parameters the function accepts, described as a JSON Schema object.

Omitting parameters defines a function with an empty parameter list.

Implementations

impl Tool

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

Build a function tool.

pub fn web_search() -> Self

Build a server-side web_search tool.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl PartialEq for Tool

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Tool

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 Tool