Interface SelfQueryRetrieverArgs<T>

Interface for the arguments required to create a SelfQueryRetriever instance. It extends the BaseRetrieverInput interface.

interface SelfQueryRetrieverArgs<T> {
    queryConstructor: RunnableInterface<{
        query: string;
    }, StructuredQuery, RunnableConfig>;
    structuredQueryTranslator: BaseTranslator<T>;
    vectorStore: T;
    searchParams?: {
        filter?: T["FilterType"];
        forceDefaultFilter?: boolean;
        k?: number;
        mergeFiltersOperator?: "and" | "or" | "replace";
    };
    useOriginalQuery?: boolean;
    verbose?: boolean;
}

Type Parameters

  • T extends VectorStore

Hierarchy

  • BaseRetrieverInput
    • SelfQueryRetrieverArgs

Implemented by

Properties

queryConstructor structuredQueryTranslator vectorStore searchParams? useOriginalQuery? verbose?

Properties

queryConstructor

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

Type declaration

  • query: string

structuredQueryTranslator

structuredQueryTranslator: BaseTranslator<T>

vectorStore

vectorStore: T

Optional searchParams

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

Type declaration

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

Optional useOriginalQuery

useOriginalQuery?: boolean

Optional verbose

verbose?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc