Interface ToolInterface<SchemaT, SchemaInputT>

A special interface for tools that accept a string input, usually defined with the Tool class.

interface ToolInterface<SchemaT, SchemaInputT> {
    description: string;
    name: string;
    returnDirect: boolean;
    schema: SchemaT;
    batch(inputs: StructuredToolCallInput<SchemaT, SchemaInputT>[], options?: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[], batchOptions?: RunnableBatchOptions & {
        returnExceptions?: false;
    }): Promise<any[]>;
    batch(inputs: StructuredToolCallInput<SchemaT, SchemaInputT>[], options?: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[], batchOptions?: RunnableBatchOptions & {
        returnExceptions: true;
    }): Promise<any[]>;
    batch(inputs: StructuredToolCallInput<SchemaT, SchemaInputT>[], options?: Partial<RunnableConfig<Record<string, any>>> | Partial<RunnableConfig<Record<string, any>>>[], batchOptions?: RunnableBatchOptions): Promise<any[]>;
    call(arg:
        | undefined
        | string
        | ToolCall
        | SchemaInputT, callbacks?: Callbacks | RunnableConfig<Record<string, any>>): Promise<any>;
    getName(suffix?: string): string;
    invoke(input: StructuredToolCallInput<SchemaT, SchemaInputT>, options?: Partial<RunnableConfig<Record<string, any>>>): Promise<any>;
    stream(input: StructuredToolCallInput<SchemaT, SchemaInputT>, options?: Partial<RunnableConfig<Record<string, any>>>): Promise<IterableReadableStreamInterface<any>>;
    transform(generator: AsyncGenerator<StructuredToolCallInput<SchemaT, SchemaInputT>, any, unknown>, options: Partial<RunnableConfig<Record<string, any>>>): AsyncGenerator<any, any, unknown>;
}

Type Parameters

  • SchemaT extends ToolSchemaBase = ZodObjectAny | z.ZodEffects<ZodObjectAny> | JSONSchema

    The type of the tool input schema. Usually you don't need to specify this.

  • SchemaInputT = ToolInputSchemaInputType<SchemaT>

    The TypeScript type representing the structure of the tool arguments generated by the LLM. Useful for type checking tool handler functions when using JSONSchema.

Hierarchy (view full)

Properties

description name returnDirect schema

Methods

batch call getName invoke stream transform

Properties

description

description: string

A description of the tool.

name

name: string

The name of the tool.

returnDirect

returnDirect: boolean

Whether to return the tool's output directly.

Setting this to true means that after the tool is called, an agent should stop looping.

schema

schema: SchemaT

A Zod schema representing the parameters of the tool.

Methods

batch

call

  • call(arg, callbacks?): Promise<any>

  • Parameters

    • arg:
          | undefined
          | string
          | ToolCall
          | SchemaInputT

      The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.

    • Optionalcallbacks: Callbacks | RunnableConfig<Record<string, any>>

      Optional callbacks for the tool.

    Returns Promise<any>

    A Promise that resolves with a string.

    Deprecated

    Use .invoke() instead. Will be removed in 0.3.0.

    Calls the tool with the provided argument and callbacks. It handles string inputs specifically.

getName

invoke

stream

transform

Settings

Member Visibility

On This Page

Properties
Methods