Configuration interface for the ZepRetriever class. Extends the BaseRetrieverInput interface.

sessionId - The ID of the Zep session.

url - The URL of the Zep API.

[topK] - The number of results to return.

[apiKey] - The API key for the Zep API.

[searchScope] [searchScope] - The scope of the search: "messages" or "summary".

[searchType] [searchType] - The type of search to perform: "similarity" or "mmr".

[mmrLambda] - The lambda value for the MMR search.

[filter] - The metadata filter to apply to the search.

interface ZepRetrieverConfig {
    apiKey?: string;
    callbacks?: Callbacks;
    filter?: Record<string, unknown>;
    metadata?: Record<string, unknown>;
    mmrLambda?: number;
    searchScope?: "messages" | "summary";
    searchType?: "similarity" | "mmr";
    sessionId: string;
    tags?: string[];
    topK?: number;
    url: string;
    verbose?: boolean;
}

Hierarchy

  • BaseRetrieverInput
    • ZepRetrieverConfig

Properties

apiKey?: string
callbacks?: Callbacks
filter?: Record<string, unknown>
metadata?: Record<string, unknown>
mmrLambda?: number
searchScope?: "messages" | "summary"
searchType?: "similarity" | "mmr"
sessionId: string
tags?: string[]
topK?: number
url: string
verbose?: boolean