Base Retriever class. All indexes should extend this class.

Hierarchy

Properties

client: default<any, "public", any>
callbacks?: Callbacks
keywordK?: number

The number of documents to return from the keyword search. Defaults to 2.

keywordQueryName?: string

The name of the Keyword search function on Supabase. Defaults to "kw_match_documents".

metadata?: Record<string, unknown>
similarityK?: number

The number of documents to return from the similarity search. Defaults to 2.

similarityQueryName?: string

The name of the Similarity search function on Supabase. Defaults to "match_documents".

tableName?: string

The table name on Supabase. Defaults to "documents".

tags?: string[]
verbose?: boolean

Generated using TypeDoc