Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nrl-ai/pautobot
🔥 Your private task assistant with GPT 🔥 - Ask questions about your documents.
https://github.com/nrl-ai/pautobot
autogpt automation chatbot chatgpt docsearch gpt gpt4 private-gpt privategpt rpa
Last synced: about 1 hour ago
JSON representation
🔥 Your private task assistant with GPT 🔥 - Ask questions about your documents.
- Host: GitHub
- URL: https://github.com/nrl-ai/pautobot
- Owner: nrl-ai
- Created: 2023-05-28T07:01:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-07T14:38:19.000Z (about 1 month ago)
- Last Synced: 2024-11-05T00:49:45.250Z (8 days ago)
- Topics: autogpt, automation, chatbot, chatgpt, docsearch, gpt, gpt4, private-gpt, privategpt, rpa
- Language: Python
- Homepage:
- Size: 5.15 MB
- Stars: 156
- Watchers: 7
- Forks: 48
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🔥 PⒶutoBot 🔥
Private AutoGPT Robot - Your private task assistant with GPT!
- 🔥 **Chat** to your offline **LLMs on CPU Only**. **100% private**, no data leaves your execution environment at any point.
- 🔥 **Ask questions** to your documents without an internet connection. Engine developed based on [PrivateGPT](https://github.com/imartinez/privateGPT).
- 🔥 **Easy coding structure** with **Next.js** and **Python**. Easy to understand and modify.
- 🔥 **Built with** [LangChain](https://github.com/hwchase17/langchain), [GPT4All](https://github.com/nomic-ai/gpt4all), [Chroma](https://www.trychroma.com/), [SentenceTransformers](https://www.sbert.net/), [PrivateGPT](https://github.com/imartinez/privateGPT).
**The supported extensions are:**
- `.csv`: CSV,
- `.docx`: Word Document,
- `.doc`: Word Document,
- `.enex`: EverNote,
- `.eml`: Email,
- `.epub`: EPub,
- `.html`: HTML File,
- `.md`: Markdown,
- `.msg`: Outlook Message,
- `.odt`: Open Document Text,
- `.pdf`: Portable Document Format (PDF),
- `.pptx`: PowerPoint Document,
- `.ppt`: PowerPoint Document,
- `.txt`: Text file (UTF-8),
## I. Installation and Usage
### 1. Installation
- Python 3.8 or higher.
- Install **PAutoBot**:
```shell
pip install pautobot
```
### 2. Usage
- Run the app:
```shell
python -m pautobot.app
```
or just:
```shell
pautobot
```
- Go to to see the user interface. You can choose one of the two modes:
- **Chat Only**
- **Documents Q&A**
- Upload some documents to the app (see the supported extensions above). You can try [docs/python3.11.3_lite.zip](docs/python3.11.3_lite.zip) for a quick start. This zip file contains 45 files from the [Python 3.11.3 documentation](https://docs.python.org/3/download.html).
- Force ingesting documents with **Ingest Data** button.
You can also run PAutoBot publicly to your network or change the port with parameters. Example:
```shell
pautobot --host 0.0.0.0 --port 8080
```
## II. Development
### 1. Clone the source code
```shell
git clone https://github.com/nrl-ai/pautobot
cd pautobot
```
### 2. Run your backend
- Python 3.8 or higher.
- To install Pautobot from source, from `pautobot` source code directory, run:
```shell
pip install -e .
```
- Run the app:
```shell
python -m pautobot.app
```
- Go to to see the user interface.
### 2. Run your frontend
- Install the dependencies:
```shell
cd frontend
npm install
```
- Run the app:
```shell
npm run dev
```
- Go to to see the user interface. Use this address to develop the frontend.