Adds Langchain Community Package (#2417)

mem0-ts/package.json

@@ -56,7 +56,13 @@
     "sourcemap": true,
     "clean": true,
     "treeshake": true,
-    "minify": false
+    "minify": false,
+    "external": [
+      "@mem0/community"
+    ],
+    "noExternal": [
+      "!src/community/**"
+    ]
   },
   "keywords": [
     "mem0",

mem0-ts/src/community/.prettierignore

@@ -0,0 +1,28 @@
+# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Build outputs
+dist
+build
+
+# Lock files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# Coverage
+coverage
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log* 

mem0-ts/src/community/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@mem0/community",
+  "version": "0.0.1",
+  "description": "Community features for Mem0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./langchain": {
+      "types": "./dist/integrations/langchain/index.d.ts",
+      "require": "./dist/integrations/langchain/index.js",
+      "import": "./dist/integrations/langchain/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && npx prettier --check . && npx tsup",
+    "dev": "npx nodemon",
+    "test": "jest",
+    "test:ts": "jest --config jest.config.js",
+    "test:watch": "jest --config jest.config.js --watch",
+    "format": "npm run clean && prettier --write .",
+    "format:check": "npm run clean && prettier --check .",
+    "prepublishOnly": "npm run build"
+  },
+  "tsup": {
+    "entry": {
+      "index": "src/index.ts",
+      "integrations/langchain/index": "src/integrations/langchain/index.ts"
+    },
+    "format": [
+      "cjs",
+      "esm"
+    ],
+    "dts": {
+      "resolve": true,
+      "compilerOptions": {
+        "rootDir": "src"
+      }
+    },
+    "splitting": false,
+    "sourcemap": true,
+    "clean": true,
+    "treeshake": true,
+    "minify": false,
+    "outDir": "dist",
+    "tsconfig": "./tsconfig.json"
+  },
+  "keywords": [
+    "mem0",
+    "community",
+    "ai",
+    "memory"
+  ],
+  "author": "Deshraj Yadav",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/node": "^22.7.6",
+    "@types/uuid": "^9.0.8",
+    "dotenv": "^16.4.5",
+    "jest": "^29.7.0",
+    "nodemon": "^3.0.1",
+    "prettier": "^3.5.2",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.2.6",
+    "tsup": "^8.3.0",
+    "typescript": "5.5.4"
+  },
+  "dependencies": {
+    "@langchain/community": "^0.3.36",
+    "@langchain/core": "^0.3.42",
+    "axios": "1.7.7",
+    "mem0ai": "^2.1.8",
+    "uuid": "9.0.1",
+    "zod": "3.22.4"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

mem0-ts/src/community/src/index.ts

@@ -0,0 +1 @@
+export * from "./integrations/langchain";

mem0-ts/src/community/src/integrations/langchain/index.ts

@@ -0,0 +1 @@
+export * from "./mem0";

mem0-ts/src/community/src/integrations/langchain/mem0.ts

@@ -0,0 +1,314 @@
+import { MemoryClient } from "mem0ai";
+import type { Memory, MemoryOptions, SearchOptions } from "mem0ai";
+
+import {
+  InputValues,
+  OutputValues,
+  MemoryVariables,
+  getInputValue,
+  getOutputValue,
+} from "@langchain/core/memory";
+import {
+  AIMessage,
+  BaseMessage,
+  ChatMessage,
+  getBufferString,
+  HumanMessage,
+  SystemMessage,
+} from "@langchain/core/messages";
+import {
+  BaseChatMemory,
+  BaseChatMemoryInput,
+} from "@langchain/community/memory/chat_memory";
+
+/**
+ * Extracts and formats memory content into a system prompt
+ * @param memory Array of Memory objects from mem0ai
+ * @returns Formatted system prompt string
+ */
+export const mem0MemoryContextToSystemPrompt = (memory: Memory[]): string => {
+  if (!memory || !Array.isArray(memory)) {
+    return "";
+  }
+
+  return memory
+    .filter((m) => m?.memory)
+    .map((m) => m.memory)
+    .join("\n");
+};
+
+/**
+ * Condenses memory content into a single HumanMessage with context
+ * @param memory Array of Memory objects from mem0ai
+ * @returns HumanMessage containing formatted memory context
+ */
+export const condenseMem0MemoryIntoHumanMessage = (
+  memory: Memory[],
+): HumanMessage => {
+  const basePrompt =
+    "These are the memories I have stored. Give more weightage to the question by users and try to answer that first. You have to modify your answer based on the memories I have provided. If the memories are irrelevant you can ignore them. Also don't reply to this section of the prompt, or the memories, they are only for your reference. The MEMORIES of the USER are: \n\n";
+  const systemPrompt = mem0MemoryContextToSystemPrompt(memory);
+
+  return new HumanMessage(`${basePrompt}\n${systemPrompt}`);
+};
+
+/**
+ * Converts Mem0 memories to a list of BaseMessages
+ * @param memories Array of Memory objects from mem0ai
+ * @returns Array of BaseMessage objects
+ */
+export const mem0MemoryToMessages = (memories: Memory[]): BaseMessage[] => {
+  if (!memories || !Array.isArray(memories)) {
+    return [];
+  }
+
+  const messages: BaseMessage[] = [];
+
+  // Add memories as system message if present
+  const memoryContent = memories
+    .filter((m) => m?.memory)
+    .map((m) => m.memory)
+    .join("\n");
+
+  if (memoryContent) {
+    messages.push(new SystemMessage(memoryContent));
+  }
+
+  // Add conversation messages
+  memories.forEach((memory) => {
+    if (memory.messages) {
+      memory.messages.forEach((msg) => {
+        const content =
+          typeof msg.content === "string"
+            ? msg.content
+            : JSON.stringify(msg.content);
+        if (msg.role === "user") {
+          messages.push(new HumanMessage(content));
+        } else if (msg.role === "assistant") {
+          messages.push(new AIMessage(content));
+        } else if (content) {
+          messages.push(new ChatMessage(content, msg.role));
+        }
+      });
+    }
+  });
+
+  return messages;
+};
+
+/**
+ * Interface defining the structure of the input data for the Mem0Client
+ */
+export interface ClientOptions {
+  apiKey: string;
+  host?: string;
+  organizationName?: string;
+  projectName?: string;
+  organizationId?: string;
+  projectId?: string;
+}
+
+/**
+ * Interface defining the structure of the input data for the Mem0Memory
+ * class. It includes properties like memoryKey, sessionId, and apiKey.
+ */
+export interface Mem0MemoryInput extends BaseChatMemoryInput {
+  sessionId: string;
+  apiKey: string;
+  humanPrefix?: string;
+  aiPrefix?: string;
+  memoryOptions?: MemoryOptions | SearchOptions;
+  mem0Options?: ClientOptions;
+  separateMessages?: boolean;
+}
+
+/**
+ * Class used to manage the memory of a chat session using the Mem0 service.
+ * It handles loading and saving chat history, and provides methods to format
+ * the memory content for use in chat models.
+ *
+ * @example
+ * ```typescript
+ * const memory = new Mem0Memory({
+ *   sessionId: "user123" // or use user_id inside of memoryOptions (recommended),
+ *   apiKey: "your-api-key",
+ *   memoryOptions: {
+ *     user_id: "user123",
+ *     run_id: "run123"
+ *   },
+ * });
+ *
+ * // Use with a chat model
+ * const model = new ChatOpenAI({
+ *   modelName: "gpt-3.5-turbo",
+ *   temperature: 0,
+ * });
+ *
+ * const chain = new ConversationChain({ llm: model, memory });
+ * ```
+ */
+export class Mem0Memory extends BaseChatMemory implements Mem0MemoryInput {
+  memoryKey = "history";
+
+  apiKey: string;
+
+  sessionId: string;
+
+  humanPrefix = "Human";
+
+  aiPrefix = "AI";
+
+  mem0Client: InstanceType<typeof MemoryClient>;
+
+  memoryOptions: MemoryOptions | SearchOptions;
+
+  mem0Options: ClientOptions;
+
+  // Whether to return separate messages for chat history with a SystemMessage containing (facts and summary) or return a single HumanMessage with the entire memory context.
+  // Defaults to false (return a single HumanMessage) in order to allow more flexibility with different models.
+  separateMessages?: boolean;
+
+  constructor(fields: Mem0MemoryInput) {
+    if (!fields.apiKey) {
+      throw new Error("apiKey is required for Mem0Memory");
+    }
+    if (!fields.sessionId) {
+      throw new Error("sessionId is required for Mem0Memory");
+    }
+
+    super({
+      returnMessages: fields?.returnMessages ?? false,
+      inputKey: fields?.inputKey,
+      outputKey: fields?.outputKey,
+    });
+
+    this.apiKey = fields.apiKey;
+    this.sessionId = fields.sessionId;
+    this.humanPrefix = fields.humanPrefix ?? this.humanPrefix;
+    this.aiPrefix = fields.aiPrefix ?? this.aiPrefix;
+    this.memoryOptions = fields.memoryOptions ?? {};
+    this.mem0Options = fields.mem0Options ?? {
+      apiKey: this.apiKey,
+    };
+    this.separateMessages = fields.separateMessages ?? false;
+    try {
+      this.mem0Client = new MemoryClient({
+        ...this.mem0Options,
+        apiKey: this.apiKey,
+      });
+    } catch (error) {
+      console.error("Failed to initialize Mem0Client:", error);
+      throw new Error(
+        "Failed to initialize Mem0Client. Please check your configuration.",
+      );
+    }
+  }
+
+  get memoryKeys(): string[] {
+    return [this.memoryKey];
+  }
+
+  /**
+   * Retrieves memories from the Mem0 service and formats them for use
+   * @param values Input values containing optional search query
+   * @returns Promise resolving to formatted memory variables
+   */
+  async loadMemoryVariables(values: InputValues): Promise<MemoryVariables> {
+    const searchType = values.input ? "search" : "get_all";
+    let memories: Memory[] = [];
+
+    try {
+      if (searchType === "get_all") {
+        memories = await this.mem0Client.getAll({
+          user_id: this.sessionId,
+          ...this.memoryOptions,
+        });
+      } else {
+        memories = await this.mem0Client.search(values.input, {
+          user_id: this.sessionId,
+          ...this.memoryOptions,
+        });
+      }
+    } catch (error) {
+      console.error("Error loading memories:", error);
+      return this.returnMessages
+        ? { [this.memoryKey]: [] }
+        : { [this.memoryKey]: "" };
+    }
+
+    if (this.returnMessages) {
+      return {
+        [this.memoryKey]: this.separateMessages
+          ? mem0MemoryToMessages(memories)
+          : [condenseMem0MemoryIntoHumanMessage(memories)],
+      };
+    }
+
+    return {
+      [this.memoryKey]: this.separateMessages
+        ? getBufferString(
+            mem0MemoryToMessages(memories),
+            this.humanPrefix,
+            this.aiPrefix,
+          )
+        : (condenseMem0MemoryIntoHumanMessage(memories).content ?? ""),
+    };
+  }
+
+  /**
+   * Saves the current conversation context to the Mem0 service
+   * @param inputValues Input messages to be saved
+   * @param outputValues Output messages to be saved
+   * @returns Promise resolving when the context has been saved
+   */
+  async saveContext(
+    inputValues: InputValues,
+    outputValues: OutputValues,
+  ): Promise<void> {
+    const input = getInputValue(inputValues, this.inputKey);
+    const output = getOutputValue(outputValues, this.outputKey);
+
+    if (!input || !output) {
+      console.warn("Missing input or output values, skipping memory save");
+      return;
+    }
+
+    try {
+      const messages = [
+        {
+          role: "user",
+          content: `${input}`,
+        },
+        {
+          role: "assistant",
+          content: `${output}`,
+        },
+      ];
+
+      await this.mem0Client.add(messages, {
+        user_id: this.sessionId,
+        ...this.memoryOptions,
+      });
+    } catch (error) {
+      console.error("Error saving memory context:", error);
+      // Continue execution even if memory save fails
+    }
+
+    await super.saveContext(inputValues, outputValues);
+  }
+
+  /**
+   * Clears all memories for the current session
+   * @returns Promise resolving when memories have been cleared
+   */
+  async clear(): Promise<void> {
+    try {
+      // Note: Implement clear functionality if Mem0Client provides it
+      // await this.mem0Client.clear(this.sessionId);
+    } catch (error) {
+      console.error("Error clearing memories:", error);
+    }
+
+    await super.clear();
+  }
+}

mem0-ts/src/community/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020"],
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "types": ["node"],
+    "typeRoots": ["./node_modules/@types"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
+}