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
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

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

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

      Array of inputs to each batch call.

    • Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<string[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(string | Error)[]>

  • Parameters

    Returns Promise<(string | Error)[]>

  • Bind arguments to a Runnable, returning a new Runnable.

    Parameters

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

    A new RunnableBinding that, when invoked, will apply the bound args.

  • 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: BaseCallbackConfig | Callbacks

      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.

  • Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

    Returns Runnable<((output<T> extends string
        ? string
        : never) | input<T>)[], string[], BaseCallbackConfig>

  • 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<(output<T> extends string
        ? string
        : never) | input<T>, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    • input: (output<T> extends string
          ? string
          : never) | input<T>
    • 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: (output<T> extends string
          ? string
          : never) | input<T>
    • 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<(output<T> extends string
          ? string
          : never) | input<T>, any, unknown>
    • options: Partial<BaseCallbackConfig>

    Returns AsyncGenerator<string, any, unknown>

  • Bind config to a Runnable, returning a new Runnable.

    Parameters

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

    A new RunnableBinding with a config matching what's passed.

  • 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<(output<T> extends string
              ? string
              : never) | input<T>, string, BaseCallbackConfig>[];
      }
      • fallbacks: Runnable<(output<T> extends string
            ? string
            : never) | input<T>, string, BaseCallbackConfig>[]

        Other runnables to call if the runnable errors.

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

    A new RunnableWithFallbacks.

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>
          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

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

Generated using TypeDoc