From 6369d56732f53e64d9185f19b0698b8be2985f86 Mon Sep 17 00:00:00 2001 From: Jununn Date: Mon, 8 Dec 2025 18:19:07 +0800 Subject: [PATCH] docs: Add memU-ui Repository Link to README Add the memU-ui repo link to the README to make it easier to navigate between the related projects. --- README.md | 58 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 30 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index c8d7d2b..db54a1e 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,9 @@ memU-server is the backend management service for MemU, responsible for providing API endpoints, data storage, and management capabilities, as well as deep integration with the core memU framework. It powers the frontend memU-ui with reliable data support, ensuring efficient reading, writing, and maintenance of Agent memories. memU-server can be deployed locally or in private environments and supports quick startup and configuration via Docker, enabling developers to manage the AI memory system in a secure environment. - Core Algorithm 👉 memU: https://github.com/NevaMind-AI/memU +- Local visual interface 👉 memU-ui: https://github.com/NevaMind-AI/memU-ui - One call = response + memory 👉 memU Response API: https://memu.pro/docs#responseapi -- Try it instantly 👉 https://app.memu.so/quick-start +- Try MemU cloud version instantly 👉 https://app.memu.so/quick-start --- @@ -35,11 +36,11 @@ Star memU-server to get notified about new releases and join our growing communi ``` The server runs on `http://127.0.0.1:8000`. -### Run with Docker -1. Export your OpenAI API key so Docker can read it: - ```bash - export OPENAI_API_KEY=your_api_key_here - ``` +### Run with Docker +1. Export your OpenAI API key so Docker can read it: + ```bash + export OPENAI_API_KEY=your_api_key_here + ``` 2. Pull the latest image: ```bash docker pull nevamindai/memu-server:latest @@ -49,28 +50,28 @@ Star memU-server to get notified about new releases and join our growing communi docker run --rm -p 8000:8000 \ -e OPENAI_API_KEY=$OPENAI_API_KEY \ nevamindai/memu-server:latest - ``` - Access the API at `http://127.0.0.1:8000`. - -### API Endpoints -- `POST /memorize`: persist a conversation-style payload for later retrieval. Example body shape: - ```json - { - "content": [ - {"role": "user", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"}, - {"role": "assistant", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"} - ] - } - ``` -- `POST /retrieve`: query stored memories with a text prompt: - ```json - {"query": "your question about the conversation"} - ``` -- To smoke-test locally, set `MEMU_API_URL` (defaults to `http://127.0.0.1:12345`), POST a conversation to `/memorize`, then call `/retrieve` with a text query. - ---- - -## 🔑 Key Features + ``` + Access the API at `http://127.0.0.1:8000`. + +### API Endpoints +- `POST /memorize`: persist a conversation-style payload for later retrieval. Example body shape: + ```json + { + "content": [ + {"role": "user", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"}, + {"role": "assistant", "content": {"text": "..."}, "created_at": "YYYY-MM-DD HH:MM:SS"} + ] + } + ``` +- `POST /retrieve`: query stored memories with a text prompt: + ```json + {"query": "your question about the conversation"} + ``` +- To smoke-test locally, set `MEMU_API_URL` (defaults to `http://127.0.0.1:12345`), POST a conversation to `/memorize`, then call `/retrieve` with a text query. + +--- + +## 🔑 Key Features ### Quick Deployment - Docker image provided @@ -130,3 +131,4 @@ For more information please contact info@nevamind.ai - GitHub Issues: Report bugs, request features, and track development. [Submit an issue](https://github.com/NevaMind-AI/memU-server/issues) - Discord: Get real-time support, chat with the community, and stay updated. [Join us](https://discord.com/invite/hQZntfGsbJ) - X (Twitter): Follow for updates, AI insights, and key announcements. [Follow us](https://x.com/memU_ai) +