Class for performing hybrid search operations on a Supabase database. It extends the BaseRetriever class and implements methods for similarity search, keyword search, and hybrid search.

Hierarchy

Constructors

Properties

client: default<any, "public", any>
keywordK: number
keywordQueryName: string
query: string
similarityK: number
similarityQueryName: string
tableName: string
callbacks?: Callbacks
metadata?: Record<string, unknown>
name?: string
tags?: string[]
verbose?: boolean

Methods

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns RunnableSequence<any, 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<RunnableConfig> | Partial<RunnableConfig>[]

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

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

  • Parameters

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

  • Parameters

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

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

    Parameters

    Returns Runnable<string, DocumentInterface<Record<string, any>>[], RunnableConfig>

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

  • Parameters

    • Optional suffix: string

    Returns string

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

    A promise that resolves to an array of Document objects.

  • Parameters

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

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

    Returns Runnable<string[], DocumentInterface<Record<string, any>>[][], RunnableConfig>

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns RunnableSequence<any, any>

  • 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<DocumentInterface<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 output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<DocumentInterface<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<RunnableConfig>
    • 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<RunnableConfig>

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

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

    Parameters

    • config: RunnableConfig

      New configuration parameters to attach to the new runnable.

    Returns RunnableBinding<string, DocumentInterface<Record<string, any>>[], RunnableConfig>

    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<string, DocumentInterface<Record<string, any>>[], RunnableConfig>[];
      }
      • fallbacks: Runnable<string, DocumentInterface<Record<string, any>>[], RunnableConfig>[]

        Other runnables to call if the runnable errors.

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

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

  • Combines the results of the similaritySearch and keywordSearch methods and returns the top 'k' documents based on a combination of similarity and keyword matching.

    Parameters

    • query: string

      The query to use for the hybrid search.

    • similarityK: number

      The number of top similar documents to return.

    • keywordK: number

      The number of top documents to return that match the keywords.

    • Optional callbacks: Callbacks

      Optional callbacks to pass to the similaritySearch method.

    Returns Promise<SearchResult[]>

    A promise that resolves to an array of search results. Each result is a tuple containing a Document, its combined score, and its ID.

  • Performs a keyword search on the Supabase database using the provided query and returns the top 'k' documents that match the keywords.

    Parameters

    • query: string

      The query to use for the keyword search.

    • k: number

      The number of top documents to return that match the keywords.

    Returns Promise<SearchResult[]>

    A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score multiplied by 10, and its ID.

  • Performs a similarity search on the Supabase database using the provided query and returns the top 'k' similar documents.

    Parameters

    • query: string

      The query to use for the similarity search.

    • k: number

      The number of top similar documents to return.

    • Optional _callbacks: Callbacks

      Optional callbacks to pass to the embedQuery method.

    Returns Promise<SearchResult[]>

    A promise that resolves to an array of search results. Each result is a tuple containing a Document, its similarity score, and its ID.

Generated using TypeDoc