RetrievalOptions interface

Options for configuring retrieval queries in SemanticRetriever.

Signature:

export declare interface RetrievalOptions 

Properties

Property Type Description
limit number The maximum number of results to return. Defaults to 5.
metadataFilter Record<string, string> Key-value metadata filter to restrict matching records.

RetrievalOptions.limit

The maximum number of results to return. Defaults to 5.

Signature:

readonly limit?: number;

RetrievalOptions.metadataFilter

Key-value metadata filter to restrict matching records.

Signature:

readonly metadataFilter?: Record<string, string>;