Interface SelfQueryRetrieverArgs<T>

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

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

Type Parameters

  • T extends VectorStore

Hierarchy

  • BaseRetrieverInput
    • SelfQueryRetrieverArgs

Implemented by

Properties

callbacks? metadata? queryConstructor searchParams? structuredQueryTranslator tags? useOriginalQuery? vectorStore verbose?

Properties

Optionalcallbacks

callbacks?: Callbacks

Optionalmetadata

metadata?: Record<string, unknown>

queryConstructor

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

OptionalsearchParams

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

structuredQueryTranslator

structuredQueryTranslator: BaseTranslator<T>

Optionaltags

tags?: string[]

OptionaluseOriginalQuery

useOriginalQuery?: boolean

vectorStore

vectorStore: T

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties