SemanticRetrieverOptions interface

Options for configuring SemanticRetriever and retrieval queries (also exported as RetrievalOptions).

Signature:

export declare interface SemanticRetrieverOptions 

Properties

Property Type Description
limit number | undefined Maximum number of top-matching records to return. Defaults to 5.
metadataFilter Record<string, string> | undefined Optional key-value metadata filter; only records matching all specified pairs are returned.

SemanticRetrieverOptions.limit

Maximum number of top-matching records to return. Defaults to 5.

Signature:

limit?: number;

SemanticRetrieverOptions.metadataFilter

Optional key-value metadata filter; only records matching all specified pairs are returned.

Signature:

metadataFilter?: Record<string, string>;