FunctionTool
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:14
Simple Tool interface. Likely to change.
Type Parameters
Section titled “Type Parameters”T
R extends JSONValue | Promise<JSONValue>
AdditionalToolArgument
Section titled “AdditionalToolArgument”AdditionalToolArgument extends object = object
Implements
Section titled “Implements”BaseTool<T>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FunctionTool<
T,R,AdditionalToolArgument>(fn,metadata,zodType?,additionalArg?,logger?):FunctionTool<T,R,AdditionalToolArgument>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:26
Parameters
Section titled “Parameters”(input, additionalArg?) => R
metadata
Section titled “metadata”ToolMetadata<JSONSchemaType<T>>
zodType?
Section titled “zodType?”ZodSchema<T>
additionalArg?
Section titled “additionalArg?”AdditionalToolArgument
logger?
Section titled “logger?”Logger
Returns
Section titled “Returns”FunctionTool<T, R, AdditionalToolArgument>
Accessors
Section titled “Accessors”metadata
Section titled “metadata”Get Signature
Section titled “Get Signature”get metadata():
TextendsKnown?ToolMetadata<JSONSchemaType<T<T>>> :ToolMetadata<Record<string,unknown>>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:155
Returns
Section titled “Returns”T extends Known ? ToolMetadata<JSONSchemaType<T<T>>> : ToolMetadata<Record<string, unknown>>
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”from()
Section titled “from()”Call Signature
Section titled “Call Signature”
staticfrom<T,AdditionalToolArgument>(fn,schema):FunctionTool<T,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:45
Type Parameters
Section titled “Type Parameters”T
AdditionalToolArgument
Section titled “AdditionalToolArgument”AdditionalToolArgument extends object = object
Parameters
Section titled “Parameters”(input, additionalArg?) => JSONValue | Promise<JSONValue>
schema
Section titled “schema”ToolMetadata<JSONSchemaType<T>>
Returns
Section titled “Returns”FunctionTool<T, JSONValue | Promise<JSONValue>, AdditionalToolArgument>
Call Signature
Section titled “Call Signature”
staticfrom<R,AdditionalToolArgument>(fn,schema):FunctionTool<TypeOf<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:54
Type Parameters
Section titled “Type Parameters”R
AdditionalToolArgument
Section titled “AdditionalToolArgument”AdditionalToolArgument extends object = object
Parameters
Section titled “Parameters”(input, additionalArg?) => JSONValue | Promise<JSONValue>
schema
Section titled “schema”Omit<ToolMetadata, "parameters"> & object
Returns
Section titled “Returns”FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>
Call Signature
Section titled “Call Signature”
staticfrom<R,AdditionalToolArgument>(fn,schema):FunctionTool<output<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:71
Type Parameters
Section titled “Type Parameters”R
AdditionalToolArgument
Section titled “AdditionalToolArgument”AdditionalToolArgument extends object = object
Parameters
Section titled “Parameters”(input, additionalArg?) => JSONValue | Promise<JSONValue>
schema
Section titled “schema”Omit<ToolMetadata, "parameters"> & object
Returns
Section titled “Returns”FunctionTool<output<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>
Call Signature
Section titled “Call Signature”
staticfrom<R,AdditionalToolArgument>(config):FunctionTool<TypeOf<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:84
Type Parameters
Section titled “Type Parameters”R
AdditionalToolArgument
Section titled “AdditionalToolArgument”AdditionalToolArgument extends object = object
Parameters
Section titled “Parameters”config
Section titled “config”Omit<ToolMetadata, "parameters"> & object
Returns
Section titled “Returns”FunctionTool<TypeOf<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>
Call Signature
Section titled “Call Signature”
staticfrom<R,AdditionalToolArgument>(config):FunctionTool<output<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:103
Type Parameters
Section titled “Type Parameters”R
AdditionalToolArgument
Section titled “AdditionalToolArgument”AdditionalToolArgument extends object = object
Parameters
Section titled “Parameters”config
Section titled “config”Omit<ToolMetadata, "parameters"> & object
Returns
Section titled “Returns”FunctionTool<output<R>, JSONValue | Promise<JSONValue>, AdditionalToolArgument>
bind()
Section titled “bind()”bind(
additionalArg):FunctionTool<T,R,AdditionalToolArgument>
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:159
Parameters
Section titled “Parameters”additionalArg
Section titled “additionalArg”AdditionalToolArgument
Returns
Section titled “Returns”FunctionTool<T, R, AdditionalToolArgument>
call()
Section titled “call()”call(
input):R
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:168
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”R
The output of the tool.