Class MultiQueryRetriever

Optional callbacks

Optional metadata

Optional tags

Optional verbose

batch

• batch(inputs, options?, batchOptions?): Promise<Document<Record<string, any>>[][]>

• 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<Document<Record<string, any>>[][]>

  An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
• batch(inputs, options?, batchOptions?): Promise<(Error | Document<Record<string, any>>[])[]>

• Parameters

  • inputs: string[]

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

  • Optional batchOptions: RunnableBatchOptions & {
        returnExceptions: true;
    }

  Returns Promise<(Error | Document<Record<string, any>>[])[]>

• batch(inputs, options?, batchOptions?): Promise<(Error | Document<Record<string, any>>[])[]>

• Parameters

  • inputs: string[]

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

  • Optional batchOptions: RunnableBatchOptions

  Returns Promise<(Error | Document<Record<string, any>>[])[]>

bind

• bind(kwargs): Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>

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

  Parameters

  • kwargs: Partial<BaseCallbackConfig>

  Returns Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>

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

getRelevantDocuments

• getRelevantDocuments(query, config?): Promise<Document<Record<string, any>>[]>

• Main method used to retrieve relevant documents. It takes a query string and an optional configuration object, and returns a promise that resolves to an array of Document objects. This method handles the retrieval process, including starting and ending callbacks, and error handling.

  Parameters

  • query: string

    The query string to retrieve relevant documents for.

  • Optional config: Callbacks | BaseCallbackConfig

    Optional configuration object for the retrieval process.

  Returns Promise<Document<Record<string, any>>[]>

  A promise that resolves to an array of Document objects.

invoke

• invoke(input, options?): Promise<Document<Record<string, any>>[]>

• Parameters

  • input: string

  • Optional options: BaseCallbackConfig

  Returns Promise<Document<Record<string, any>>[]>

map

• map(): Runnable<string[], Document<Record<string, any>>[][], BaseCallbackConfig>

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

  Returns Runnable<string[], Document<Record<string, any>>[][], BaseCallbackConfig>

pipe

• pipe<NewRunOutput>(coerceable): RunnableSequence<string, Exclude<NewRunOutput, Error>>

• 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<Document<Record<string, any>>[], NewRunOutput>

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

  Returns RunnableSequence<string, Exclude<NewRunOutput, Error>>

  A new runnable sequence.

stream

• stream(input, options?): Promise<IterableReadableStream<Document<Record<string, any>>[]>>

• Stream output in chunks.

  Parameters

  • input: string

  • Optional options: Partial<BaseCallbackConfig>

  Returns Promise<IterableReadableStream<Document<Record<string, any>>[]>>

  A readable stream that is also an iterable.

streamLog

• streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>

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

toJSON

• toJSON(): Serialized

• Returns Serialized

toJSONNotImplemented

• toJSONNotImplemented(): SerializedNotImplemented

• Returns SerializedNotImplemented

transform

• transform(generator, options): AsyncGenerator<Document<Record<string, any>>[], 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<Document<Record<string, any>>[], any, unknown>

withConfig

• withConfig(config): RunnableBinding<string, Document<Record<string, any>>[], BaseCallbackConfig>

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

  Parameters

  • config: BaseCallbackConfig

    New configuration parameters to attach to the new runnable.

  Returns RunnableBinding<string, Document<Record<string, any>>[], BaseCallbackConfig>

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

withFallbacks

• withFallbacks(fields): RunnableWithFallbacks<string, Document<Record<string, any>>[]>

• 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<string, Document<Record<string, any>>[], BaseCallbackConfig>[];
    }

    • fallbacks: Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>[]

      Other runnables to call if the runnable errors.

  Returns RunnableWithFallbacks<string, Document<Record<string, any>>[]>

  A new RunnableWithFallbacks.

withRetry

• withRetry(fields?): RunnableRetry<string, Document<Record<string, any>>[], BaseCallbackConfig>

• Add retry logic to an existing runnable.

  Parameters

  • Optional fields: {
        onFailedAttempt?: RunnableRetryFailedAttemptHandler;
        stopAfterAttempt?: number;
    }

    • Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler

    • Optional stopAfterAttempt?: number

  Returns RunnableRetry<string, Document<Record<string, any>>[], BaseCallbackConfig>

  A new RunnableRetry that, when invoked, will retry according to the parameters.

Static isRunnable

• isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>

• Parameters

  • thing: any

  Returns thing is Runnable<any, any, BaseCallbackConfig>