langchain.js
    Preparing search index...

    Class ZepCloudRetriever

    Class for retrieving information from a Zep Cloud long-term memory store. Extends the BaseRetriever class.

    const retriever = new ZepCloudRetriever({
      apiKey: "<zep cloud project api key>",
      sessionId: "session_exampleUUID",
      topK: 3,
    });
    const query = "Can I drive red cars in France?";
    const docs = await retriever.getRelevantDocuments(query);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client lc_namespace

    Accessors

    lc_aliases lc_secrets

    Methods

    _getRelevantDocuments lc_name

    Constructors

    Properties

    client: ZepClient
    lc_namespace: string[] = ...

    Accessors

    • get lc_aliases(): undefined | { [key: string]: string }

      Returns undefined | { [key: string]: string }

    • get lc_secrets(): undefined | { [key: string]: string }

      Returns undefined | { [key: string]: string }

    Methods

    _getRelevantDocuments

    • _getRelevantDocuments(query: string): Promise<Document[]>

      Retrieves the relevant documents based on the given query.

      Parameters

      • query: string

        The query string.

      Returns Promise<Document[]>

      A promise that resolves to an array of relevant Document objects.

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods