Class for question answering over an index. It retrieves relevant documents based on a query. It extends the BaseRetriever class and implements the SelfQueryRetrieverArgs interface.

Example

const selfQueryRetriever = await SelfQueryRetriever.fromLLM({
llm: new ChatOpenAI(),
vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),
documentContents: "Brief summary of a movie",
attributeInfo: attributeInfo,
structuredQueryTranslator: new FunctionalTranslator(),
});
const relevantDocuments = await selfQueryRetriever.getRelevantDocuments(
"Which movies are directed by Greta Gerwig?",
);

Type Parameters

Hierarchy

Implements

Constructors

Properties

llmChain: LLMChain<string, LLMType>
structuredQueryTranslator: BaseTranslator<T>
useOriginalQuery: boolean = false
vectorStore: T
callbacks?: Callbacks
metadata?: Record<string, unknown>
searchParams?: {
    filter?: T["FilterType"];
    forceDefaultFilter?: boolean;
    k?: number;
    mergeFiltersOperator?: "replace" | "and" | "or";
} = ...

Type declaration

  • Optional filter?: T["FilterType"]
  • Optional forceDefaultFilter?: boolean
  • Optional k?: number
  • Optional mergeFiltersOperator?: "replace" | "and" | "or"
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>>[])[]>

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

  • Parameters

    Returns Promise<Document<Record<string, 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<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 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>

  • Static method to create a new SelfQueryRetriever instance from a BaseLanguageModel and a VectorStore. It first loads a query constructor chain using the loadQueryConstructorChain function, then creates a new SelfQueryRetriever instance with the loaded chain and the provided options.

    Type Parameters

    Parameters

    Returns SelfQueryRetriever<T>

    A new instance of SelfQueryRetriever.

Generated using TypeDoc