Struct FunctionTool 

pub struct FunctionTool {
    pub name: String,
    pub description: Option<String>,
    pub input_schema: JsonSchema,
    pub input_examples: Option<Vec<ToolInputExample>>,
    pub strict: Option<bool>,
    pub provider_options: Option<ProviderOptions>,
}

Client-defined function tool with a JSON schema input.

Fields

name: String

Unique tool name within the call.

description: Option<String>

Optional natural-language description.

input_schema: JsonSchema

JSON schema for the input arguments.

input_examples: Option<Vec<ToolInputExample>>

Example inputs to guide the model.

strict: Option<bool>

Request strict schema enforcement when the provider supports it.

provider_options: Option<ProviderOptions>

Provider-specific options.

Trait Implementations

impl Clone for FunctionTool

fn clone(&self) -> FunctionTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionTool

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

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 FunctionTool