doc:update document

eosphoros-ai · Nov 3, 2023 · 3111760 · 3111760
1 parent 0874fa2
commit 3111760
Show file tree

Hide file tree

Showing 10 changed files with 440 additions and 384 deletions.
diff --git a/docs/getting_started/application/chatdb/chatdb.md b/docs/getting_started/application/chatdb/chatdb.md
@@ -4,6 +4,12 @@ ChatData generates SQL from natural language and executes it. ChatDB involves co
 Database, including metadata about databases, tables, and
 fields.![db plugins demonstration](https://github.com/eosphoros-ai/DB-GPT/assets/13723926/d8bfeee9-e982-465e-a2b8-1164b673847e)
 
+```{admonition} The LLM (Language Model) suitable for the ChatData scene is 
+* chatgpt3.5.
+* chatgpt4.
+* Vicuna-v1.5.
+```
+
 ### 1.Choose Datasource
 
 If you are using DB-GPT for the first time, you need to add a data source and set the relevant connection information

diff --git a/docs/getting_started/application/chatexcel/chatexcel.md b/docs/getting_started/application/chatexcel/chatexcel.md
@@ -3,6 +3,11 @@ ChatExcel
 ![db plugins demonstration](https://github.com/eosphoros-ai/DB-GPT/assets/13723926/4113ac15-83c2-4350-86c0-5fc795677abd)
 ChatExcel uses natural language to analyze and query Excel data.![db plugins demonstration](../../../../assets/chat_excel/chat_excel_1.png)
 
+```{admonition} The LLM (Language Model) suitable for the ChatExcel scene is 
+* chatgpt3.5.
+* chatgpt4.
+```
+
 ### 1.Select And Upload Excel or CSV File
 Select your excel or csv file to upload and start the conversation.
 ```{tip}

diff --git a/docs/getting_started/application/dashboard/dashboard.md b/docs/getting_started/application/dashboard/dashboard.md
@@ -4,6 +4,11 @@ The purpose of the DB-GPT Dashboard is to empower data analysts with efficiency.
 technology, allowing business analysts to perform self-service analysis directly using natural language and gain
 insights into their respective areas of business.
 
+```{admonition} The LLM (Language Model) suitable for the Dashboard scene is
+* chatgpt3.5.
+* chatgpt4.
+```
+
 ```{note} Dashboard now support Datasource Type
 * Mysql
 * Sqlite

diff --git a/docs/locales/zh_CN/LC_MESSAGES/getting_started/application/chatdb/chatdb.po b/docs/locales/zh_CN/LC_MESSAGES/getting_started/application/chatdb/chatdb.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: DB-GPT 👏👏 0.3.5\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-09-26 17:51+0800\n"
+"POT-Creation-Date: 2023-11-03 15:25+0800\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: zh_CN\n"
@@ -20,12 +20,12 @@ msgstr ""
 "Generated-By: Babel 2.12.1\n"
 
 #: ../../getting_started/application/chatdb/chatdb.md:1
-#: 0cf45852c1fd430090da81836bc961c7
+#: c1489293ce464cee9577b0aa9a3f3037
 msgid "ChatData & ChatDB"
 msgstr "ChatData & ChatDB"
 
 #: ../../getting_started/application/chatdb/chatdb.md:3
-#: 6dc94a787ff844caa21074d71aaf351a
+#: 2c421938f270427dbd0ffff892b1a5a1
 #, fuzzy
 msgid ""
 "ChatData generates SQL from natural language and executes it. ChatDB "
@@ -38,130 +38,139 @@ msgstr ""
 "plugins demonstration](../../../../assets/chat_data/chat_data.jpg)"
 
 #: ../../getting_started/application/chatdb/chatdb.md:3
-#: ../../getting_started/application/chatdb/chatdb.md:20
-#: ../../getting_started/application/chatdb/chatdb.md:24
-#: ../../getting_started/application/chatdb/chatdb.md:28
-#: ../../getting_started/application/chatdb/chatdb.md:43
-#: ../../getting_started/application/chatdb/chatdb.md:48
-#: ../../getting_started/application/chatdb/chatdb.md:54
-#: 826032e82a0a40b2bd122a90a35d0161 91652ef9e3224290b0c89112bcca4474
-#: d396ffa33eef4bef8471040369414420 d7f176a7794048d3ac3573970db86d9d
-#: f80e5611eca64f86baeeed6c860061f9
+#: ../../getting_started/application/chatdb/chatdb.md:27
+#: ../../getting_started/application/chatdb/chatdb.md:31
+#: ../../getting_started/application/chatdb/chatdb.md:35
+#: ../../getting_started/application/chatdb/chatdb.md:50
+#: ../../getting_started/application/chatdb/chatdb.md:55
+#: ../../getting_started/application/chatdb/chatdb.md:61
+#: 1467691a6012498795a94a14f7eba307 32315140835948c58e1721c7e2fa88a9
+#: 3b8e3c3396ff47348105a6dec9e755ba 6b116d2bac2d43faa4cbcbd0c4151344
+#: a314854e9be945dd88ad241bfa340870 d94d5f0e608f4399a0e10d593f0ab1da
+#: e0ca6ec1841040bc828ce2ef29c387b6
 msgid "db plugins demonstration"
 msgstr "db plugins demonstration"
 
-#: ../../getting_started/application/chatdb/chatdb.md:7
-#: aa0f978d3ad34b71aacf143a4c807ba1
+#: ../../getting_started/application/chatdb/chatdb.md:8
+#: 67cb0954cfa54e629b75cf9a241f6b9d
+msgid ""
+"The LLM (Language Model) suitable for the ChatData scene is      * "
+"chatgpt3.5.     * chatgpt4.     * Vicuna-v1.5."
+msgstr "ChatData场景适用的LLM      * "
+"chatgpt3.5.     * chatgpt4.     * Vicuna-v1.5."
+
+#: ../../getting_started/application/chatdb/chatdb.md:14
+#: 8bd004993a834b0797ebcb5b6a6b1a23
 msgid "1.Choose Datasource"
 msgstr "1.Choose Datasource"
 
-#: ../../getting_started/application/chatdb/chatdb.md:9
-#: 8a2338e2fbae44f1b61b2fcf062499d3
+#: ../../getting_started/application/chatdb/chatdb.md:16
+#: 34abfdced7804b51a212c0e567ffda6b
 msgid ""
 "If you are using DB-GPT for the first time, you need to add a data source"
 " and set the relevant connection information for the data source."
 msgstr "如果你是第一次使用DB-GPT, 首先需要添加数据源，设置数据源的相关连接信息"
 
-#: ../../getting_started/application/chatdb/chatdb.md:13
-#: f1d165ab8b564445880e581a2e554434
+#: ../../getting_started/application/chatdb/chatdb.md:20
+#: 3a8d16a8a32c4ac5affbd8093677b4f8
 msgid "there are some example data in DB-GPT-NEW/DB-GPT/docker/examples"
 msgstr "在DB-GPT-NEW/DB-GPT/docker/examples有数据示例"
 
-#: ../../getting_started/application/chatdb/chatdb.md:15
-#: dd390cb518094c96bf5430bfa821830f
+#: ../../getting_started/application/chatdb/chatdb.md:22
+#: 2c3333a2705648148f79623c220d90cd
 msgid "you can execute sql script to generate data."
 msgstr "你可以通过执行sql脚本生成测试数据"
 
-#: ../../getting_started/application/chatdb/chatdb.md:18
-#: aebd974d23124daa80af6d74431d1ce3
+#: ../../getting_started/application/chatdb/chatdb.md:25
+#: 4994182137574d14a3eefb421ceccd8e
 msgid "1.1 Datasource management"
 msgstr "1.1 Datasource management"
 
-#: ../../getting_started/application/chatdb/chatdb.md:20
-#: af4d12aaed5c4fc484a3e7a755a666c2
+#: ../../getting_started/application/chatdb/chatdb.md:27
+#: 94680e1487d84092abc51a7da9bf1075
 msgid ""
 "![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
 "GPT/assets/13723926/7678f07e-9eee-40a9-b980-5b3978a0ed52)"
 msgstr ""
 "![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
 "GPT/assets/13723926/7678f07e-9eee-40a9-b980-5b3978a0ed52)"
 
-#: ../../getting_started/application/chatdb/chatdb.md:22
-#: 34b7b9ce0f0142af8179a8e1763a32f8
+#: ../../getting_started/application/chatdb/chatdb.md:29
+#: 236dbd6d6cb4467593bf30597ecb215c
 msgid "1.2 Connection management"
 msgstr "1.2 Connection管理"
 
-#: ../../getting_started/application/chatdb/chatdb.md:24
-#: 00a1af9f4e0a45b9a398f641c8198114
+#: ../../getting_started/application/chatdb/chatdb.md:31
+#: 6611193e600c4452ac8a9769c6230590
 msgid ""
 "![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
 "GPT/assets/13723926/25b8f5a9-d322-459e-a8b2-bfe8cb42bdd6)"
 msgstr ""
 "![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
 "GPT/assets/13723926/25b8f5a9-d322-459e-a8b2-bfe8cb42bdd6)"
 
-#: ../../getting_started/application/chatdb/chatdb.md:26
-#: 3b8efc25b482480b8d0f4afe5304ece0
+#: ../../getting_started/application/chatdb/chatdb.md:33
+#: 7cceb9703af54970bee4a50fb07d4509
 msgid "1.3 Add Datasource"
 msgstr "1.3 添加Datasource"
 
-#: ../../getting_started/application/chatdb/chatdb.md:28
-#: d36a476e1eb34a46b2d35e6c1c4c39dd
+#: ../../getting_started/application/chatdb/chatdb.md:35
+#: 83c9e18cb87b4f0d9b0ce5e68b7fea77
 msgid ""
 "![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
 "GPT/assets/13723926/19ce31a7-4061-4da8-a9cb-efca396cc085)"
 msgstr ""
 "![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
 "GPT/assets/13723926/19ce31a7-4061-4da8-a9cb-efca396cc085)"
 
-#: ../../getting_started/application/chatdb/chatdb.md:31
-#: 9205388f91404099bf1add6d55f33801
+#: ../../getting_started/application/chatdb/chatdb.md:38
+#: 143fb04274cd486687c5766179f6103e
 msgid "now DB-GPT support Datasource Type"
 msgstr "DB-GPT支持数据源类型"
 
-#: ../../getting_started/application/chatdb/chatdb.md:33
-#: 197722ccd9e54f8196e3037f0ebd4165
+#: ../../getting_started/application/chatdb/chatdb.md:40
+#: 8bcf83e66b2d4d858407fc2b21b8fe85
 msgid "Mysql"
 msgstr "Mysql"
 
-#: ../../getting_started/application/chatdb/chatdb.md:34
-#: e859c194648440b19941a42635f37ac5
+#: ../../getting_started/application/chatdb/chatdb.md:41
+#: cd74abd5d6f4410ca001a3de2685e768
 msgid "Sqlite"
 msgstr "Sqlite"
 
-#: ../../getting_started/application/chatdb/chatdb.md:35
-#: 91c695f437064f01bf1d7c85a0ecf5b4
+#: ../../getting_started/application/chatdb/chatdb.md:42
+#: fc5e01baba43449f8c3eb9b4b36a0ed8
 msgid "DuckDB"
 msgstr "DuckDB"
 
-#: ../../getting_started/application/chatdb/chatdb.md:36
-#: 0a8ff591969c4944890415a84aa64173
+#: ../../getting_started/application/chatdb/chatdb.md:43
+#: 10b6fe2153cd4ceba949687a54c3a68c
 msgid "Clickhouse"
 msgstr "Clickhouse"
 
-#: ../../getting_started/application/chatdb/chatdb.md:37
-#: d52ec849653141dc95862e82ce5777e0
+#: ../../getting_started/application/chatdb/chatdb.md:44
+#: 9ce0a41784f041d39138a81099c386e9
 #, fuzzy
 msgid "Mssql"
 msgstr "Mysql"
 
-#: ../../getting_started/application/chatdb/chatdb.md:38
-#: 430a72d857114422aeecd5595df41881
+#: ../../getting_started/application/chatdb/chatdb.md:45
+#: 4af6eb835e954e0d937e98b308fb512b
 msgid "Spark"
 msgstr "Spark"
 
-#: ../../getting_started/application/chatdb/chatdb.md:41
-#: b615a70971e7443291ba33e8bc12b437
+#: ../../getting_started/application/chatdb/chatdb.md:48
+#: 8aaa3a73090b4805b2dddf1cc355d83c
 msgid "2.ChatData"
 msgstr "2.ChatData"
 
-#: ../../getting_started/application/chatdb/chatdb.md:42
-#: e3542c64926143958e71c7cb21d25c78
+#: ../../getting_started/application/chatdb/chatdb.md:49
+#: a34c79c99bd34233ae92d3090ff0b877
 msgid "Preview Mode"
 msgstr "Preview Mode"
 
-#: ../../getting_started/application/chatdb/chatdb.md:43
-#: e32f26b7c22141e181b5345a644dffd5
+#: ../../getting_started/application/chatdb/chatdb.md:50
+#: 39e31a2a01494d4191d415a2240e026d
 #, fuzzy
 msgid ""
 "After successfully setting up the data source, you can start conversing "
@@ -173,13 +182,13 @@ msgstr ""
 "设置数据源成功后就可以和数据库进行对话了。你可以让它帮你生成SQL，也可以和问它数据库元数据的相关信息。 ![db plugins "
 "demonstration](../../../../assets/chat_data/chatdata_eg.png)"
 
-#: ../../getting_started/application/chatdb/chatdb.md:47
-#: 4d5c0465a01b4f5a964d0e803f9cbc89
+#: ../../getting_started/application/chatdb/chatdb.md:54
+#: 999c78e8b604493a8190b0e1258d0da4
 msgid "Editor Mode"
 msgstr "Editor Mode"
 
-#: ../../getting_started/application/chatdb/chatdb.md:48
-#: 79b088787e8f43258bcc4292c89ad1b0
+#: ../../getting_started/application/chatdb/chatdb.md:55
+#: e4a61d1e62c743f8b13dbed92ec265ba
 msgid ""
 "In Editor Mode, you can edit your sql and execute it. ![db plugins "
 "demonstration](https://github.com/eosphoros-ai/DB-"
@@ -189,13 +198,13 @@ msgstr ""
 "/eosphoros-ai/DB-"
 "GPT/assets/13723926/1a896dc1-7c0e-4354-8629-30357ffd8d7f)"
 
-#: ../../getting_started/application/chatdb/chatdb.md:52
-#: 9efaf27749614cd4bea07146edddf558
+#: ../../getting_started/application/chatdb/chatdb.md:59
+#: b3a0d94083524d249f97dd426e1e1f26
 msgid "3.ChatDB"
 msgstr "3.ChatDB"
 
-#: ../../getting_started/application/chatdb/chatdb.md:54
-#: b2dc15f067064c60974e532c3e2f5893
+#: ../../getting_started/application/chatdb/chatdb.md:61
+#: 8f4bd453447f48019a597eb3e4a59875
 msgid ""
 "![db plugins demonstration](https://github.com/eosphoros-ai/DB-"
 "GPT/assets/13723926/e04bc1b1-2c58-4b33-af62-97e89098ace7)"