Struct ToolSpec 

pub struct ToolSpec {
    pub name: String,
    pub description: String,
    pub parameters: JsonValue,
}

A tool a model may be offered: a name, a description, and a JSON-Schema parameter object.

Fields

name: String

description: String

parameters: JsonValue

Implementations

impl ToolSpec

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

A tool spec.

pub fn payload_value(&self) -> JsonValue

The {name, description, parameters} payload form.

pub fn from_payload(value: &JsonValue) -> Option<Self>

Parse a spec from its payload form, or None if it has no name.

pub fn from_payload_array(value: Option<&JsonValue>) -> Vec<Self>

Parse an array of specs, dropping any that don’t parse.

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<'de> Deserialize<'de> for ToolSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolSpec

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 ToolSpec