Enum ToolDefinition 

#[non_exhaustive]
pub enum ToolDefinition {
    Function {
        name: ToolName,
        description: Option<String>,
        input_schema: JsonValue,
        strict: Option<bool>,
        input_examples: Vec<JsonObject>,
        provider_options: Option<ProviderOptions>,
    },
    Provider {
        id: String,
        name: ToolName,
        args: JsonObject,
    },
}

A tool made available to the model.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Function

A function tool executed by the application (or by the provider when it reports provider_executed).

Fields

name: ToolName

Tool name.

description: Option<String>

Description shown to the model.

input_schema: JsonValue

JSON Schema (draft-07) of the input.

strict: Option<bool>

Whether the provider should enforce the schema strictly.

input_examples: Vec<JsonObject>

Example inputs.

provider_options: Option<ProviderOptions>

Provider-specific options for this tool.

Provider

A tool defined and executed by the provider (web search, code interpreter, …).

Fields

id: String

Tool id in <provider>.<tool> form.

name: ToolName

Name under which the tool appears in results.

args: JsonObject

Provider-specific arguments.

Implementations

impl ToolDefinition

pub fn function( name: impl Into<ToolName>, description: Option<String>, input_schema: JsonValue, ) -> Self

Creates a function tool with a schema and optional description.

pub fn provider( id: impl Into<String>, name: impl Into<ToolName>, args: JsonObject, ) -> Self

Creates a provider tool.

pub fn name(&self) -> &ToolName

Returns the tool name.

pub fn is_provider_tool(&self) -> bool

Returns true for ToolDefinition::Provider.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolDefinition

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 ToolDefinition