Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 2.63 KB

README.md

File metadata and controls

61 lines (36 loc) · 2.63 KB
Raw

DocumentGPT

DocumentGPT is a web application that allows you to chat over your research document using OpenAI's Chat API and perform semantic search using Vector Databases. This tool provides a seamless interface for interacting with your research document, exploring search results, and engaging in a conversation with an AI chatbot.

Features

  • Upload your PDF document and view its contents within the web app.
  • Chat with an AI chatbot powered by OpenAI's chat API, using the content of your research document.
  • Get semantic search answers from your document using vector databases.
  • Get web results over topics for more context and information rich answers.
  • Perform Google/YouTube search within the app and get auto identified search suggestions.
  • Verify sources for all generated results.

Demo Preview

DocumentGPT.-.Made.with.Clipchamp.mp4

How to Use

  1. Clone the repository: git clone https://github.com/your-username/DocumentGPT.git
  2. Install the required dependencies: pip install -r requirements.txt
  3. Set up your OpenAI API key and provide it in the web app.
  4. Run the application: streamlit run main.py
  5. Access the web app in your browser at http://localhost:8501.

Presently Available Tools

  • ✅Vector Database Retreival Tool: Finds answers from vector database.

  • ✅Arxiv Tool: Searches scientific articles on arxiv.org for specific topics.

  • ✅Search Tool: Searches the internet for general web articles.

  • ✅Summarization Tool: Summarizes entire document when requested.

Further Improvements

Here are some areas for further improvement in DocumentGPT:

  • AI Alignment: Improve the model behaviour by various techniques in prompt engineering.
  • Tools: Addition of more helpul tools for better model responses.

Streamlit Cloud

You can try out the chatbot by visiting the deployed app on Streamlit Cloud: Deployed App

Note: Unfortunately PDF Display works fine locally, but in the deployed app only works on certain browsers like Safari, Firefox :(

Contributing

Contributions to DocumentGPT are welcome! If you have any feedback, suggestions, or bug reports, please create an issue in the GitHub repository. You can also contribute to the project by submitting pull requests with your enhancements.

License

This project is licensed under the MIT License.

Acknowledgements

DocumentGPT is built using Streamlit, OpenAI Chat API, Langchain and various open-source libraries. I would like to acknowledge the contributions of the developers and contributors of these libraries.