Table of Contents
FileChat gives life to your uploaded documents, aiming to provide you seemless experience of chatting with your own documentation allowing you to
- Gain more information in less amount of time
- make a tedious job like document study into a game of QnA
- Not worry about the length of the document just start playing with it 😄
It is completely based on LLMs and Langchain for its AI implementation to make your lives simpler, now lets look into what all was used to make it stand tall
The webservice was built with mainly the following Frameworks/Libraries at the core of it keeping it alive
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
Lets first get on with getting our OpenAI API key for the OpenAI LLM model being used at the core end of the QAchain.
- Get a free API Key at https://platform.openai.com/api-keys
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git
- Install the requirements
pip install -r requirements.txt
- Enter your API in .env file in the root directory
OPENAI_KEY = "your openAI key"
- Run the project using the following command
py server.py
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Follow the Getting Started guide
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.