djibe / researchgpt

A LLM based research assistant that allows you to have a conversation with a research paper

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

Screen.Recording.2023-04-04.at.7.46.09.AM.mov

Installation

sudo apt install python3-pip uvicorn
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:

redis-server

On Windows:

Set WSL (tutorial).

All commands must be set in WSL bash (redis, git, uvicorn). The webapp can then be used from Windows favorite web browser.

sudo service redis-server start

Usage

You need to have an OpenAI API key and set it as the environment variable 'OPENAI_API_KEY'.

• Create an OpenAI API key: https://platform.openai.com/account/api-keys
• Copy the key
• Declare permanent environment variable (Ubuntu WSL): nano ~/.bashrc
• Scroll down and add to the end of file: `export OPENAI_API_KEY="YOUR_API_KEY"
• Use following keys to exit nano: CTRL + O > ENTER > CTRL + X
• Reload environment variables: source ~/.bashrc

Now launch the webapp:

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

If you would like to collaborate on this project, please reach out to me at [e-mail] or find me on twitter