Skip to content

Commit bdd7ef7

Browse files
Lin-jun-xiangLin-jun-xiang
committed
Update README
1 parent 53fec6a commit bdd7ef7

File tree

3 files changed

+135
-81
lines changed

3 files changed

+135
-81
lines changed

‎.github/workflows/trans.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Translate Readme
2+
3+
on:
4+
push:
5+
branches: ['**']
6+
7+
jobs:
8+
translate:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v3
13+
with:
14+
fetch-depth: 3
15+
16+
- name: Auto Translate
17+
uses: Lin-jun-xiang/action-translate-readme@v1
18+
with:
19+
token: ${{ secrets.Action_Bot }}

‎READM.zh-TW.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# docGPT
2+
3+
(English)[README.md] | (中文版)[README.zh-TW.md]
4+
5+
6+
7+
- 目錄
8+
- [Introduction](#introduction)
9+
- [What's LangChain?](#whats-langchain)
10+
- [Questions that ChatGPT cannot answer are handed over to LangChain for implementation!](#questions-that-chatgpt-cannot-answer-are-handed-over-to-langchain-for-implementation)
11+
- [How to Use docGPT?](#how-to-use-docgpt)
12+
- [Why Use docGPT?](#why-use-docgpt)
13+
- [How to develope a docGPT with streamlit?](#how-to-develope-a-docgpt-with-streamlit)
14+
15+
---
16+
17+
### Introduction
18+
19+
* 使用 langchain、streamlit 輕鬆搭建出一個 AI 模型
20+
21+
* 本專案的設計架構主要有三個元素:
22+
* [`DataConnection`](../model/data_connection.py): 讓 LLM 負責與外部數據溝通，也就是讀取 PDF 檔案，並針對大型 PDF 進行文本切割，避免超出 OPENAI 4000 tokens 的限制
23+
* [`docGPT`](../docGPT/): 該元素就是讓模型了解 PDF 內容的核心，包含將 PDF 文本進行向量嵌入、建立 langchain 的 retrievalQA 模型。詳細簡介請[參考](https://python.langchain.com/docs/modules/chains/popular/vector_db_qa)
24+
* [`agent`](../agent/agent.py): 負責管理模型所用到的工具、並根據使用者提問**自動判斷**使用何種工具處理，工具包含
25+
* `SerpAI`: 當使用者問題屬於 "**現今問題**"，使用該工具可以進行 **google 搜索**
26+
* `llm_math_chain`: 當使用者問題屬於 "**數學計算**"，使用該工具可以進行 數學計算
27+
* `docGPT`: 當使用者詢問有關 PDF 文檔內容，使用該工具可以進行解答 (該工具也是我們透過 retrievalQA 建立的)
28+
29+
30+
* `docGPT` 是基於 **langchain** 與 **streamlit** 開發的
31+
* `langchain`: LangChain 是一個用於**開發由語言模型支持的應用程序的框架**。它支持以下應用程序
32+
1. 可以將 LLM 模型與外部數據源進行連接
33+
2. 允許與 LLM 模型進行交互
34+
* `streamlit`: streamlit 使 python 可以**快速、免費**的部署屬於你的應用程序
35+
36+
* 主要開發軟體與套件:
37+
* `Python 3.8.6`
38+
* `Langchain 0.0.218`
39+
* `Streamlit 1.22.0`
40+
41+
* 使用該工具至少須具備 `openai_api_key`，有關如何取得 key 可以前往[連結](https://platform.openai.com/)
42+
43+
44+
### What's LangChain?
45+
46+
* 有關 langchain 的介紹，建議查看官方文件、[Github源專案](https://github.com/hwchase17/langchain)
47+
48+
#### Questions that ChatGPT cannot answer are handed over to LangChain for implementation!
49+
50+
**ChatGPT 無法回答的問題，交給 Langchain 實現!**
51+
52+
在這邊，作者將簡單介紹 langchain 與 chatgpt 之間的差異，相信您理解以下例子，你會對 langchain 這個開源項目感到震驚!
53+
54+
>今天可以想像 chatgpt 無法回答數學問題、超過 2020 年後的事情(例如2023年貴國總統是誰?)
55+
>
56+
> * 數學問題: 除了 Openai 模型，還存在專門處理數學問題的 math-llm
57+
> * 現今問題: 可以使用 google 搜尋
58+
>
59+
>因此，我們要設計一個強大通用的 ai 模型，勢必要加入** "chatgpt"、"math-llm"、"google search"** 三個工具
60+
>
61+
>如果使用者的提問屬於數學計算類型，我們就使用 math-llm 工具解決、回答
62+
>
63+
>非AI時代，我們就會透過 `if...else...` 方式判斷使用者提問屬於哪種類型，此時就必須在使用者介面讓使用者選擇提問類型
64+
>(UI 介面會有選擇欄位)
65+
>
66+
>但在AI時代，我們要讓使用者直接提問，而不需要事先選擇提問類型!
67+
>在 langchain 中有一個 agent 的概念，它讓我們可以:
68+
>
69+
> * 我們提供工具給他管理，例如 `tools = ['chatgpt', 'math-llm', 'google-search']`
70+
> * 工具也可以包含透過 langchain 設計出的 chain，例如使用 `retrievalQA chain` 設計一個可以回答來自文檔內容的提問，並將此 chain append 到 agent 管理的 tools
71+
> * **藉由 agent 判斷使用者提問，並自行決策出使用哪個工具處理問題** (完全自動化、ai化)
72+
73+
透過 langchain，我們可以創建屬於自己的 chatgpt 模型，它可以是通用型的模型，也可以是**企業化、商業化**的!
74+
75+
### How to Use docGPT?
76+
77+
* 前往[應用程序](https://docgpt-app.streamlit.app/)
78+
79+
* 輸入您的 `API_KEY`:
80+
* `OpenAI API KEY`: 必須設定
81+
* `SERPAPI API KEY`: 根據您需求，如果您要問**PDF文檔沒有出現**的內容，您就需要用此 KEY
82+
83+
* 上傳來自本地的 PDF 檔案
84+
* 開始進行提問 !
85+
86+
![RGB_cleanup](https://github.com/Lin-jun-xiang/docGPT-streamlit/blob/main/img/docGPT.gif?raw=true)
87+
88+
89+
### Why Use docGPT?
90+
91+
* 本專案開發的 `docGPT` 具有以下功能:
92+
* 上傳 PDF
93+
* 與GPT進行來回答覆，快速學習PDF內容
94+
* 進行文檔總結
95+
* 附加 **"math-llm"**，提供您進行**數學計算**相關問答 (chatgpt無法回答的問題)
96+
* 附加 **"google-search"**，提供您進行**google搜尋** (chatgpt無法回答的問題)
97+
98+
99+
### How to develope a docGPT with streamlit?
100+
101+
手把手教學，讓你快速建立一個屬於自己的 chatGPT !
102+
103+
首先請進行 `git clone https://github.com/Lin-jun-xiang/docGPT-streamlit.git`
104+
105+
方法有如下兩種:
106+
107+
* 於本地開發方式
108+
1. `pip install -r requirements.txt`: 下載開發需求套件
109+
2. `streamlit run ./app.py`: 於專案根目錄啟動服務
110+
3. 開始體驗!
111+
112+
* 使用 Streamlit Community Cloud 免費部屬、管理和共享應用程序
113+
1. 將您的應用程序放在公共 GitHub 存儲庫中（並確保它有一個 `requirements.txt`！）
114+
2. 登錄[share.streamlit.io](https://share.streamlit.io/)
115+
3. 單擊“部署應用程序”，然後粘貼您的 GitHub URL
116+
4. 完成部屬[應用程序](https://docgpt-app.streamlit.app//)

‎README.md

Lines changed: 0 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +0,0 @@
1-
## docGPT
2-
3-
主要開發工具:
4-
* `Python`
5-
* `Langchain`
6-
* `Streamlit`
7-
8-
使用該工具至少須具備 `openai_api_key`，有關如何取得 key 可以前往[連結](https://platform.openai.com/)
9-
10-
## How to develope a docGPT with streamlit?
11-
12-
[Tutorial](./tutorial/)
13-
14-
15-
16-
## Introduction
17-
18-
* `docGPT` 是基於 langchain 與 streamlit 開發的
19-
* `langchain`: LangChain 是一個用於**開發由語言模型支持的應用程序的框架**。它支持以下應用程序
20-
1. 可以將 LLM 模型與外部數據源進行連接
21-
2. 允許與 LLM 模型進行交互
22-
* `streamlit`: streamlit 使 python 可以快速、免費的部署屬於你的應用程序 (通常拿來部屬AI)
23-
* 原理
24-
* 透過 langchain 結合多種模型
25-
* 基於 langchain retrievalQA 開發的 **pdf 問答工具**
26-
* 基於 math-llm 開發的 **數學計算工具**
27-
* 基於 google-search 開發的 **搜索工具**
28-
29-
## LangChain
30-
31-
* 有關 langchain 的介紹，建議查看官方文件、[Github源專案](https://github.com/hwchase17/langchain)
32-
33-
#### Questions that ChatGPT cannot answer are handed over to LangChain for implementation!
34-
35-
**ChatGPT 無法回答的問題，交給 Langchain 實現!**
36-
37-
在這邊，作者將簡單介紹 langchain 與 chatgpt 之間的差異，相信您理解以下例子，你會對 langchain 這個開源項目感到震驚!
38-
39-
>今天可以想像 chatgpt 無法回答數學問題、超過 2020 年後的事情(例如2023年貴國總統是誰?)
40-
>
41-
> * 數學問題: 除了 Openai 模型，還存在專門處理數學問題的 math-llm
42-
> * 現今問題: 可以使用 google 搜尋
43-
>
44-
>因此，我們要設計一個強大通用的 ai 模型，勢必要加入** "chatgpt"、"math-llm"、"google search"** 三個工具
45-
>
46-
>如果使用者的提問屬於數學計算類型，我們就使用 math-llm 工具解決、回答
47-
>
48-
>非AI時代，我們就會透過 `if...else...` 方式判斷使用者提問屬於哪種類型，此時就必須在使用者介面讓使用者選擇提問類型
49-
>(UI 介面會有選擇欄位)
50-
>
51-
>但在AI時代，我們要讓使用者直接提問，而不需要事先選擇提問類型!
52-
>在 langchain 中有一個 agent 的概念，它讓我們可以:
53-
>
54-
> * 我們提供工具給他管理，例如 `tools = ['chatgpt', 'math-llm', 'google-search']`
55-
> * 工具也可以包含透過 langchain 設計出的 chain，例如使用 `retrievalQA chain` 設計一個可以回答來自文檔內容的提問，並將此 chain append 到 agent 管理的 tools
56-
> * **藉由 agent 判斷使用者提問，並自行決策出使用哪個工具處理問題** (完全自動化、ai化)
57-
58-
透過 langchain，我們可以創建屬於自己的 chatgpt 模型，它可以是通用型的模型，也可以是**企業化、商業化**的!
59-
60-
## How to Use?
61-
62-
* 輸入您的 `API_KEY`:
63-
* `OpenAI API KEY`: 必須設定
64-
* `SERPAPI API KEY`: 根據您需求，如果您要問**PDF文檔沒有出現**的內容，您就需要用此 KEY
65-
66-
* 上傳來自本地的 PDF 檔案
67-
* 開始進行提問 !
68-
69-
![RGB_cleanup](https://github.com/Lin-jun-xiang/docGPT-streamlit/blob/main/img/docGPT.gif?raw=true)
70-
71-
72-
## Why Use?
73-
74-
* 本專案開發的 `docGPT` 具有以下功能:
75-
* 上傳 PDF
76-
* 與GPT進行來回答覆，快速學習PDF內容
77-
* 進行文檔總結
78-
* 附加 **"math-llm"**，提供您進行**數學計算**相關問答 (chatgpt無法回答的問題)
79-
* 附加 **"google-search"**，提供您進行**google搜尋** (chatgpt無法回答的問題)
80-
81-

0 commit comments

Comments
 (0)