Struct Tool 

pub struct Tool {
    pub tool_type: String,
    pub name: String,
    pub description: String,
    pub parameters: Value,
}

Tool definition for function calling

Defines a tool that GPT-5 can call during its response generation.

Examples

use gpt5::Tool;
use serde_json::json;

let weather_tool = Tool {
    tool_type: "function".to_string(),
    name: "get_weather".to_string(),
    description: "Get current weather".to_string(),
    parameters: json!({
        "type": "object",
        "properties": {
            "location": {"type": "string"}
        }
    }),
};

Fields

tool_type: String

name: String

description: String

parameters: Value

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.