Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions comps/chathistory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,18 @@ It can be integrated into application by making HTTP requests to the provided AP

![Flow Chart](./assets/img/chathistory_flow.png)

---

## 🛠️ Features

- **Store Chat Conversations**: Save chat messages user information, and metadata associated with each conversation.
- **Retrieve Chat Histories**: Fetch chat histories for a specific user or retrieve a particular conversation by its unique identifier.
- **Update Chat Conversations**: Modify existing chat conversations by adding new messages or updating existing ones.
- **Delete Chat Conversations**: Remove chat conversations record from database.

---

## ⚙️ Implementation

The Chat History microservice able to support various database backends for storing the chat conversations.
## ⚙️ Deployment Options

### Chat History with MongoDB
To get detailed, step-by-step instructions on deploying the `chathistory` microservice, you should consult the deployment guide. This guide will walk you through all the necessary steps, from building the Docker images to configuring your environment and running the service.

For more detail, please refer to this [README](src/README.md)
| Platform | Deployment Method | Database | Link |
| -------- | ----------------- | -------- | --------------------------------------------------------- |
| CPU | Docker | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) |
| CPU | Docker Compose | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) |
15 changes: 6 additions & 9 deletions comps/feedback_management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,18 @@

The Feedback Management microservice facilitates the storage and retrieval of users'feedback data by establishing a connection with the databases. This microservice is designed to seamlessly integrate with OPEA applications, enabling data persistence and efficient management of feedback data.

---

## 🛠️ Features

- **Store Feedback**: Save feedback data from user into database.
- **Retrieve Feedback**: Fetch feedback data from database based on user or id.
- **Update Feedback**: Update feedback data info in the database based on id.
- **Delete Feedback**: Remove feedback record from database.

---

## ⚙️ Implementation

The Feedback Management microservice able to support various database backends for storing the feedback data.
## ⚙️ Deployment Options

### Feedback Management with MongoDB
To get detailed, step-by-step instructions on deploying the `feedback_management` microservice, you should consult the deployment guide. This guide will walk you through all the necessary steps, from building the Docker images to configuring your environment and running the service.

For more detail, please refer to this [README](./src/README.md)
| Platform | Deployment Method | Database | Link |
| -------- | ----------------- | -------- | --------------------------------------------------------- |
| CPU | Docker | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) |
| CPU | Docker Compose | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) |
15 changes: 6 additions & 9 deletions comps/prompt_registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,17 @@

The Prompt Registry microservice facilitates the storage and retrieval of users' preferred prompts by establishing a connection with the databases. This microservice is designed to seamlessly integrate with OPEA applications, enabling data persistence and efficient management of user's preferred prompts.

---

## 🛠️ Features

- **Store Prompt**: Save user's preferred prompt into database.
- **Retrieve Prompt**: Fetch prompt from database based on user, id or even a keyword search.
- **Delete Prompt**: Remove prompt from database.

---

## ⚙️ Implementation

The Prompt Registry microservice able to support various database backends for storing the prompts.
## ⚙️ Deployment Options

### Prompt Registry with MongoDB
To get detailed, step-by-step instructions on deploying the `prompt_registry` microservice, you should consult the deployment guide. This guide will walk you through all the necessary steps, from building the Docker images to configuring your environment and running the service.

For more detail, please refer to this [README](./src/README.md)
| Platform | Deployment Method | Database | Link |
| -------- | ----------------- | -------- | --------------------------------------------------------- |
| CPU | Docker | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) |
| CPU | Docker Compose | MongoDB | [Deployment Guide](./deployment/docker_compose/README.md) |