Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mukulpatnaik/researchgpt
A LLM based research assistant that allows you to have a conversation with a research paper
https://github.com/mukulpatnaik/researchgpt
Last synced: 3 months ago
JSON representation
A LLM based research assistant that allows you to have a conversation with a research paper
- Host: GitHub
- URL: https://github.com/mukulpatnaik/researchgpt
- Owner: mukulpatnaik
- License: mit
- Archived: true
- Created: 2023-02-01T05:46:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T01:54:29.000Z (about 1 year ago)
- Last Synced: 2024-09-21T17:12:25.594Z (3 months ago)
- Language: Python
- Homepage: https://www.dara.chat
- Size: 579 KB
- Stars: 3,547
- Watchers: 41
- Forks: 340
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-AIGC-tools - [GitHub 代码
- awesome - mukulpatnaik/researchgpt - A LLM based research assistant that allows you to have a conversation with a research paper (Python)
- awesome-open-gpt - researchgpt
- awesome-ChatGPT-repositories - researchgpt - An open-source LLM based research assistant that allows you to have a conversation with a research paper (Chatbots)
- awesome-chatgpt - ResearchGPT - source LLM based research assistant that allows you to have a conversation with a research paper (Documentations, Tutorials & Other Resources / Emacs)
- awesome-chatgpt-api - mukulpatnaik/ResearchGPT
- awesome-chatgpt-zh - ResearchGPT: 科研工作者的福音
- Awesome-ChatGPT - ResearchGPT - source LLM based research assistant that allows you to have a conversation with a research paper (Documentations, Tutorials & Other Resources / Prompts)
README
## **This repository is no longer actively maintained. A more advanced version of this project is available at [chat.portal.so](https://chat.portal.so) for free and will be open sourced soon.**
# ResearchGPT
This is a simple fastapi app that provides a clean interface to enable a conversation with any pdf. You can enter a link to a pdf hosted online or upload your own pdf. The app will then extract the text from the pdf, create embeddings from the text and use them with the openai api to generate a response to a question you ask. It will also return a source for the part of the text it used to generate the response and the page number.
Try the demo at: https://www.dara.chat
## Example
(this video shows some features available on the [live demo](https://www.dara.chat) only )
https://user-images.githubusercontent.com/36257370/230793133-ecb579d3-47d9-4200-916a-9c5978a40b09.mp4
## Installation
```bash
git clone https://github.com/mukulpatnaik/researchgpt.git
cd researchgpt
pip install -r requirements.txt
```
You also need redis for storing the embeddings locally on your machine. You can find installation instructions here: https://redis.io/docs/getting-started/installation/. To start the db, run the following command in your terminal.
On MacOS:
```bash
redis-server
```
On Windows:
```bash
sudo service redis-server start
```
## Usage
You need to have an openai api key and set it as the environment variable 'OPENAI_API_KEY'.
You can get the OpenAI API key here - https://platform.openai.com/account/api-keys
To set your environment variable open your .bashrc or .zshrc and add the line `export OPENAI_API_KEY="your-key`, make sure to put your actual key instead of "your-key".
```bash
uvicorn main:app --reload
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)
If you would like to collaborate on this project, please reach out to me at [email protected] or find me on [twitter](https://twitter.com/mukul0x)