Struct FunctionTool 

pub struct FunctionTool {
    pub name: String,
    pub description: Option<String>,
    pub input_schema: Value,
    pub strict: Option<bool>,
    pub provider_options: Option<HashMap<String, Value>>,
    pub input_examples: Option<Vec<Value>>,
}

A tool definition passed to the model in CallOptions.tools.

Fields

name: String

Unique tool name.

description: Option<String>

Human-readable description.

input_schema: Value

JSON Schema describing the tool’s parameters.

strict: Option<bool>

Whether the tool supports strict schema enforcement (OpenAI strict mode).

provider_options: Option<HashMap<String, Value>>

Provider-specific options, keyed by provider name (e.g. {"anthropic": {"eagerInputStreaming": true}}). Aligned with the V4 providerOptions field on function tools.

input_examples: Option<Vec<Value>>

Example inputs for the tool (V4 inputExamples), used by some providers to emit input_examples in the request body.

Implementations

impl FunctionTool

pub fn new(name: impl Into<String>, input_schema: Value) -> Self

Create a FunctionTool with the required fields and all optional fields set to None. Combined with struct-update syntax this avoids spelling out every None field in tests.

pub fn with_description(self, description: impl Into<String>) -> Self

Builder-style setter for description.

pub fn with_strict(self, strict: bool) -> Self

Builder-style setter for strict.

Trait Implementations

impl Clone for FunctionTool

fn clone(&self) -> Self

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 From<FunctionTool> for Tool

fn from(ft: FunctionTool) -> Self

Converts to this type from the input type.

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 TS for FunctionTool

type WithoutGenerics = FunctionTool

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = FunctionTool

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.