Class SelfQueryRetriever<T>

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 = 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 (view full)

Implements

Constructors

constructor

Properties

queryConstructor structuredQueryTranslator useOriginalQuery vectorStore searchParams? verbose?

Methods

fromLLM

Constructors

constructor

Properties

queryConstructor

queryConstructor: RunnableInterface<{
    query: string;
}, StructuredQuery>

Type declaration

  • query: string

structuredQueryTranslator

structuredQueryTranslator: BaseTranslator<T>

useOriginalQuery

useOriginalQuery: boolean = false

vectorStore

vectorStore: T

Optional searchParams

searchParams?: {
    filter?: T["FilterType"];
    forceDefaultFilter?: boolean;
    k?: number;
    mergeFiltersOperator?: "or" | "and" | "replace";
} = ...

Type declaration

  • Optional filter?: T["FilterType"]
  • Optional forceDefaultFilter?: boolean
  • Optional k?: number
  • Optional mergeFiltersOperator?: "or" | "and" | "replace"

Optional verbose

verbose?: boolean

Methods

Static fromLLM

  • fromLLM<T>(options): SelfQueryRetriever<T>

  • 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

    • T extends VectorStore

    Parameters

    Returns SelfQueryRetriever<T>

    A new instance of SelfQueryRetriever.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc