my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	# Mem0 - The Memory Layer for Your AI Apps
#2
#3	Mem0 is a self-improving memory layer for LLM applications, enabling personalized AI experiences that save costs and delight users. We offer both cloud and open-source solutions to cater to different needs.
#4
#5	See the complete [OSS Docs](https://docs.mem0.ai/open-source/node-quickstart).
#6	See the complete [Platform API Reference](https://docs.mem0.ai/api-reference).
#7
#8	## 1. Installation
#9
#10	For the open-source version, you can install the Mem0 package using npm:
#11
#12	```bash
#13	npm i mem0ai
#14	```
#15
#16	## 2. API Key Setup
#17
#18	For the cloud offering, sign in to [Mem0 Platform](https://app.mem0.ai/dashboard/api-keys) to obtain your API Key.
#19
#20	## 3. Client Features
#21
#22	### Cloud Offering
#23
#24	The cloud version provides a comprehensive set of features, including:
#25
#26	- Memory Operations: Perform CRUD operations on memories.
#27	- Search Capabilities: Search for relevant memories using advanced filters.
#28	- Memory History: Track changes to memories over time.
#29	- Error Handling: Robust error handling for API-related issues.
#30	- Async/Await Support: All methods return promises for easy integration.
#31
#32	### Open-Source Offering
#33
#34	The open-source version includes the following top features:
#35
#36	- Memory Management: Add, update, delete, and retrieve memories.
#37	- Vector Store Integration: Supports various vector store providers for efficient memory retrieval.
#38	- LLM Support: Integrates with multiple LLM providers for generating responses.
#39	- Customizable Configuration: Easily configure memory settings and providers.
#40	- SQLite Storage: Use SQLite for memory history management.
#41
#42	## 4. Memory Operations
#43
#44	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.
#45
#46	## 5. Error Handling
#47
#48	The MemoryClient throws errors for any API-related issues. You can catch and handle these errors effectively.
#49
#50	## 6. Using with async/await
#51
#52	All methods of the MemoryClient return promises, allowing for seamless integration with async/await syntax.
#53
#54	## 7. Testing the Client
#55
#56	To test the MemoryClient in a Node.js environment, you can create a simple script to verify the functionality of memory operations.
#57
#58	## Getting Help
#59
#60	If you have any questions or need assistance, please reach out to us:
#61
#62	- Email: founders@mem0.ai
#63	- [Join our discord community](https://mem0.ai/discord)
#64	- GitHub Issues: [Report bugs or request features](https://github.com/mem0ai/mem0/issues)
#65

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public