Class used to manage the memory of a chat session, including loading and saving the chat history, and clearing the memory when needed. It uses the ZepClient to interact with the Zep service for managing the chat session's memory.

const sessionId = randomUUID();

// Initialize ZepCloudMemory with session ID and API key
const memory = new ZepCloudMemory({
sessionId,
apiKey: "<zep api key>",
});

// Create a ChatOpenAI model instance with specific parameters
const model = new ChatOpenAI({
modelName: "gpt-3.5-turbo",
temperature: 0,
});

// Create a ConversationChain with the model and memory
const chain = new ConversationChain({ llm: model, memory });

// Example of calling the chain with an input
const res1 = await chain.call({ input: "Hi! I'm Jim." });
console.log({ res1 });

// Follow-up call to the chain to demonstrate memory usage
const res2 = await chain.call({ input: "What did I just say my name was?" });
console.log({ res2 });

// Output the session ID and the current state of memory
console.log("Session ID: ", sessionId);
console.log("Memory: ", await memory.loadMemoryVariables({}));

Hierarchy

  • BaseChatMemory
    • ZepCloudMemory

Implements

Constructors

Properties

aiPrefix: string = "AI"
apiKey: string
humanPrefix: string = "Human"
memoryKey: string = "history"
memoryType: MemoryType
separateMessages: boolean
sessionId: string
zepClient: ZepClient

Accessors

Methods

  • Method that retrieves the chat history from the Zep service and formats it into a list of messages.

    Parameters

    • values: InputValues

      Input values for the method.

    Returns Promise<MemoryVariables>

    Promise that resolves with the chat history formatted into a list of messages.

  • Method that saves the input and output messages to the Zep service.

    Parameters

    • inputValues: InputValues

      Input messages to be saved.

    • outputValues: OutputValues

      Output messages to be saved.

    Returns Promise<void>

    Promise that resolves when the messages have been saved.