tool
consttool: {<T,AdditionalToolArgument>(fn,schema):FunctionTool<T,JSONValue|Promise<JSONValue>,AdditionalToolArgument>; <R,AdditionalToolArgument>(fn,schema):FunctionTool<TypeOf<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>; <R,AdditionalToolArgument>(fn,schema):FunctionTool<output<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>; <R,AdditionalToolArgument>(config):FunctionTool<TypeOf<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>; <R,AdditionalToolArgument>(config):FunctionTool<output<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>; } =FunctionTool.from
Defined in: .build/typescript/packages/core/src/tools/function-tool.ts:185
A simpler alias for creating a FunctionTool.
Call Signature
Section titled “Call Signature”<
T,AdditionalToolArgument>(fn,schema):FunctionTool<T,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
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”<
R,AdditionalToolArgument>(fn,schema):FunctionTool<TypeOf<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
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”<
R,AdditionalToolArgument>(fn,schema):FunctionTool<output<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
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”<
R,AdditionalToolArgument>(config):FunctionTool<TypeOf<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
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”<
R,AdditionalToolArgument>(config):FunctionTool<output<R>,JSONValue|Promise<JSONValue>,AdditionalToolArgument>
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>