docGPT

English | 中文版

• Table of Contents
  • What's new in version3?
  • Introduction
  • What's LangChain?
  • How to Use docGPT?
  • How to Develop a docGPT with Streamlit?
  • Advanced - How to build a better model in langchain

• Main Development Software and Packages:
  • Python 3.10.11
  • Langchain 0.0.218
  • Streamlit 1.22.0
  • more

If you like this project, please give it a ⭐Star to support the developers~

What's new in version3?

• We introduced the usage of gpt4free, allowing users to use the application for free without entering any API key or making payments.

• If you want to use the gpt4free free model, you need to select a Provider (default is g4f.provider.ChatgptAi). For more information about gpt4free, please refer to the source project.

• Version2

  • Utilizes the openai model
  • To use this tool, you need to have at least the openai_api_key. You can obtain the key by visiting the link
  • If you have a serpapi_key, the AI model can answer questions and implement Google search functionality

• Version3

  • Retains all the features of Version2
  • Adds the gpt4free model, enabling users to use it completely for free
  • Users can choose between gpt4free or openai as the model, with differences as follows:
    • gpt4free: Achieves free access to openai through reverse engineering, although it's less stable
    • openai: Stable access to the openai model by providing an API key

---

Introduction

• Project Purpose:

  • Build a powerful "LLM" model using langchain and streamlit, enabling your LLM model to do what ChatGPT can't:
    • Connect with external data by using PDF documents as an example, allowing the LLM model to understand the uploaded files through RetrievalQA techniques.
    • Integrate LLM with other tools to achieve internet connectivity. For instance, using Serp API as an example, leverage the Langchain framework to enable querying the model for current issues (i.e., Google search engine).
    • Integrate LLM with the LLM Math model, enabling accurate mathematical calculations.

• This project consists of three main components:

  • DataConnection: Allows LLM to communicate with external data, i.e., read PDF files and perform text segmentation for large PDFs to avoid exceeding OPENAI's 4000-token limit.
  • docGPT: This component enables the model to understand the content of PDFs. It includes embedding PDF text and building a retrievalQA model using Langchain. For more details, please refer to the documentation.
  • agent: Responsible for managing the tools used by the model and automatically determining which tool to use based on the user's question. The tools include:
    • SerpAI: Used for "current questions" by performing a Google search.
    • llm_math_chain: Used for "mathematical calculations" by performing mathematical computations.
    • docGPT: Used for answering questions about the content of PDF documents. (This tool is built using retrievalQA)

• docGPT is developed based on Langchain and Streamlit.

---

What's LangChain?

• LangChain is a framework for developing applications powered by language models. It supports the following applications:

  1. Connecting LLM models with external data sources.
  2. Enabling interactions with LLM models.

• For an introduction to LangChain, it is recommended to refer to the official documentation or the GitHub repository.

Questions that ChatGPT cannot answer can be handled by Langchain!

Here, the author briefly introduces the differences between Langchain and ChatGPT. You will be amazed by this open-source project called Langchain through the following example!

Imagine a scenario where ChatGPT cannot answer mathematical questions or questions about events beyond 2020 (e.g., "Who will be the president in 2023?").

• For mathematical questions: In addition to the OpenAI model, there is a specialized tool called math-llm that handles mathematical questions.
• For current questions: We can use Google search.

Therefore, to design a powerful and versatile AI model, we need to include three tools: "chatgpt", "math-llm", and "Google search".

If the user's question involves mathematical calculations, we use the math-llm tool to handle and answer it.

In the non-AI era, we would use if...else... to decide which tool to use based on the user's question. However, Langchain provides a more flexible and powerful way to handle this. In the AI era, we want users to directly ask their questions without having to pre-select the question type! In Langchain, there is a concept called "agent" that allows us to:

• Provide tools for the agent to manage, such as tools = ['chatgpt', 'math-llm', 'google-search'].
• Include chains designed using Langchain, such as using the retrievalQA chain to create a question-answering model based on document content, and append this chain to the tools managed by the agent.
• Allow the agent to determine which tool to use based on the user's question (fully automated and AI-driven).

With Langchain, we can create our own ChatGPT model that can be general-purpose or tailored for specific industries and commercial use!

---

How to Use docGPT?

• Visit the application.

• Enter your API keys: (This step is optional in version V3, you can choose to skip it and use the gpt4free free model)

  • OpenAI API Key: Make sure you still have usage left
  • SERPAPI API Key: Optional. If you want to ask questions about content not appearing in the PDF document, you need this key.

• Upload a PDF file from your local machine.

• Start asking questions!

---

How to Develop a docGPT with Streamlit?

A step-by-step tutorial to quickly build your own chatGPT!

First, clone the repository using git clone https://github.com/Lin-jun-xiang/docGPT-streamlit.git.

There are two methods:

• Local development:

  • pip install -r requirements.txt: Download the required packages for development.
  • streamlit run ./app.py: Start the service in the project's root directory.
  • Start exploring!

• Use Streamlit Community Cloud for free deployment, management, and sharing of applications:

  • Put your application in a public GitHub repository (make sure it has a requirements.txt!).
  • Log in to share.streamlit.io.
  • Click "Deploy an App" and paste your GitHub URL.
  • Complete the deployment of your application.

---

Advanced - How to build a better model in langchain

Using Langchain to build docGPT, you can pay attention to the following details that can make your model more powerful:

1. Language Model

   Choosing the right LLM Model can save you time and effort. For example, you can choose OpenAI's gpt-3.5-turbo (default is text-davinci-003):

   # ./docGPT/docGPT.py
   llm = ChatOpenAI(
   temperature=0.2,
   max_tokens=2000,
   model_name='gpt-3.5-turbo'
   )

   Please note that there is no best or worst model. You need to try multiple models to find the one that suits your use case the best. For more OpenAI models, please refer to the documentation.

   (Some models support up to 16,000 tokens!)

2. PDF Loader

   There are various PDF text loaders available in Python, each with its own advantages and disadvantages. Here are three loaders the authors have used:

   (official Langchain documentation)

   • PyPDF: Simple and easy to use.
   • PyMuPDF: Reads the document very quickly and provides additional metadata such as page numbers and document dates.
   • PDFPlumber: Can extract text within tables. Similar to PyMuPDF, it provides metadata but takes longer to parse.

   If your document contains multiple tables and important information is within those tables, it is recommended to try PDFPlumber, which may give you unexpected results!

   Please do not overlook this detail, as without correctly parsing the text from the document, even the most powerful LLM model would be useless!

3. Tracking Token Usage

   This doesn't make the model more powerful, but it allows you to track the token usage and OpenAI API key consumption during the QA Chain process.

   When using chain.run, you can try using the method provided by Langchain to track token usage here:

   from langchain.callbacks import get_openai_callback
   
   with get_openai_callback() as callback:
       response = self.qa_chain.run(query)
   
   print(callback)
   
   # Result of print
   """
   chain...
   ...
   > Finished chain.
   Total Tokens: 1506
   Prompt Tokens: 1350
   Completion Tokens: 156
   Total Cost (USD): $0.03012

Back to top