Support Redis for ChatHistory, Feedback Management, Prompt Registry (#1925)

* Support Redis for ChatHistory, Feedback Management, Prompt Registry

Signed-off-by: Yi Yao <[email protected]>

---------

Signed-off-by: Yi Yao <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: joshuayao

comps/chathistory/README.md

@@ -19,7 +19,9 @@ To get detailed, step-by-step instructions on deploying the `chathistory` micros
 
 | Platform | Deployment Method | Database | Link                                                             |
 | -------- | ----------------- | -------- | ---------------------------------------------------------------- |
-| CPU      | Docker            | MongoDB  | [Deployment Guide](./deployment/docker_compose/README.md)        |
 | CPU      | Docker            | ArangoDB | [Deployment Guide](./deployment/docker_compose/README_arango.md) |
-| CPU      | Docker Compose    | MongoDB  | [Deployment Guide](./deployment/docker_compose/README.md)        |
+| CPU      | Docker            | MongoDB  | [Deployment Guide](./deployment/docker_compose/README.md)        |
+| CPU      | Docker            | Redis    | [Deployment Guide](./deployment/docker_compose/README_redis.md)  |
 | CPU      | Docker Compose    | ArangoDB | [Deployment Guide](./deployment/docker_compose/README_arango.md) |
+| CPU      | Docker Compose    | MongoDB  | [Deployment Guide](./deployment/docker_compose/README.md)        |
+| CPU      | Docker Compose    | Redis    | [Deployment Guide](./deployment/docker_compose/README_redis.md)  |

comps/chathistory/deployment/docker_compose/README_redis.md

@@ -0,0 +1,119 @@
+# 📝 Chat History Microservice with Redis
+
+This README provides setup guides and all the necessary information about the Chat History microservice with Redis database.
+
+---
+
+## Setup Environment Variables
+
+```bash
+export http_proxy=${your_http_proxy}
+export https_proxy=${your_http_proxy}
+export OPEA_STORE_NAME="redis"
+export REDIS_URL="${REDIS_URL-redis://localhost:6379}"
+export INDEX_NAME="${INDEX_NAME-opea:index}"
+export DOC_PREFIX="${DOC_PREFIX-doc:}"
+export AUTO_CREATE_INDEX="${AUTO_CREATE_INDEX-true}"
+export ENABLE_MCP=false  # Set to true to enable MCP support
+```
+
+---
+
+## 🚀 Start Microservice with Docker (Option 1)
+
+### Build Docker Image
+
+```bash
+cd ../../../../
+docker build -t opea/chathistory:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f comps/chathistory/src/Dockerfile .
+```
+
+### Run Docker with CLI
+
+- Run Redis image container
+
+  ```bash
+  docker run -d -p 6379:6379 --name=redis-kv-store redis/redis-stack:latest
+  ```
+
+- Run the Chat History microservice
+
+  ```bash
+  docker run -d --name="chathistory-redis-server" -p 6012:6012 -e http_proxy=$http_proxy -e https_proxy=$https_proxy -e no_proxy=$no_proxy -e OPEA_STORE_NAME=redis -e REDIS_URL=${REDIS_URL} -e INDEX_NAME=${INDEX_NAME} -e DOC_PREFIX=${DOC_PREFIX} -e AUTO_CREATE_INDEX=${AUTO_CREATE_INDEX} -e ENABLE_MCP=${ENABLE_MCP} opea/chathistory:latest
+  ```
+
+---
+
+## 🚀 Start Microservice with Docker Compose (Option 2)
+
+```bash
+docker compose -f ../deployment/docker_compose/compose.yaml up -d chathistory-redis
+```
+
+---
+
+## ✅ Invoke Microservice
+
+The Chat History microservice exposes the following API endpoints:
+
+- Create new chat conversation
+
+  ```bash
+  curl -X 'POST' \
+    http://${host_ip}:6012/v1/chathistory/create \
+    -H 'accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+    "data": {
+      "messages": "test Messages", "user": "test"
+    }
+  }'
+  ```
+
+- Get all the Conversations for a user
+
+  ```bash
+  curl -X 'POST' \
+    http://${host_ip}:6012/v1/chathistory/get \
+    -H 'accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+    "user": "test"}'
+  ```
+
+- Get a specific conversation by id.
+
+  ```bash
+  curl -X 'POST' \
+    http://${host_ip}:6012/v1/chathistory/get \
+    -H 'accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+    "user": "test", "id":"YOU_COLLECTION_NAME/YOU_DOC_KEY"}'
+  ```
+
+- Update the conversation by id.
+
+  ```bash
+  curl -X 'POST' \
+    http://${host_ip}:6012/v1/chathistory/create \
+    -H 'accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+    "data": {
+      "messages": "test Messages Update", "user": "test"
+    },
+    "id":"YOU_COLLECTION_NAME/YOU_DOC_KEY"
+  }'
+  ```
+
+- Delete a stored conversation.
+
+  ```bash
+  curl -X 'POST' \
+    http://${host_ip}:6012/v1/chathistory/delete \
+    -H 'accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+    "user": "test", "id":"YOU_COLLECTION_NAME/YOU_DOC_KEY"}'
+  ```

comps/chathistory/deployment/docker_compose/compose.yaml

@@ -77,6 +77,43 @@ services:
       ENABLE_MCP: ${ENABLE_MCP:-false}
     restart: unless-stopped
 
+  redis-kv-store:
+    image: redis/redis-stack:7.2.0-v9
+    container_name: redis-kv-store
+    ports:
+      - "${REDIS_PORT3:-6379}:6379"
+      - "${REDIS_PORT4:-8001}:8001"
+    environment:
+      - no_proxy=${no_proxy}
+      - http_proxy=${http_proxy}
+      - https_proxy=${https_proxy}
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      timeout: 10s
+      retries: 3
+      start_period: 10s
+
+  chathistory-redis:
+    image: ${REGISTRY:-opea}/chathistory:${TAG:-latest}
+    container_name: chathistory-redis-server
+    depends_on:
+      redis-kv-store:
+        condition: service_healthy
+    ports:
+      - "${CHATHISTORY_PORT:-6012}:6012"
+    ipc: host
+    environment:
+      http_proxy: ${http_proxy}
+      no_proxy: ${no_proxy}
+      https_proxy: ${https_proxy}
+      OPEA_STORE_NAME: "redis"
+      REDIS_URL: ${REDIS_URL-redis://localhost:6379}
+      INDEX_NAME: ${INDEX_NAME-opea:index}
+      DOC_PREFIX: ${DOC_PREFIX-doc:}
+      AUTO_CREATE_INDEX: ${AUTO_CREATE_INDEX-true}
+      ENABLE_MCP: ${ENABLE_MCP:-false}
+    restart: unless-stopped
+
 networks:
   default:
     driver: bridge

comps/cores/storages/arangodb.py

@@ -370,7 +370,6 @@ async def asearch_by_keyword(self, keyword: str, max_results: int = 5, **kwargs)
 
             # Check if a collection with the same name exists (which would conflict)
             if await self.db.has_collection(view_name):
-                logger.error(f"A collection named '{view_name}' exists, cannot create view with same name.")
                 raise Exception(f"A collection named '{view_name}' exists, cannot create view with same name.")
 
             # Check if view already exists and delete it to recreate with fresh settings