A tool for the VectorDBQA chain to interact with a Vector Store. It is used to answer questions about a specific topic. The input to this tool should be a fully formed question.

Hierarchy

  • Tool
    • VectorStoreQATool

Implements

  • VectorStoreTool

Constructors

Properties

description: string
name: string
returnDirect: boolean
schema: ZodEffects<ZodObject<{
    input: ZodOptional<ZodString>;
}, "strip", ZodTypeAny, {
    input?: string;
}, {
    input?: string;
}>, undefined | string, {
    input?: string;
}>

Type declaration

  • Optional input?: string
vectorStore: VectorStore
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: (string | {})[]

      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)[]>

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

    Parameters

    • arg: undefined | string | {
          input?: string;
      }

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

    • Optional callbacks: BaseCallbackConfig | Callbacks

      Optional callbacks for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

  • Invokes the tool with the provided input and configuration.

    Parameters

    • input: string | {}

      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<(string | {})[], 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<string | {}, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    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: string | {}
    • 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<string | {}, 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

    Returns RunnableWithFallbacks<string | {}, 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<string | {}, string, BaseCallbackConfig>

  • Returns a string that describes what the tool does.

    Parameters

    • name: string

      The name of the tool.

    • description: string

      A description of what the tool does.

    Returns string

    A string that describes what the tool does.

Generated using TypeDoc