Class RemoteRetrieverAbstract

Abstract class for interacting with a remote server to retrieve relevant documents based on a given query.

Hierarchy

Implements

Constructors

Properties

asyncCaller: AsyncCaller

The authentication method to use, currently implemented is

  • false: no authentication
  • { bearer: string }: Bearer token authentication
headers: Record<string, string>
url: string

The URL of the remote retriever server

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

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

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

  • Parameters

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

  • Parameters

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

  • Abstract method that should be implemented by subclasses to create the JSON body of the request based on the given query.

    Parameters

    • query: string

      The query based on which the JSON body of the request is created.

    Returns RemoteRetrieverValues

    The JSON body of the request.

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

      Optional configuration object for the retrieval process.

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

    A promise that resolves to an array of Document objects.

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

  • Abstract method that should be implemented by subclasses to process the JSON response from the server and convert it into an array of Document instances.

    Parameters

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

    An array of Document instances.

  • Stream output in chunks.

    Parameters

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

    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

    Returns AsyncGenerator<Document<Record<string, any>>[], any, unknown>

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

Generated using TypeDoc