Class StructuredTool<T>Abstract

Base class for Tools that accept input of any shape defined by a Zod schema.

Type Parameters

  • T extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>

Hierarchy

Constructors

Properties

description: string
name: string
returnDirect: boolean = false
schema: T | ZodEffects<T, output<T>, input<T>>
verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
metadata?: Record<string, unknown>
tags?: string[]

Methods

  • Calls the tool with the provided argument, configuration, and tags. It parses the input according to the schema, handles any errors, and manages callbacks.

    Parameters

    • arg: input<T> | (output<T> extends string
          ? string
          : never)

      The input argument for the tool.

    • Optional configArg: Callbacks | BaseCallbackConfig

      Optional configuration or callbacks for the tool.

    • Optional tags: string[]

      Optional tags for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

  • Invokes the tool with the provided input and configuration.

    Parameters

    • input: input<T> | (output<T> extends string
          ? string
          : never)

      The input for the tool.

    • Optional config: BaseCallbackConfig

      Optional configuration for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<string, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<input<T> | (output<T> extends string
        ? string
        : never), Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    • input: input<T> | (output<T> extends string
          ? string
          : never)
    • Optional options: Partial<BaseCallbackConfig>

    Returns Promise<IterableReadableStream<string>>

    A readable stream that is also an iterable.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: input<T> | (output<T> extends string
          ? string
          : never)
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    • generator: AsyncGenerator<input<T> | (output<T> extends string
          ? string
          : never), any, unknown>
    • options: Partial<BaseCallbackConfig>

    Returns AsyncGenerator<string, any, unknown>

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    • fields: {
          fallbacks: Runnable<input<T> | (output<T> extends string
              ? string
              : never), string, BaseCallbackConfig>[];
      }
      • fallbacks: Runnable<input<T> | (output<T> extends string
            ? string
            : never), string, BaseCallbackConfig>[]

        Other runnables to call if the runnable errors.

    Returns RunnableWithFallbacks<input<T> | (output<T> extends string
        ? string
        : never), string>

    A new RunnableWithFallbacks.

Generated using TypeDoc