Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: String,
    pub description: Option<String>,
    pub parameters: Option<Value>,
}

Available on crate feature realtime only.

Tool/function definition for realtime sessions.

Fields

name: String

Tool name.

description: Option<String>

Tool description.

parameters: Option<Value>

JSON Schema for parameters.

Implementations

impl ToolDefinition

pub fn new(name: impl Into<String>) -> ToolDefinition

Create a new tool definition.

pub fn with_description(self, desc: impl Into<String>) -> ToolDefinition

Set the tool description.

pub fn with_parameters(self, schema: Value) -> ToolDefinition

Set the parameters schema.

Trait Implementations

impl Clone for ToolDefinition

fn clone(&self) -> ToolDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolDefinition

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolDefinition, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolDefinition

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolDefinition