Optional callbacksOptional metadataOptional nameOptional tagsOptional verboseAssigns new fields to the dict output of this runnable. Returns a new runnable.
Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
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 & { An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]Optional batchOptions: RunnableBatchOptionsBind arguments to a Runnable, returning a new Runnable.
A new RunnableBinding that, when invoked, will apply the bound args.
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.
The query string to retrieve relevant documents for.
Optional config: BaseCallbackConfig | CallbacksOptional configuration object for the retrieval process.
A promise that resolves to an array of Document objects.
Optional options: RunnableConfigReturn a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.
Pick keys from the dict output of this runnable. Returns a new runnable.
Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
A runnable, function, or object whose values are functions or runnables.
A new runnable sequence.
Stream output in chunks.
Optional options: Partial<RunnableConfig>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.
Optional options: Partial<RunnableConfig>Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">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.
Bind config to a Runnable, returning a new Runnable.
New configuration parameters to attach to the new runnable.
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.
Other runnables to call if the runnable errors.
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.
The object containing the callback functions.
Optional onCalled after the runnable finishes running, with the Run object.
Optional config: RunnableConfigOptional onCalled if the runnable throws an error, with the Run object.
Optional config: RunnableConfigOptional onCalled before the runnable starts running, with the Run object.
Optional config: RunnableConfigAdd retry logic to an existing runnable.
Optional fields: { Optional onOptional stopA new RunnableRetry that, when invoked, will retry according to the parameters.
Static isProtected hybridCombines the results of the similaritySearch and keywordSearch
methods and returns the top 'k' documents based on a combination of
similarity and keyword matching.
The query to use for the hybrid search.
The number of top similar documents to return.
The number of top documents to return that match the keywords.
Optional callbacks: CallbacksOptional callbacks to pass to the similaritySearch method.
A promise that resolves to an array of search results. Each result is a tuple containing a Document, its combined score, and its ID.
Protected keywordPerforms a keyword search on the Supabase database using the provided query and returns the top 'k' documents that match the keywords.
The query to use for the keyword search.
The number of top documents to return that match the keywords.
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.
Protected similarityPerforms a similarity search on the Supabase database using the provided query and returns the top 'k' similar documents.
The query to use for the similarity search.
The number of top similar documents to return.
Optional _callbacks: CallbacksOptional callbacks to pass to the embedQuery method.
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
Class for performing hybrid search operations on a Supabase database. It extends the
BaseRetrieverclass and implements methods for similarity search, keyword search, and hybrid search.