tool

const tool: {<T, AdditionalToolArgument>(fn, schema): FunctionTool<T, JSONValue | Promise<JSONValue>, AdditionalToolArgument>; <R, AdditionalToolArgument>(fn, schema): FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>; <T, R, AdditionalToolArgument>(fn, schema): FunctionTool<T, JSONValue, AdditionalToolArgument>; <R, AdditionalToolArgument>(config): FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>; } = FunctionTool.from

Defined in: packages/core/src/tools/function-tool.ts:169

A simpler alias for creating a FunctionTool.

Call Signature

<T, AdditionalToolArgument>(fn, schema): FunctionTool<T, JSONValue | Promise<JSONValue>, AdditionalToolArgument>

Type Parameters

T

T

AdditionalToolArgument

AdditionalToolArgument extends object = object

Parameters

fn

(input, additionalArg?) => JSONValue | Promise<JSONValue>

schema

ToolMetadata<JSONSchemaType<T>>

Returns

FunctionTool<T, JSONValue | Promise<JSONValue>, AdditionalToolArgument>

Call Signature

<R, AdditionalToolArgument>(fn, schema): FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>

Type Parameters

R

R extends ZodType<any, ZodTypeDef, any>

AdditionalToolArgument

AdditionalToolArgument extends object = object

Parameters

fn

(input, additionalArg?) => JSONValue | Promise<JSONValue>

schema

Omit<ToolMetadata, "parameters"> & object

Returns

FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>

Call Signature

<T, R, AdditionalToolArgument>(fn, schema): FunctionTool<T, JSONValue, AdditionalToolArgument>

Type Parameters

T

T

R

R extends ZodType<T, ZodTypeDef, T>

AdditionalToolArgument

AdditionalToolArgument extends object = object

Parameters

fn

(input, additionalArg?) => JSONValue | Promise<JSONValue>

schema

Omit<ToolMetadata, "parameters"> & object

Returns

FunctionTool<T, JSONValue, AdditionalToolArgument>

Call Signature

<R, AdditionalToolArgument>(config): FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>

Type Parameters

R

R extends ZodType<any, ZodTypeDef, any>

AdditionalToolArgument

AdditionalToolArgument extends object = object

Parameters

config

Omit<ToolMetadata, "parameters"> & object

Returns

FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>