kartik-mem0
08a5a931e0
Addresses review feedback on #6944. The Performance Improvements table in platform-v2-to-v3.mdx still read 91.6 (+20.2) / 93.4 (+25.6) while the Overview prose in the same file already read 92.5 / 94.4, so the page stated both sets of numbers. Reconciled against the research team's current figures in README.md: 71.4 -> 92.5 (+21.1) and 67.8 -> 94.4 (+26.6). Delivered the three one-liner sweep edits the PR description claimed but never shipped: the README banner alt text, the mem0-ts README title and lede, and the docs/introduction.mdx frontmatter description. The dated changelog entry at 91.6 / 93.4 stays as-is; it records what was announced on 2026-04-14.
65 lines
2.4 KiB
Markdown
65 lines
2.4 KiB
Markdown
# Mem0 - The Memory Layer for AI Agents
|
|
|
|
Mem0 is the memory layer for AI agents. We offer both cloud and open-source solutions to cater to different needs.
|
|
|
|
See the complete [OSS Docs](https://docs.mem0.ai/open-source/node-quickstart).
|
|
See the complete [Platform API Reference](https://docs.mem0.ai/api-reference).
|
|
|
|
## 1. Installation
|
|
|
|
For the open-source version, you can install the Mem0 package using npm:
|
|
|
|
```bash
|
|
npm i mem0ai
|
|
```
|
|
|
|
## 2. API Key Setup
|
|
|
|
For the cloud offering, sign in to [Mem0 Platform](https://app.mem0.ai/dashboard/api-keys?utm_source=oss&utm_medium=mem0-ts-readme) to obtain your API Key.
|
|
|
|
## 3. Client Features
|
|
|
|
### Cloud Offering
|
|
|
|
The cloud version provides a comprehensive set of features, including:
|
|
|
|
- **Memory Operations**: Perform CRUD operations on memories.
|
|
- **Search Capabilities**: Search for relevant memories using advanced filters.
|
|
- **Memory History**: Track changes to memories over time.
|
|
- **Error Handling**: Robust error handling for API-related issues.
|
|
- **Async/Await Support**: All methods return promises for easy integration.
|
|
|
|
### Open-Source Offering
|
|
|
|
The open-source version includes the following top features:
|
|
|
|
- **Memory Management**: Add, update, delete, and retrieve memories.
|
|
- **Vector Store Integration**: Supports various vector store providers for efficient memory retrieval.
|
|
- **LLM Support**: Integrates with multiple LLM providers for generating responses.
|
|
- **Customizable Configuration**: Easily configure memory settings and providers.
|
|
- **SQLite Storage**: Use SQLite for memory history management.
|
|
|
|
## 4. Memory Operations
|
|
|
|
Mem0 provides a simple and customizable interface for performing memory operations. You can create long-term and short-term memories, search for relevant memories, and manage memory history.
|
|
|
|
## 5. Error Handling
|
|
|
|
The MemoryClient throws errors for any API-related issues. You can catch and handle these errors effectively.
|
|
|
|
## 6. Using with async/await
|
|
|
|
All methods of the MemoryClient return promises, allowing for seamless integration with async/await syntax.
|
|
|
|
## 7. Testing the Client
|
|
|
|
To test the MemoryClient in a Node.js environment, you can create a simple script to verify the functionality of memory operations.
|
|
|
|
## Getting Help
|
|
|
|
If you have any questions or need assistance, please reach out to us:
|
|
|
|
- Email: founders@mem0.ai
|
|
- [Join our discord community](https://mem0.ai/discord)
|
|
- GitHub Issues: [Report bugs or request features](https://github.com/mem0ai/mem0/issues)
|