Commit
·
5717fb0
1
Parent(s):
257e702
Readme Updates
Browse files
README.md
CHANGED
|
@@ -10,7 +10,9 @@ license: mit
|
|
| 10 |
---
|
| 11 |
[](https://github.com/nikhilkomakula/llm-rag-op-chatbot/actions/workflows/main.yml)
|
| 12 |
|
| 13 |
-
[Try OpenPages IntelliBot Here!](https://huggingface.co/spaces/nikhilkomakula/llm-rag-op-chatbot)
|
|
|
|
|
|
|
| 14 |
|
| 15 |
# OpenPages IntelliBot
|
| 16 |
|
|
@@ -83,8 +85,28 @@ python install -r requirements.txt
|
|
| 83 |
|
| 84 |
**Step 4:** Run the application
|
| 85 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 86 |
```python
|
| 87 |
-
python
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 88 |
```
|
| 89 |
|
| 90 |
## Build and Run Container Locally:
|
|
@@ -113,7 +135,7 @@ docker ps -a
|
|
| 113 |
docker logs -f llm-rag-op-chatbot
|
| 114 |
```
|
| 115 |
|
| 116 |
-
## REST API:
|
| 117 |
|
| 118 |
**Note:** Navigate to the chat interface UI in the browser and locate `Use via API` and click on it. A fly over opens on the right hand side. Capture the URL under the title named `API documentation`.
|
| 119 |
|
|
@@ -128,6 +150,26 @@ docker logs -f llm-rag-op-chatbot
|
|
| 128 |
* **Orchestration Framework :** LangChain
|
| 129 |
* **Embedding Model :** BAAI/bge-large-en-v1.5
|
| 130 |
* **Large Language Model :** huggingfaceh4/zephyr-7b-beta
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 131 |
|
| 132 |
## Contact Me:
|
| 133 |
|
|
|
|
| 10 |
---
|
| 11 |
[](https://github.com/nikhilkomakula/llm-rag-op-chatbot/actions/workflows/main.yml)
|
| 12 |
|
| 13 |
+
[Try 'Gradio' OpenPages IntelliBot Here!](https://huggingface.co/spaces/nikhilkomakula/llm-rag-op-chatbot)
|
| 14 |
+
|
| 15 |
+
[Try 'Streamlit' OpenPages IntelliBot Here!](https://nk-openpages-intellibot.streamlit.app)
|
| 16 |
|
| 17 |
# OpenPages IntelliBot
|
| 18 |
|
|
|
|
| 85 |
|
| 86 |
**Step 4:** Run the application
|
| 87 |
|
| 88 |
+
* Gradio
|
| 89 |
+
|
| 90 |
+
```python
|
| 91 |
+
python app.py -gradio
|
| 92 |
+
```
|
| 93 |
+
|
| 94 |
+
OR
|
| 95 |
+
|
| 96 |
```python
|
| 97 |
+
python gradio_app.py
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
* Streamlit
|
| 101 |
+
|
| 102 |
+
```python
|
| 103 |
+
python app.py -streamlit
|
| 104 |
+
```
|
| 105 |
+
|
| 106 |
+
OR
|
| 107 |
+
|
| 108 |
+
```python
|
| 109 |
+
streamlit run streamlit_app.py
|
| 110 |
```
|
| 111 |
|
| 112 |
## Build and Run Container Locally:
|
|
|
|
| 135 |
docker logs -f llm-rag-op-chatbot
|
| 136 |
```
|
| 137 |
|
| 138 |
+
## REST API (Gradio):
|
| 139 |
|
| 140 |
**Note:** Navigate to the chat interface UI in the browser and locate `Use via API` and click on it. A fly over opens on the right hand side. Capture the URL under the title named `API documentation`.
|
| 141 |
|
|
|
|
| 150 |
* **Orchestration Framework :** LangChain
|
| 151 |
* **Embedding Model :** BAAI/bge-large-en-v1.5
|
| 152 |
* **Large Language Model :** huggingfaceh4/zephyr-7b-beta
|
| 153 |
+
* **UI Framework** : Streamlit & Gradio
|
| 154 |
+
|
| 155 |
+
## Streamlit.io Deployment:
|
| 156 |
+
|
| 157 |
+
If you are encountering issues with `sqlite` version, then run the following steps:
|
| 158 |
+
|
| 159 |
+
* Add the following dependency to `requirements.txt`:
|
| 160 |
+
|
| 161 |
+
`pysqlite3-binary==0.5.2.post3`
|
| 162 |
+
|
| 163 |
+
* Add the following block of code to `streamlit_app.py` at the beginning of the file:
|
| 164 |
+
|
| 165 |
+
```
|
| 166 |
+
# code to fix the issue with sqllite version on streamlit.io
|
| 167 |
+
__import__('pysqlite3')
|
| 168 |
+
import sys
|
| 169 |
+
sys.modules['sqlite3'] = sys.modules.pop('pysqlite3')
|
| 170 |
+
```
|
| 171 |
+
|
| 172 |
+
**Note:** If running locally for Streamlit UI interace and if you hit any errors with `pysqlite3`, try removing whatever that is mentioned above.
|
| 173 |
|
| 174 |
## Contact Me:
|
| 175 |
|