Git Product home page Git Product logo

research_bot's Introduction

RESEARCH BOT

A simple flask app that lets users chat with their data.

To run the app, users must set OPENAI_API_KEY environment variable, which can be obtained from OpenAI. Please contact Arpan Seth ([email protected]) for further instructions.

The app has been tested on M1 Macbook Air running Python version 3.11.9.

Steps to run the application:

1. Create virtual environment and install python packages:

pip install -r requirements.txt

2. Setup you OpenAI API Ket environment variable:

If you haven't already, please get an API key from OpenAI and set it as you environment variable. Please contact Arpan Seth([email protected]) for the keys related to custom fine-tuned models. You can set the API KEY using the command:

export OPENAI_API_KEY='your-key-here'

3. Load and index pdf documents for RAG:

The application supports context retrieval from ingested pdf files. First, copy all pdf files you need indexed into the folder called "pdfs". Then run the following script to create the embeddings:

python index.py

You can run the above script anytime you add new pdf files to the "pdfs" folder and it will automatically process new files.

4. If needed, modify the system message:

The system message lets you provide additional information to the chatbot that is included in every conversation. Users can modify the system message by editing the "system_message.txt" file.

5. Run the flask app:

Run the flask application with the following command:

python app.py

The application should be available through your browser at http://127.0.0.1:5000

Note: You can try using a different model by changing the MODEL_NAME parameter in app.py.

research_bot's People

Contributors

arpanseth avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.