Spaces:
Sleeping
Sleeping
Added readme file
Browse files
README.md
CHANGED
|
@@ -1,12 +1,43 @@
|
|
| 1 |
---
|
| 2 |
-
title: Chat
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom: blue
|
| 5 |
-
colorTo: green
|
| 6 |
-
sdk: streamlit
|
| 7 |
-
sdk_version: 1.19.0
|
| 8 |
-
app_file: app.py
|
| 9 |
-
pinned: false
|
| 10 |
---
|
|
|
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Chat with Docs
|
| 3 |
+
emoji: 📚
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
+
# Chat-with-Docs
|
| 6 |
|
| 7 |
+
|
| 8 |
+
|
| 9 |
+
Chat with your Docs and gain better insights. Powered by `LlamaIndex` and `Streamlit` is used for UI.
|
| 10 |
+
Handles `CSV/PDFs/Txt/Doc`. CSV file is catered via [PandasAI](https://llamahub.ai/l/pandas_ai) loader and rest of the docs are handled via
|
| 11 |
+
`GPTVectorStoreIndex`.
|
| 12 |
+
|
| 13 |
+
Clone the repo or copy the `.py ` file in your local machine.
|
| 14 |
+
|
| 15 |
+
## Install required Dependencies
|
| 16 |
+
```
|
| 17 |
+
pip install -r requirements.txt
|
| 18 |
+
```
|
| 19 |
+
|
| 20 |
+
## Create a folder in the root dir and name it as `documents`
|
| 21 |
+
|
| 22 |
+
## Run the application
|
| 23 |
+
`streamlit run chat_with_docs.py`
|
| 24 |
+
|
| 25 |
+
## How to Contribute
|
| 26 |
+
Feel free to open any Issue or PR request. This small application can help anyone to interact with their docs more smartly in just 2-3 steps.
|
| 27 |
+
|
| 28 |
+
## Roadmap
|
| 29 |
+
- [ ] Add support for choosing in between GPT-3/GPT-3.5/GPT-4 or HuggingFace model for creating vectors and generating rich responses.
|
| 30 |
+
- [x] Blog explaining the entire application in detail.
|
| 31 |
+
- [ ] Add Docker support.
|
| 32 |
+
- [ ] Deploy the project on Streamlit or DataButton platform.
|
| 33 |
+
- [ ] Add support to handle multiple files at once.
|
| 34 |
+
|
| 35 |
+
## Snapshots
|
| 36 |
+
- Upload a CSV file. Get better insights by just asking question, Render graphs based on the Data
|
| 37 |
+
|
| 38 |
+
|
| 39 |
+
|
| 40 |
+
|
| 41 |
+
- In Doc section, Upload PDFs/Txt/Docs to chat with your docs directly. No need to press `CTRL+F` to search for anything in the Docs
|
| 42 |
+
|
| 43 |
+
|