Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ableneo/samo
Ableneo Chat built on top of a RAG concept.
https://github.com/ableneo/samo
Last synced: 28 days ago
JSON representation
Ableneo Chat built on top of a RAG concept.
- Host: GitHub
- URL: https://github.com/ableneo/samo
- Owner: ableneo
- License: apache-2.0
- Created: 2024-06-11T14:29:31.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-14T12:46:33.000Z (7 months ago)
- Last Synced: 2024-06-14T14:08:07.811Z (7 months ago)
- Language: Python
- Size: 84.1 MB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ableneo-ChatBot: A RAG-based ChatBot
[](https://github.com/ableneo/chat-beckend/blob/master/LICENSE.txt)
[](https://twitter.com/ableneo1)
## Installing
Clone the repository:
```shell
git clone https://github.com/ableneo/samo
```
Install Ableneo ChatBot Samo via:
```shell
pip install .
```
## Launching the ChatBot Samo
For demonstration purposes, we have already prepared all the prerequisites.
The ChatBot is configured to serve as a helpful Biology assistant.
It utilizes information from biological pages on Wikipedia as its knowledge base (data were downloaded from https://commoncrawl.org/).
All responses will be in Slovak, so no additional translation is necessary.
### Running server
To run chatbot Samo server run::
1. Duplicate the `config.example.yaml` file
2. Fill in all placeholders in the config file
3. Run the following command::
```shell
ableneo-chatbot server run --config-file
```
4. Run the server
For more information, run:
```shell
ableneo-chatbot server --help
```
### Initialize Knowledge-Base
If you would like to use your data in your ChatBot system, follow these steps:
1. Remove the `./db` folder
2. Copy your `*.txt` data to the `./data` folder
3. Run the following command:
```shell
ableneo-chatbot knowledge-base init --data-root './data' --data-type '.txt' --config-file './config.yaml' --encoding 'utf-8'
```
For more information, run::
```shell
ableneo-chatbot knowledge-base --help
```
## Endpoints
### `GET /health`
**Request**
```shell
curl -i --request GET 'http://127.0.0.1:6628/health'
```
Response
```
HTTP/1.1 200 OK
Server: Werkzeug/3.0.3 Python/3.11.9
Date: Thu, 06 Jun 2024 15:41:15 GMT
Content-Type: text/html; charset=utf-8
Content-Length: 2
Access-Control-Allow-Origin: *
Connection: close
OK
```
### `GET /version`
**Request**
```shell
curl -i --request GET 'http://127.0.0.1:6628/version'
```
Response
```
HTTP/1.1 200 OK
Server: Werkzeug/3.0.3 Python/3.11.9
Date: Thu, 06 Jun 2024 15:41:48 GMT
Content-Type: text/html; charset=utf-8
Content-Length: 5
Access-Control-Allow-Origin: *
Connection: close
0.1.1
```
### `POST /v1/chatbot/prompt`
**Request**
`GET /version`
```shell
curl -i --request POST 'http://127.0.0.1:6628/v1/chatbot/prompt' \
--header 'Content-Type: application/json' \
--data '{
"chat_id": "abb99ff0-22ad-4992-ac54-997b95ebbc11",
"chat_history": [],
"question": "Koľko mláďat ročne má Myšiarka ušatá?"
}'
```
Response
```
HTTP/1.1 200 OK
Server: Werkzeug/3.0.3 Python/3.11.9
Date: Thu, 06 Jun 2024 16:12:54 GMT
Content-Type: text/plain; charset=utf-8
Access-Control-Allow-Origin: *
Transfer-Encoding: chunked
Connection: close
Myšiarka ušatá (Asio otus) kladie 3 až 7 svetlých vajec ročne.
Zdroj: data\\mysiarka_usata.txt
```
### `POST /v1/chatbot/history`
**Request**
```shell
curl -i --request POST 'http://127.0.0.1:6628/v1/chatbot/history' \
--header 'Content-Type: application/json' \
--data '{"chat_id": "abb99ff0-22ad-4992-ac54-997b95ebbc11"}'
```
Response
```
HTTP/1.1 200 OK
Server: Werkzeug/3.0.3 Python/3.11.9
Date: Thu, 06 Jun 2024 16:14:26 GMT
Content-Type: application/json
Content-Length: 259
Access-Control-Allow-Origin: *
Connection: close
[{"role": "user", "content": "Koľko mláďat ročne má Myšiarka ušatá?"}, {"role": "assistant", "content": "Myšiarka ušatá (Asio otus) kladie 3 až 7 svetlých vajec ročne. data\\mysiarka_usata.txt"}]
```
### `POST /v1/chatbot/feedback`
**Request**
```shell
curl -i --request POST 'http://127.0.0.1:6628/v1/chatbot/feedback' \
--header 'Content-Type: application/json' \
--data '{
"chat_id": "abb99ff0-22ad-4992-ac54-997b95ebbc11",
"chat_history": [],
"question": "Koľko mláďat ročne má Myšiarka ušatá?",
"feedback": "Správne",
"answer": "Myšiarka ušatá (Asio otus) kladie 3 až 7 svetlých vajec ročne. data\\mysiarka_usata.txt",
"reporter": "učiteľ"
}'
```
Response
```shell
HTTP/1.1 200 OK
Server: Werkzeug/3.0.3 Python/3.11.9
Date: Thu, 06 Jun 2024 16:21:00 GMT
Content-Type: application/json
Content-Length: 22
Access-Control-Allow-Origin: *
Connection: close
{"message": "success"}
```
## Development
If you would like to customize the source code, you can install all development dependencies via:
```shell
pip install -e .[dev]
```
## About Ableneo
### Read our blog
- [https://medium.com/ableneo](https://medium.com/ableneo)
- [https://www.ableneo.com/blog](https://www.ableneo.com/blog)
### Our website
[https://www.ableneo.com](https://www.ableneo.com)
### Contact
For more information, contact:
- [[email protected]](mailto:[email protected])
- +421 2 32 144 791