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

Argument

sessionId - The ID of the Zep session.

Argument

url - The URL of the Zep API.

Argument

[topK] - The number of results to return.

Argument

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

Argument

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

Argument

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

Argument

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

Argument

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

interface ZepRetrieverConfig {
    sessionId: string;
    url: string;
    apiKey?: string;
    filter?: Record<string, unknown>;
    mmrLambda?: number;
    searchScope?: "messages" | "summary";
    searchType?: "similarity" | "mmr";
    topK?: number;
}

Hierarchy

  • BaseRetrieverInput
    • ZepRetrieverConfig

Properties

sessionId: string
url: string
apiKey?: string
filter?: Record<string, unknown>
mmrLambda?: number
searchScope?: "messages" | "summary"
searchType?: "similarity" | "mmr"
topK?: number

Generated using TypeDoc