Struct ToolDefinition 

pub struct ToolDefinition {
    pub name: ToolName,
    pub description: ToolDescription,
    pub parameters: GenerationSchema,
    /* private fields */
}

A function that the model can invoke when responding to a prompt.

The handler receives the model’s arguments as a serde_json::Value and must return either a ToolOutput delivered back to the model or a ToolCallError.

Build one with ToolDefinition::builder, then attach it to a LanguageModelSessionBuilder.

Fields

name: ToolName

Name the model uses to reference this tool. Must be unique within a session.

description: ToolDescription

Human-readable description shown to the model.

parameters: GenerationSchema

GenerationSchema describing the arguments the model must supply when calling this tool.

Implementations

impl ToolDefinition

pub fn new( name: impl Into<ToolName>, description: impl Into<ToolDescription>, parameters: GenerationSchema, handler: impl Fn(Value) -> ToolResult + WasmCompatSend + WasmCompatSync + 'static, ) -> Self

Creates a complete tool definition from a typed handler.

pub fn builder( name: impl Into<ToolName>, description: impl Into<ToolDescription>, parameters: GenerationSchema, ) -> ToolDefinitionBuilder

Starts building a tool definition.

pub fn from_handler( name: impl Into<ToolName>, description: impl Into<ToolDescription>, parameters: GenerationSchema, handler: impl Fn(Value) -> ToolResult + WasmCompatSend + WasmCompatSync + 'static, ) -> Self

Alias for ToolDefinition::new that reads well at call sites.

Trait Implementations

impl Debug for ToolDefinition

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

Formats the value using the given formatter.

impl Tool for ToolDefinition

fn name(&self) -> &ToolName

Returns the tool name visible to the model.

fn description(&self) -> &ToolDescription

Returns the human-readable tool description visible to the model.

fn parameters(&self) -> &GenerationSchema

Returns the JSON argument schema visible to the model.

fn call(&self, args: Value) -> ToolResult

Executes the tool with model-supplied arguments.