From 8980de9be4d3a794432ab0dc138fba2cb554ffcf Mon Sep 17 00:00:00 2001 From: aries-ckt <916701291@qq.com> Date: Wed, 14 Jun 2023 15:31:11 +0800 Subject: [PATCH] doc:db-gpt doc --- docs/getting_started/tutorials.md | 14 +- docs/index.rst | 6 +- .../LC_MESSAGES/getting_started/tutorials.po | 42 ++--- docs/locales/zh_CN/LC_MESSAGES/index.po | 144 ++++++++---------- .../zh_CN/LC_MESSAGES/modules/connections.po | 35 +++-- .../connections/mysql/mysql_connection.po | 36 +++++ .../zh_CN/LC_MESSAGES/modules/knowledge.po | 98 ++++++++++++ .../knowledge/markdown/markdown_embedding.po | 55 +++++++ .../modules/knowledge/pdf/pdf_embedding.po | 56 +++++++ .../modules/knowledge/ppt/ppt_embedding.po | 55 +++++++ .../modules/knowledge/url/url_embedding.po | 55 +++++++ .../modules/knowledge/word/word_embedding.po | 55 +++++++ .../use_cases/sql_generation_and_diagnosis.po | 22 ++- docs/modules/connections.md | 4 - docs/modules/connections.rst | 16 ++ .../connections/mysql/mysql_connection.md | 18 +++ docs/modules/knowledge.rst | 40 +++++ .../knowledge/markdown/markdown_embedding.md | 42 +++++ docs/modules/knowledge/pdf/pdf_embedding.md | 43 ++++++ docs/modules/knowledge/ppt/ppt_embedding.md | 40 +++++ docs/modules/knowledge/url/url_embedding.md | 47 ++++++ docs/modules/knowledge/word/word_embedding.md | 38 +++++ docs/use_cases/chatbots.md | 1 - docs/use_cases/interacting_with_api.md | 1 - .../use_cases/sql_generation_and_diagnosis.md | 6 +- pilot/source_embedding/markdown_embedding.py | 2 +- pilot/source_embedding/pdf_embedding.py | 2 +- 27 files changed, 843 insertions(+), 130 deletions(-) create mode 100644 docs/locales/zh_CN/LC_MESSAGES/modules/connections/mysql/mysql_connection.po create mode 100644 docs/locales/zh_CN/LC_MESSAGES/modules/knowledge.po create mode 100644 docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/markdown/markdown_embedding.po create mode 100644 docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/pdf/pdf_embedding.po create mode 100644 docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/ppt/ppt_embedding.po create mode 100644 docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/url/url_embedding.po create mode 100644 docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/word/word_embedding.po delete mode 100644 docs/modules/connections.md create mode 100644 docs/modules/connections.rst create mode 100644 docs/modules/connections/mysql/mysql_connection.md create mode 100644 docs/modules/knowledge.rst create mode 100644 docs/modules/knowledge/markdown/markdown_embedding.md create mode 100644 docs/modules/knowledge/pdf/pdf_embedding.md create mode 100644 docs/modules/knowledge/ppt/ppt_embedding.md create mode 100644 docs/modules/knowledge/url/url_embedding.md create mode 100644 docs/modules/knowledge/word/word_embedding.md delete mode 100644 docs/use_cases/chatbots.md delete mode 100644 docs/use_cases/interacting_with_api.md diff --git a/docs/getting_started/tutorials.md b/docs/getting_started/tutorials.md index 4c2245996..902216831 100644 --- a/docs/getting_started/tutorials.md +++ b/docs/getting_started/tutorials.md @@ -5,21 +5,21 @@ This is a collection of DB-GPT tutorials on Medium. DB-GPT is divided into several functions, including chat with knowledge base, execute SQL, chat with database, and execute plugins. -###Introduce -[What is DB-GPT](https://www.youtube.com/watch?v=QszhVJerc0I) by csunny (https://github.com/csunny/DB-GPT): +### Introduce +[What is DB-GPT](https://www.youtube.com/watch?v=QszhVJerc0I) ### Knowledge -[How to Create your own knowledge repository](https://db-gpt.readthedocs.io/en/latest/modules/knownledge.html) +[How to Create your own knowledge repository](https://db-gpt.readthedocs.io/en/latest/modules/knowledge.html) -[Add new Knowledge demonstration](../../assets/new_knownledge_en.gif) +[Add new Knowledge demonstration](https://github.com/csunny/DB-GPT/blob/main/assets/new_knownledge_en.gif) ### SQL Generation -[sql generation demonstration](../../assets/demo_en.gif) +[sql generation demonstration](https://github.com/csunny/DB-GPT/blob/main/assets/demo_en.gif) ### SQL Execute -[sql execute demonstration](../../assets/auto_sql_en.gif) +[sql execute demonstration](https://github.com/csunny/DB-GPT/blob/main/assets/auto_sql_en.gif) ### Plugins -[db plugins demonstration](../../assets/dbgpt_bytebase_plugin.gif) \ No newline at end of file +[db plugins demonstration](https://github.com/csunny/DB-GPT/blob/main/assets/auto_plugin.gif) \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 2b33ed0be..941aa4ff4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -68,7 +68,7 @@ It's very important for DB-GPT, DB-GPT also provide standard, extendable interfa - `Plugins <./modules/plugins.html>`_: Plugins management, scheduler. -- `Knownledge <./modules/knownledge.html>`_: Knownledge management, embedding, and search. +- `Knowledge <./modules/knowledge.html>`_: Knowledge management, embedding, and search. - `Connections <./modules/connections.html>`_: Supported multi databases connection. management connections and interact with this. @@ -81,8 +81,8 @@ It's very important for DB-GPT, DB-GPT also provide standard, extendable interfa ./modules/llms.md ./modules/prompts.md ./modules/plugins.md - ./modules/connections.md - ./modules/knownledge.md + ./modules/connections.rst + ./modules/knowledge.rst Use Cases --------- diff --git a/docs/locales/zh_CN/LC_MESSAGES/getting_started/tutorials.po b/docs/locales/zh_CN/LC_MESSAGES/getting_started/tutorials.po index b00cd631a..a5022ff27 100644 --- a/docs/locales/zh_CN/LC_MESSAGES/getting_started/tutorials.po +++ b/docs/locales/zh_CN/LC_MESSAGES/getting_started/tutorials.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: DB-GPT 0.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2023-06-13 18:04+0800\n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: zh_CN\n" @@ -19,72 +19,72 @@ msgstr "" "Content-Transfer-Encoding: 8bit\n" "Generated-By: Babel 2.12.1\n" -#: ../../getting_started/tutorials.md:1 7011a2ab0e7f45ddb1fa85b6479cc442 +#: ../../getting_started/tutorials.md:1 f80ad98cf2d444a3a159655b37ae4d4f msgid "Tutorials" msgstr "教程" -#: ../../getting_started/tutorials.md:4 960f88b9c1b64940bfa0576bab5b0314 +#: ../../getting_started/tutorials.md:4 ff8771c31b024e538dbbaaeaccec8aa7 msgid "This is a collection of DB-GPT tutorials on Medium." msgstr "这是知乎上DB-GPT教程的集合。．" -#: ../../getting_started/tutorials.md:6 1c8db33581ea4928905e029a98b9a155 +#: ../../getting_started/tutorials.md:6 0c1c544a5d184375aabd7fe6918042e2 msgid "" "DB-GPT is divided into several functions, including chat with knowledge " "base, execute SQL, chat with database, and execute plugins." msgstr "" -#: ../../getting_started/tutorials.md:8 3915395cc45742519bf0c607eeafc489 +#: ../../getting_started/tutorials.md:8 b5e106a97bbd4467b071bb05d837d7d9 +msgid "Introduce" +msgstr "" + +#: ../../getting_started/tutorials.md:9 9df43436183d4b41a75a09fec15743d7 #, fuzzy -msgid "" -"###Introduce [What is DB-" -"GPT](https://www.youtube.com/watch?v=QszhVJerc0I) by csunny " -"(https://github.com/csunny/DB-GPT):" +msgid "[What is DB-GPT](https://www.youtube.com/watch?v=QszhVJerc0I)" msgstr "" "###Introduce [什么是DB-" "GPT](https://www.bilibili.com/video/BV1SM4y1a7Nj/?buvid=551b023900b290f9497610b2155a2668&is_story_h5=false&mid=%2BVyE%2Fwau5woPcUKieCWS0A%3D%3D&p=1&plat_id=116&share_from=ugc&share_medium=iphone&share_plat=ios&share_session_id=5D08B533-82A4-4D40-9615-7826065B4574&share_source=GENERIC&share_tag=s_i×tamp=1686307943&unique_k=bhO3lgQ&up_id=31375446)" " by csunny (https://github.com/csunny/DB-GPT)" -#: ../../getting_started/tutorials.md:11 e213736923574b2cb039a457d789c27c +#: ../../getting_started/tutorials.md:11 3096811f862649bf84ff3cd29cdf14db msgid "Knowledge" msgstr "知识库" -#: ../../getting_started/tutorials.md:13 90b5472735a644168d51c054ed882748 +#: ../../getting_started/tutorials.md:13 ea00f3de8c754bf2950e735a2f14043a msgid "" "[How to Create your own knowledge repository](https://db-" -"gpt.readthedocs.io/en/latest/modules/knownledge.html)" +"gpt.readthedocs.io/en/latest/modules/knowledge.html)" msgstr "" "[怎么创建自己的知识库](https://db-" -"gpt.readthedocs.io/en/latest/modules/knownledge.html)" +"gpt.readthedocs.io/en/latest/modules/knowledge.html)" -#: ../../getting_started/tutorials.md:15 6a851e1e88ea4bcbaf7ee742a12224ef +#: ../../getting_started/tutorials.md:15 07195f11314945989eeeb9400c8a9b43 msgid "[Add new Knowledge demonstration](../../assets/new_knownledge_en.gif)" msgstr "[新增知识库演示](../../assets/new_knownledge_en.gif)" -#: ../../getting_started/tutorials.md:17 59887be89d8046e28956f909fcbbc9dc +#: ../../getting_started/tutorials.md:17 5245cd247a184f63a10f735f414f303f msgid "SQL Generation" msgstr "" -#: ../../getting_started/tutorials.md:18 ee5decd8441d40ae8a240a19c1a5a74a +#: ../../getting_started/tutorials.md:18 38077ab510264112b6156c27b8880967 #, fuzzy msgid "[sql generation demonstration](../../assets/demo_en.gif)" msgstr "[sql生成演示](../../assets/demo_en.gif)" -#: ../../getting_started/tutorials.md:20 5d25c5d307c24c9198f2b52e70f2421c +#: ../../getting_started/tutorials.md:20 c0a6f9fefbb9404695fe3bffb6ecc577 msgid "SQL Execute" msgstr "SQL执行" -#: ../../getting_started/tutorials.md:21 ee5decd8441d40ae8a240a19c1a5a74a +#: ../../getting_started/tutorials.md:21 39fe94853f9c4165b40812c57171a6f4 #, fuzzy msgid "[sql execute demonstration](../../assets/auto_sql_en.gif)" msgstr "[sql execute 演示](../../assets/auto_sql_en.gif)" - -#: ../../getting_started/tutorials.md:26 4487ef393e004e7c936f5104727212a4 +#: ../../getting_started/tutorials.md:24 0fd9770dbf3c49b0b644599dc70187a7 #, fuzzy msgid "Plugins" msgstr "DB Plugins" -#: ../../getting_started/tutorials.md:27 ee5decd8441d40ae8a240a19c1a5a74a +#: ../../getting_started/tutorials.md:25 fc9830406c39473ab32df00a33340385 #, fuzzy msgid "[db plugins demonstration](../../assets/dbgpt_bytebase_plugin.gif)" msgstr "[db plugins 演示](../../assets/dbgpt_bytebase_plugin.gif)" diff --git a/docs/locales/zh_CN/LC_MESSAGES/index.po b/docs/locales/zh_CN/LC_MESSAGES/index.po index 5d1b9c0d0..16319d31f 100644 --- a/docs/locales/zh_CN/LC_MESSAGES/index.po +++ b/docs/locales/zh_CN/LC_MESSAGES/index.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: DB-GPT 0.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2023-06-11 14:10+0800\n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: zh_CN\n" @@ -17,33 +17,33 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.11.0\n" +"Generated-By: Babel 2.12.1\n" -#: ../../index.rst:34 ../../index.rst:45 e3275f133efd471582d952301a6e243e +#: ../../index.rst:34 ../../index.rst:45 558ad9c9fc2240589fabce35463ca24c msgid "Getting Started" msgstr "开始" -#: ../../index.rst:56 ../../index.rst:75 86e2ce002e604304a4032aa1555b36cb +#: ../../index.rst:56 ../../index.rst:75 abd248b06ac142a68a89e0fb7e477536 msgid "Modules" msgstr "模块" -#: ../../index.rst:88 ../../index.rst:104 b15c23cfcc084df9a8f8f9990e6903ac +#: ../../index.rst:88 ../../index.rst:104 e046db82aa5845598b373ca1b9a73ec2 msgid "Use Cases" msgstr "示例" -#: ../../index.rst:118 ../../index.rst:121 70605b76fe5348299dd5d48d8ab6a77c +#: ../../index.rst:118 ../../index.rst:121 e6fbf08bf59b48afb4ac3f479d88256b msgid "Reference" msgstr "参考" -#: ../../index.rst:145 ../../index.rst:151 f62cf565fab64977b0efbd50e83540cc +#: ../../index.rst:145 ../../index.rst:151 03496f75357d4b4d9fd721516faa5e54 msgid "Resources" msgstr "资源" -#: ../../index.rst:7 c8b3a0ca759f432095161f7baccde1c4 +#: ../../index.rst:7 e0764d3d816244b4bf047032c1a28760 msgid "Welcome to DB-GPT!" msgstr "欢迎来到DB-GPT中文文档" -#: ../../index.rst:8 0167fea2c4df4181bc10d6e71527d005 +#: ../../index.rst:8 a3500e3f721348ce859c7c774b59b41a msgid "" "As large models are released and iterated upon, they are becoming " "increasingly intelligent. However, in the process of using large models, " @@ -56,217 +56,207 @@ msgid "" "independent private environments but also to be independently deployed " "and isolated according to business modules, ensuring that the ability of " "large models is absolutely private, secure, and controllable." -msgstr "随着大型模型的发布和迭代，它们变得越来越智能。然而，在使用大型模型的过程中，" -"我们在数据安全和隐私方面面临着重大挑战。我们需要确保我们的敏感数据和环境得到完全控制，" -"避免任何数据隐私泄露或安全风险。基于此，我们启动了DB-GPT项目，为所有基于数据库的" -"场景构建一个完整的私有大模型解决方案。该方案“”支持本地部署，既可应用于“独立私" -"有环境”，又可根据业务模块进行“独立部署”和“隔离”，确保“大模型”的能力绝对" -"私有、安全、可控。" +msgstr "" +"随着大型模型的发布和迭代，它们变得越来越智能。然而，在使用大型模型的过程中，我们在数据安全和隐私方面面临着重大挑战。我们需要确保我们的敏感数据和环境得到完全控制，避免任何数据隐私泄露或安全风险。基于此" +"，我们启动了DB-" +"GPT项目，为所有基于数据库的场景构建一个完整的私有大模型解决方案。该方案“”支持本地部署，既可应用于“独立私有环境”，又可根据业务模块进行“独立部署”和“隔离”，确保“大模型”的能力绝对私有、安全、可控。" -#: ../../index.rst:10 36b847a04d624286a4942cd77821da8c +#: ../../index.rst:10 a8d66309ae5244d88b3c599a5ff97137 msgid "" "**DB-GPT** is an experimental open-source project that uses localized GPT" " large models to interact with your data and environment. With this " "solution, you can be assured that there is no risk of data leakage, and " "your data is 100% private and secure." -msgstr "DB-GPT 是一个开源的以数据库为基础的GPT实验项目，使用本地化的" -"GPT大模型与您的数据和环境进行交互，无数据泄露风险" -"100% 私密，100% 安全。" +msgstr "" +"DB-GPT 是一个开源的以数据库为基础的GPT实验项目，使用本地化的GPT大模型与您的数据和环境进行交互，无数据泄露风险100% 私密，100%" +" 安全。" -#: ../../index.rst:12 d20166d203934385b811740f4d5eda33 +#: ../../index.rst:12 806ae939ad9349ccb4375a236cbaf418 msgid "**Features**" msgstr "特性" -#: ../../index.rst:13 03f9de47513b4bc9a26f31e1d2d8ad60 +#: ../../index.rst:13 abd6265d37a64b00939e9c0a78f11a5e msgid "" "Currently, we have released multiple key features, which are listed below" " to demonstrate our current capabilities:" msgstr "目前我们已经发布了多种关键的特性，这里一一列举展示一下当前发布的能力。" -#: ../../index.rst:15 abc51c99bc6e49d5b0105c7d95e391da +#: ../../index.rst:15 6484ed0d92654283a7cbee6cb6b54821 msgid "SQL language capabilities - SQL generation - SQL diagnosis" msgstr "SQL语言能力 - SQL生成 - SQL诊断" -#: ../../index.rst:19 e9ba27f21fd84ecf973640fa021b06b6 +#: ../../index.rst:19 0d7ef0cf6ec649e5a9c7e076bc30ca1a msgid "" "Private domain Q&A and data processing - Database knowledge Q&A - Data " "processing" msgstr "私有领域问答与数据处理 - 数据库知识问答 - 数据处理" -#: ../../index.rst:23 a4584012b6634553abef5a4ee6ddf509 +#: ../../index.rst:23 83d1fc0f88cc42bca5206c4b9915ce65 msgid "" "Plugins - Support custom plugin execution tasks and natively support the " "Auto-GPT plugin, such as:" -msgstr "插件模型 - 支持自定义插件执行任务，并原生支持Auto-GPT插件，例如:" -"* SQL自动执行，获取查询结果 * 自动爬取学习知识" +msgstr "插件模型 - 支持自定义插件执行任务，并原生支持Auto-GPT插件，例如:* SQL自动执行，获取查询结果 * 自动爬取学习知识" -#: ../../index.rst:26 b08674d7a7da4405b9388e296bc2cd57 +#: ../../index.rst:26 7790cb466b1d455298d5eaa7582fc5ed msgid "" "Unified vector storage/indexing of knowledge base - Support for " "unstructured data such as PDF, Markdown, CSV, and WebURL" msgstr "知识库统一向量存储/索引 - 非结构化数据支持包括PDF、MarkDown、CSV、WebURL" -#: ../../index.rst:29 cf4bc81d46b4418b81a78242cbc7f984 +#: ../../index.rst:29 7354784dc4ba494e82f5d3acaac7730b msgid "" "Milti LLMs Support - Supports multiple large language models, currently " "supporting Vicuna (7b, 13b), ChatGLM-6b (int4, int8) - TODO: codegen2, " "codet5p" msgstr "多模型支持 - 支持多种大语言模型, 当前已支持Vicuna(7b,13b), ChatGLM-6b(int4, int8)" -Guanaco, Goriila, Falcon等系列模型" -#: ../../index.rst:35 681ae172eea64b718e0f6fc734d041b1 +#: ../../index.rst:35 8598e71986834a24aa390603b84288d1 msgid "" "How to get started using DB-GPT to interact with your data and " "environment." msgstr "开始使用DB-GPT与您的数据环境进行交互。" -#: ../../index.rst:36 87f507e0c27a4a38ba2a5c19e804549f +#: ../../index.rst:36 8685d294df2040d294523c068969a966 msgid "`Quickstart Guid <./getting_started/getting_started.html>`_" msgstr "`使用指南 <./getting_started/getting_started.html>`_" -#: ../../index.rst:38 ab35a5cd96c548ecb0c285fd822f652a +#: ../../index.rst:38 bd33c376f4d54a24957cdbd86ac969f1 msgid "Concepts and terminology" msgstr "相关概念" -#: ../../index.rst:40 3fbd5c96df084ef889442a0b89ad6c05 +#: ../../index.rst:40 2e9ac1f015bf4d37b0b76de94a831f5b msgid "`Concepts and terminology <./getting_started/concepts.html>`_" msgstr "`相关概念 <./getting_started/concepts.html>`_" -#: ../../index.rst:42 6d9a0d727ce14edfbdcf678c6fbba76b +#: ../../index.rst:42 d641ad48ed334db983d8906948b4b430 msgid "Coming soon..." -msgstr "未完待续。。。" +msgstr "" -#: ../../index.rst:44 58cdc41dce264a3e83de565501298010 +#: ../../index.rst:44 7b94cd856f154fbe9580d8595e9afe6a msgid "`Tutorials <.getting_started/tutorials.html>`_" msgstr "`教程 <.getting_started/tutorials.html>`_" -#: ../../index.rst:58 20d67b324c23468e8f2cac6d9100b9f5 +#: ../../index.rst:58 eaf73bfa0d484e79b90d4fa1d82d4cf6 msgid "" "These modules are the core abstractions with which we can interact with " "data and environment smoothly." msgstr "这些模块是我们可以与数据和环境顺利地进行交互的核心组成。" - -#: ../../index.rst:59 45a14052370f4860a72d8e831269d184 +#: ../../index.rst:59 4ccf7a955ed241b4ad7b80bef0a3ad59 msgid "" "It's very important for DB-GPT, DB-GPT also provide standard, extendable " "interfaces." msgstr "DB-GPT还提供了标准的、可扩展的接口。" -#: ../../index.rst:61 7c78c2ddc4104a8b9688472072c3225c +#: ../../index.rst:61 93a217c7147f47e6a3917784313c2eb3 msgid "" "The docs for each module contain quickstart examples, how to guides, " "reference docs, and conceptual guides." msgstr "每个模块的文档都包含快速入门的例子、操作指南、参考文档和相关概念等内容。" -#: ../../index.rst:63 4bcc203282434ca9b77d20c4115a646a +#: ../../index.rst:63 1876f94cc11e44d29b4391011c175fd6 msgid "The modules are as follows" msgstr "组成模块如下：" -#: ../../index.rst:65 c87f13e106b5443a824df5ca85331df4 +#: ../../index.rst:65 c5c0bc53b69448389bf94c5b3b0230a1 msgid "" "`LLMs <./modules/llms.html>`_: Supported multi models management and " "integrations." msgstr "`LLMs <./modules/llms.html>`_:基于FastChat提供大模型的运行环境。支持多模型管理和集成。 " -#: ../../index.rst:67 3447e10b61804b48a786ee12beaaedfd +#: ../../index.rst:67 b382b320fdd746e1940b67c0b6ff3d7d msgid "" "`Prompts <./modules/prompts.html>`_: Prompt management, optimization, and" " serialization for multi database." -msgstr "`Prompt自动生成与优化 <./modules/prompts.html>`_: 自动化生成高质量的Prompt" -" ，并进行优化，提高系统的响应效率" +msgstr "" +"`Prompt自动生成与优化 <./modules/prompts.html>`_: 自动化生成高质量的Prompt " +"，并进行优化，提高系统的响应效率" -#: ../../index.rst:69 a3182673127141888fdc13560e7dcfb3 +#: ../../index.rst:69 a2d90f213158420cad5a8d65e8484bbd msgid "`Plugins <./modules/plugins.html>`_: Plugins management, scheduler." msgstr "`Agent与插件： <./modules/plugins.html>`_:提供Agent和插件机制，使得用户可以自定义并增强系统的行为。" -#: ../../index.rst:71 66abfffcb9c0466f9a3988ecfb19fc9e +#: ../../index.rst:71 a39a7a70dda94414b0625a897119795e +#, fuzzy msgid "" -"`Knownledge <./modules/knownledge.html>`_: Knownledge management, " -"embedding, and search." -msgstr "`知识库能力： <./modules/knownledge.html>`_: 支持私域知识库问答能力, " +"`Knowledge <./modules/knowledge.html>`_: Knowledge management, embedding," +" and search." +msgstr "`知识库能力： <./modules/knowledge.html>`_: 支持私域知识库问答能力, " -#: ../../index.rst:73 1027a33646614790a4d88f29285ab0fd +#: ../../index.rst:73 8c93459d2deb4085addb33628e5a6fde msgid "" "`Connections <./modules/connections.html>`_: Supported multi databases " "connection. management connections and interact with this." msgstr "`连接模块 <./modules/connections.html>`_: 用于连接不同的模块和数据源，实现数据的流转和交互 " - -#: ../../index.rst:90 53b58e6e531841878fbc8616841d5e9e +#: ../../index.rst:90 707311d87e294078a093c092dd9e61c8 msgid "Best Practices and built-in implementations for common DB-GPT use cases:" msgstr "DB-GPT用例的最佳实践和内置方法:" -#: ../../index.rst:92 a5c664233fe04417ba9bb0415fd686d7 +#: ../../index.rst:92 71c2be99432b413d928e5b18cbf3abd1 msgid "" "`Sql generation and diagnosis " "<./use_cases/sql_generation_and_diagnosis.html>`_: SQL generation and " "diagnosis." -msgstr "`Sql生成和诊断 " -"<./use_cases/sql_generation_and_diagnosis.html>`_: Sql生成和诊断。" +msgstr "`Sql生成和诊断 <./use_cases/sql_generation_and_diagnosis.html>`_: Sql生成和诊断。" - -#: ../../index.rst:94 04c63b56e77b45e5b4e7bd1db45ea10f +#: ../../index.rst:94 4101e1e6f9354c53addca1e3d07b0234 msgid "" "`knownledge Based QA <./use_cases/knownledge_based_qa.html>`_: A " "important scene for user to chat with database documents, codes, bugs and" " schemas." -msgstr "`知识库问答 <./use_cases/knownledge_based_qa.html>`_: " -"用户与数据库文档、代码和bug聊天的重要场景"。 +msgstr "`知识库问答 <./use_cases/knownledge_based_qa.html>`_: 用户与数据库文档、代码和bug聊天的重要场景\"" -#: ../../index.rst:96 415e2b9f640341a084f893781e2b3ec0 +#: ../../index.rst:96 87ae536fb701462991897494606d4b15 msgid "" "`Chatbots <./use_cases/chatbots.html>`_: Language model love to chat, use" " multi models to chat." msgstr "`聊天机器人 <./use_cases/chatbots.html>`_: 使用多模型进行对话" -#: ../../index.rst:98 59a7ec39d2034fb794a9272d55607122 +#: ../../index.rst:98 bf65b6a3036f4984b2641e3c621d764c msgid "" "`Querying Database Data <./use_cases/query_database_data.html>`_: Query " "and Analysis data from databases and give charts." -msgstr "`查询数据库数据 <./use_cases/query_database_data.html>`_:" -"从数据库中查询和分析数据并给出图表。" +msgstr "`查询数据库数据 <./use_cases/query_database_data.html>`_:从数据库中查询和分析数据并给出图表。" -#: ../../index.rst:100 3bd098eda9044bd39e4bba28a82f4195 +#: ../../index.rst:100 c854edf150624005bd5f62f2e3e0789b msgid "" "`Interacting with apis <./use_cases/interacting_with_api.html>`_: " "Interact with apis, such as create a table, deploy a database cluster, " "create a database and so on." -msgstr "`API交互 <./use_cases/interacting_with_api.html>`_: " +msgstr "" +"`API交互 <./use_cases/interacting_with_api.html>`_: " "与API交互，例如创建表、部署数据库集群、创建数据库等。" - -#: ../../index.rst:102 66daab899d7b4e528eda70779ab79676 +#: ../../index.rst:102 55ed3ed4ec7a45458f6686c437d65e41 msgid "" "`Tool use with plugins <./use_cases/tool_use_with_plugin>`_: According to" " Plugin use tools to manage databases autonomoly." -msgstr "`插件工具 <./use_cases/tool_use_with_plugin>`_:" -" 根据插件使用工具自主管理数据库。" +msgstr "`插件工具 <./use_cases/tool_use_with_plugin>`_: 根据插件使用工具自主管理数据库。" -#: ../../index.rst:119 e5a84e2dc87d4a06aa77ef4d77fb7bcb +#: ../../index.rst:119 e3b12d97d32c4c198a85e052b2a365c7 msgid "" "Full documentation on all methods, classes, installation methods, and " "integration setups for DB-GPT." msgstr "关于DB-GPT的所有方法、类、安装方法和集成设置的完整文档。" -#: ../../index.rst:130 7c51e39ad3824c5f8575390adbcba738 +#: ../../index.rst:130 1b82c35990b84b6bba05fd565ba6c32f msgid "Ecosystem" msgstr "环境系统" -#: ../../index.rst:132 b59e9ddba86945c1bebe395b2863174c +#: ../../index.rst:132 ef97b07c83e7469bba5a8bc36e1ed83f msgid "Guides for how other companies/products can be used with DB-GPT" msgstr "其他公司/产品如何与DB-GPT一起使用的方法指南" -#: ../../index.rst:147 992bf68cc48a425696c02429d39f86e3 +#: ../../index.rst:147 e597de3a7df7460d985c1a30589ce3bb msgid "" "Additional resources we think may be useful as you develop your " "application!" msgstr "“我们认为在您开发应用程序时可能有用的其他资源!”" -#: ../../index.rst:149 d99277006b05438c8d2e8088242f239c +#: ../../index.rst:149 1438b93c57e6459799c5656893c15aa7 msgid "" "`Discord `_: if your have some " "problem or ideas, you can talk from discord." -msgstr "`Discord `_:" -"如果您有任何问题，可以到discord中进行交流。" +msgstr "`Discord `_:如果您有任何问题，可以到discord中进行交流。" diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/connections.po b/docs/locales/zh_CN/LC_MESSAGES/modules/connections.po index 19b52157d..b534e5ba3 100644 --- a/docs/locales/zh_CN/LC_MESSAGES/modules/connections.po +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/connections.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: DB-GPT 0.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2023-06-11 14:10+0800\n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: zh_CN\n" @@ -17,18 +17,33 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.11.0\n" +"Generated-By: Babel 2.12.1\n" -#: ../../modules/connections.md:1 21de23e95a6c4405a242fb9a0f4e5f2b +#: ../../modules/connections.rst:2 ../../modules/connections.rst:10 +#: c9783fd80b0b476abfbf25d4aa23b6ae msgid "Connections" msgstr "连接模块" -#: ../../modules/connections.md:3 0f09b3be20cd409f92c2ba819dbf45eb +#: ../../modules/connections.rst:3 95fecfbcae0e4170affd6a5e41a4fe56 +#, fuzzy msgid "" -"In order to interact more conveniently with users' private environments, " -"the project has designed a connection module, which can support " -"connection to databases, Excel, knowledge bases, and other environments " -"to achieve information and data exchange." -msgstr "为了更方便地与用户的私有环境进行交互，项目设计了一个连接模块，可以支持" -"与数据库、Excel、知识库等环境的连接，实现信息和数据的交换。" +"**In order to interact more conveniently with users' private " +"environments, the project has designed a connection module, which can " +"support connection to databases, Excel, knowledge bases, and other " +"environments to achieve information and data exchange.**" +msgstr "为了更方便地与用户的私有环境进行交互，项目设计了一个连接模块，可以支持与数据库、Excel、知识库等环境的连接，实现信息和数据的交换。" + +#: ../../modules/connections.rst:5 3a5a6124903c4d1fba8a8eb8426616b7 +msgid "" +"DB-GPT provides base class BaseConnect, you can inheriting and implement " +"get_session(), get_table_names(), get_index_info(), get_database_list() " +"and run()." +msgstr "DB-GPT提供了基础连接模块，你可以继承这个类，然后实现get_session(), get_table_names(), get_index_info(), get_database_list() " +"and run()这些方法即可，如果你的数据库是关系型数据库，可以直接继承RDBMSDatabase即可" + +#: ../../modules/connections.rst:7 78ef1226d576458fbd1a9f1043936fc8 +msgid "" +"`mysql_connection <./connections/mysql_connection.html>`_: supported " +"mysql_connection." +msgstr "mysql connection使用方法" diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/connections/mysql/mysql_connection.po b/docs/locales/zh_CN/LC_MESSAGES/modules/connections/mysql/mysql_connection.po new file mode 100644 index 000000000..ba26d7da5 --- /dev/null +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/connections/mysql/mysql_connection.po @@ -0,0 +1,36 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, csunny +# This file is distributed under the same license as the DB-GPT package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: DB-GPT 0.1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: zh_CN\n" +"Language-Team: zh_CN \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../modules/connections/mysql/mysql_connection.md:1 +#: 69e13b9e53ff466c9ec85715741dd938 +msgid "MYSQL Connection" +msgstr "MYSQL连接" + +#: ../../modules/connections/mysql/mysql_connection.md:3 +#: 4b8446fe31204688a87a5cff1180bec1 +msgid "MYSQL can connect mysql server." +msgstr "MYSQL可以连接mysql server" + +#: ../../modules/connections/mysql/mysql_connection.md:5 +#: 5a2141fba4bd41269d4ad73885067e0d +msgid "inheriting the RDBMSDatabase" +msgstr "继承RDBMSDatabase" + diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge.po b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge.po new file mode 100644 index 000000000..c9ee6467b --- /dev/null +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge.po @@ -0,0 +1,98 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, csunny +# This file is distributed under the same license as the DB-GPT package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: DB-GPT 0.1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-14 15:12+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: zh_CN\n" +"Language-Team: zh_CN \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../modules/knowledge.rst:2 ../../modules/knowledge.rst:30 +#: e98ef6095fc54f8f8dc045cfa1733dc2 +msgid "Knowledge" +msgstr "知识" + +#: ../../modules/knowledge.rst:4 51340dd2758e42ee8e96c3935de53438 +#, fuzzy +msgid "" +"As the knowledge base is currently the most significant user demand " +"scenario, we natively support the construction and processing of " +"knowledge bases. At the same time, we also provide multiple knowledge " +"base management strategies in this project, such as pdf knowledge,md " +"knowledge, txt knowledge, word knowledge, ppt knowledge:" +msgstr "由于知识库是当前用户需求最显著的场景，我们原生支持知识库的构建和处理。同时，我们还在本项目中提供了多种知识库管理策略，如:pdf,md " +", txt, word, ppt" + +#: ../../modules/knowledge.rst:7 25eeb187843a4d9baa4d0c0a404eec65 +msgid "**Create your own knowledge repository**" +msgstr "创建你自己的知识库" + +#: ../../modules/knowledge.rst:9 bed8a8f08c194ff59a31dc53f67561c1 +msgid "" +"1.Place personal knowledge files or folders in the pilot/datasets " +"directory." +msgstr "1.将个人知识文件或文件夹放在pilot/datasets目录中。" + +#: ../../modules/knowledge.rst:11 6e03e1a2799a432f8319c3aaf33e2867 +msgid "" +"We currently support many document formats: txt, pdf, md, html, doc, ppt," +" and url." +msgstr "当前支持txt, pdf, md, html, doc, ppt, url文档格式" + +#: ../../modules/knowledge.rst:13 883ebf16fe7f4e1fbc73ef7430104e79 +msgid "before execution: python -m spacy download zh_core_web_sm" +msgstr "在执行之前请先执行python -m spacy download zh_core_web_sm" + +#: ../../modules/knowledge.rst:15 59f4bfa8c1064391919ce2af69f2d4c9 +msgid "" +"2.Update your .env, set your vector store type, VECTOR_STORE_TYPE=Chroma " +"(now only support Chroma and Milvus, if you set Milvus, please set " +"MILVUS_URL and MILVUS_PORT)" +msgstr "2.更新你的.env，设置你的向量存储类型，VECTOR_STORE_TYPE=Chroma(现在只支持Chroma和Milvus，如果你设置了Milvus，请设置MILVUS_URL和MILVUS_PORT)" + +#: ../../modules/knowledge.rst:18 be600a4d93094045b78a43307dfc8f5f +#, fuzzy +msgid "2.Run the knowledge repository script in the tools directory." +msgstr "3.在tools目录执行知识入库脚本" + +#: ../../modules/knowledge.rst:20 b27eddbbf6c74993a6653575f57fff18 +msgid "" +"python tools/knowledge_init.py note : --vector_name : your vector store " +"name default_value:default" +msgstr "" + +#: ../../modules/knowledge.rst:23 f32dc12aedc94ffc8fee77a4b6e0ec88 +msgid "" +"3.Add the knowledge repository in the interface by entering the name of " +"your knowledge repository (if not specified, enter \"default\") so you " +"can use it for Q&A based on your knowledge base." +msgstr "如果选择新增知识库，在界面上新增知识库输入你的知识库名" + +#: ../../modules/knowledge.rst:25 5b1412c8beb24784bd2a93fe5c487b7b +msgid "" +"Note that the default vector model used is text2vec-large-chinese (which " +"is a large model, so if your personal computer configuration is not " +"enough, it is recommended to use text2vec-base-chinese). Therefore, " +"ensure that you download the model and place it in the models directory." +msgstr "" +"注意，这里默认向量模型是text2vec-large-chinese(模型比较大，如果个人电脑配置不够建议采用text2vec-base-" +"chinese),因此确保需要将模型download下来放到models目录中。" + +#: ../../modules/knowledge.rst:27 67773e32b01c48628c80b6fab8c90146 +msgid "" +"`pdf_embedding <./knowledge/pdf_embedding.html>`_: supported pdf " +"embedding." +msgstr "pdf_embedding <./knowledge/pdf_embedding.html>`_: supported pdf embedding." + diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/markdown/markdown_embedding.po b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/markdown/markdown_embedding.po new file mode 100644 index 000000000..7f14a7c1d --- /dev/null +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/markdown/markdown_embedding.po @@ -0,0 +1,55 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, csunny +# This file is distributed under the same license as the DB-GPT package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: DB-GPT 0.1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: zh_CN\n" +"Language-Team: zh_CN \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../modules/knowledge/markdown/markdown_embedding.md:1 +#: b5fd3aea05a64590955b958b753bf22a +msgid "MarkdownEmbedding" +msgstr "MarkdownEmbedding" + +#: ../../modules/knowledge/markdown/markdown_embedding.md:3 +#: 0f98ce5b34d44c6f9c828e4b497984de +msgid "" +"markdown embedding can import md text into a vector knowledge base. The " +"entire embedding process includes the read (loading data), data_process " +"(data processing), and index_to_store (embedding to the vector database) " +"methods." +msgstr "" +"markdown embedding 可以导入md格式的文档到向量数据库， 整个导入过程分为数据读取read(), " +"数据预处理data_process()和数据进向量数据库index_to_store()" + +#: ../../modules/knowledge/markdown/markdown_embedding.md:5 +#: 7f5ebfa8c7c146d7a340baca85634e16 +msgid "inheriting the SourceEmbedding" +msgstr "继承SourceEmbedding" + +#: ../../modules/knowledge/markdown/markdown_embedding.md:17 +#: 732e946bc9d149a5af802b239304b943 +#, fuzzy +msgid "" +"implement read() and data_process() read() method allows you to read data" +" and split data into chunk" +msgstr "实现read方法可以加载数据" + +#: ../../modules/knowledge/markdown/markdown_embedding.md:33 +#: f7e53658aee7403688b333b24ff08ce2 +msgid "data_process() method allows you to pre processing your ways" +msgstr "实现data_process方法可以进行数据预处理" + diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/pdf/pdf_embedding.po b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/pdf/pdf_embedding.po new file mode 100644 index 000000000..df41482f3 --- /dev/null +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/pdf/pdf_embedding.po @@ -0,0 +1,56 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, csunny +# This file is distributed under the same license as the DB-GPT package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: DB-GPT 0.1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: zh_CN\n" +"Language-Team: zh_CN \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../modules/knowledge/pdf/pdf_embedding.md:1 +#: fe600a1f3f9f492da81652ebd3d6d52d +msgid "PDFEmbedding" +msgstr "" + +#: ../../modules/knowledge/pdf/pdf_embedding.md:3 +#: a26a7d6ff041476b975bab5c0bf9f506 +#, fuzzy +msgid "" +"pdfembedding can import PDF text into a vector knowledge base. The entire" +" embedding process includes the read (loading data), data_process (data " +"processing), and index_to_store (embedding to the vector database) " +"methods." +msgstr "" +"pdf embedding 可以导入pdf格式的文档到向量数据库， 整个导入过程分为数据读取read(), " +"数据预处理data_process()和数据进向量数据库index_to_store()" + +#: ../../modules/knowledge/pdf/pdf_embedding.md:5 +#: 1895f2a6272c43f0b328caba092102a9 +msgid "inheriting the SourceEmbedding" +msgstr "继承SourceEmbedding" + +#: ../../modules/knowledge/pdf/pdf_embedding.md:17 +#: 2a4a349398354f9cb3e8d9630a4b8696 +#, fuzzy +msgid "" +"implement read() and data_process() read() method allows you to read data" +" and split data into chunk" +msgstr "实现read方法可以加载数据" + +#: ../../modules/knowledge/pdf/pdf_embedding.md:34 +#: 9b5c6d3e9e96443a908a09a8a762ea7a +msgid "data_process() method allows you to pre processing your ways" +msgstr "实现data_process方法可以进行数据预处理" + diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/ppt/ppt_embedding.po b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/ppt/ppt_embedding.po new file mode 100644 index 000000000..880499e84 --- /dev/null +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/ppt/ppt_embedding.po @@ -0,0 +1,55 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, csunny +# This file is distributed under the same license as the DB-GPT package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: DB-GPT 0.1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: zh_CN\n" +"Language-Team: zh_CN \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../modules/knowledge/ppt/ppt_embedding.md:1 +#: 2cdb249b2b284064a0c9117d051e35d4 +msgid "PPTEmbedding" +msgstr "" + +#: ../../modules/knowledge/ppt/ppt_embedding.md:3 +#: 71676e9b35434a849a206788da8f1394 +msgid "" +"ppt embedding can import ppt text into a vector knowledge base. The " +"entire embedding process includes the read (loading data), data_process " +"(data processing), and index_to_store (embedding to the vector database) " +"methods." +msgstr "" +"ppt embedding 可以导入ppt格式的文档到向量数据库， 整个导入过程分为数据读取read(), " +"数据预处理data_process()和数据进向量数据库index_to_store()" + +#: ../../modules/knowledge/ppt/ppt_embedding.md:5 +#: 016aeae4786e4d5bad815670bd109481 +msgid "inheriting the SourceEmbedding" +msgstr "继承SourceEmbedding" + +#: ../../modules/knowledge/ppt/ppt_embedding.md:17 +#: 2fb5b9dc912342df8c275cfd0e993fe0 +#, fuzzy +msgid "" +"implement read() and data_process() read() method allows you to read data" +" and split data into chunk" +msgstr "实现read方法可以加载数据" + +#: ../../modules/knowledge/ppt/ppt_embedding.md:31 +#: 9a00f72c7ec84bde9971579c720d2628 +msgid "data_process() method allows you to pre processing your ways" +msgstr "实现data_process方法可以进行数据预处理" + diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/url/url_embedding.po b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/url/url_embedding.po new file mode 100644 index 000000000..d7931d3f2 --- /dev/null +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/url/url_embedding.po @@ -0,0 +1,55 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, csunny +# This file is distributed under the same license as the DB-GPT package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: DB-GPT 0.1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: zh_CN\n" +"Language-Team: zh_CN \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../modules/knowledge/url/url_embedding.md:1 +#: e6d335e613ec4c3a80b89de67ba93098 +msgid "URL Embedding" +msgstr "" + +#: ../../modules/knowledge/url/url_embedding.md:3 +#: 25e7643335264bdaaa9386ded243d51d +msgid "" +"url embedding can import PDF text into a vector knowledge base. The " +"entire embedding process includes the read (loading data), data_process " +"(data processing), and index_to_store (embedding to the vector database) " +"methods." +msgstr "" +"url embedding 可以导入url格式的文档到向量数据库， 整个导入过程分为数据读取read(), " +"数据预处理data_process()和数据进向量数据库index_to_store()" + +#: ../../modules/knowledge/url/url_embedding.md:5 +#: 4b8ca6d93ed0412ab1e640bd42b400ac +msgid "inheriting the SourceEmbedding" +msgstr "继承SourceEmbedding" + +#: ../../modules/knowledge/url/url_embedding.md:17 +#: 5d69d27adc70406db97c398a339f6453 +#, fuzzy +msgid "" +"implement read() and data_process() read() method allows you to read data" +" and split data into chunk" +msgstr "实现read方法可以加载数据" + +#: ../../modules/knowledge/url/url_embedding.md:34 +#: 7d055e181d9b4d47965ab249b18bd704 +msgid "data_process() method allows you to pre processing your ways" +msgstr "实现data_process方法可以进行数据预处理" + diff --git a/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/word/word_embedding.po b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/word/word_embedding.po new file mode 100644 index 000000000..72ea187d4 --- /dev/null +++ b/docs/locales/zh_CN/LC_MESSAGES/modules/knowledge/word/word_embedding.po @@ -0,0 +1,55 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, csunny +# This file is distributed under the same license as the DB-GPT package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: DB-GPT 0.1.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language: zh_CN\n" +"Language-Team: zh_CN \n" +"Plural-Forms: nplurals=1; plural=0;\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.12.1\n" + +#: ../../modules/knowledge/word/word_embedding.md:1 +#: 1b3272def692480bb101060a33d076c6 +msgid "WordEmbedding" +msgstr "" + +#: ../../modules/knowledge/word/word_embedding.md:3 +#: a7ea0e94e5c74dab9aa7fb80ed42ed39 +msgid "" +"word embedding can import word doc/docx text into a vector knowledge " +"base. The entire embedding process includes the read (loading data), " +"data_process (data processing), and index_to_store (embedding to the " +"vector database) methods." +msgstr "" +"word embedding 可以导入word格式的doc文档到向量数据库， 整个导入过程分为数据读取read(), " +"数据预处理data_process()和数据进向量数据库index_to_store()" + +#: ../../modules/knowledge/word/word_embedding.md:5 +#: 12ba9527ef0745538dffb6b1dcf96933 +msgid "inheriting the SourceEmbedding" +msgstr "继承SourceEmbedding" + +#: ../../modules/knowledge/word/word_embedding.md:17 +#: a4e5e7553f4a43b0b79ba0de83268ef0 +#, fuzzy +msgid "" +"implement read() and data_process() read() method allows you to read data" +" and split data into chunk" +msgstr "实现read方法可以加载数据" + +#: ../../modules/knowledge/word/word_embedding.md:29 +#: 188a434dee7543f89cf5f1584f29ca62 +msgid "data_process() method allows you to pre processing your ways" +msgstr "实现data_process方法可以进行数据预处理" + diff --git a/docs/locales/zh_CN/LC_MESSAGES/use_cases/sql_generation_and_diagnosis.po b/docs/locales/zh_CN/LC_MESSAGES/use_cases/sql_generation_and_diagnosis.po index b7ab23dfc..fd8918782 100644 --- a/docs/locales/zh_CN/LC_MESSAGES/use_cases/sql_generation_and_diagnosis.po +++ b/docs/locales/zh_CN/LC_MESSAGES/use_cases/sql_generation_and_diagnosis.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: DB-GPT 0.1.0\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2023-06-11 14:10+0800\n" +"POT-Creation-Date: 2023-06-14 14:51+0800\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: zh_CN\n" @@ -17,10 +17,26 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.11.0\n" +"Generated-By: Babel 2.12.1\n" #: ../../use_cases/sql_generation_and_diagnosis.md:1 -#: 8900f8d9f3034b20a96df1d5c611eaa1 +#: f19384aa3b1d4fc2bed3aa94abe80a3c msgid "SQL generation and diagnosis" msgstr "SQL生成和诊断" +#: ../../use_cases/sql_generation_and_diagnosis.md:3 +#: 0aa11c79b20544b9a1376d184f58a516 +msgid "" +"DB-GPT provides SQL generation and diagnostic capabilities. With advanced" +" natural language processing algorithms and a deep understanding of SQL " +"syntax and semantics, the model can generate complex SQL queries from " +"natural language input, as well as diagnose and fix issues with existing " +"queries. This allows users to save time and streamline their workflow, " +"while also improving the accuracy and efficiency of their SQL operations." +msgstr "" + +#: ../../use_cases/sql_generation_and_diagnosis.md:5 +#: ffcbe5278cdc41a7b656f03bf82a8b26 +msgid "[SQL Generation](../../assets/demo_en.gif)" +msgstr "" + diff --git a/docs/modules/connections.md b/docs/modules/connections.md deleted file mode 100644 index 041120d26..000000000 --- a/docs/modules/connections.md +++ /dev/null @@ -1,4 +0,0 @@ -# Connections - -In order to interact more conveniently with users' private environments, the project has designed a connection module, which can support connection to databases, Excel, knowledge bases, and other environments to achieve information and data exchange. - diff --git a/docs/modules/connections.rst b/docs/modules/connections.rst new file mode 100644 index 000000000..96cfa1248 --- /dev/null +++ b/docs/modules/connections.rst @@ -0,0 +1,16 @@ +Connections +--------- +**In order to interact more conveniently with users' private environments, the project has designed a connection module, which can support connection to databases, Excel, knowledge bases, and other environments to achieve information and data exchange.** + +DB-GPT provides base class BaseConnect, you can inheriting and implement get_session(), get_table_names(), get_index_info(), get_database_list() and run(). + +- `mysql_connection <./connections/mysql_connection.html>`_: supported mysql_connection. + + +.. toctree:: + :maxdepth: 2 + :caption: Connections + :name: mysql_connection + :hidden: + + ./connections/mysql/mysql_connection.md \ No newline at end of file diff --git a/docs/modules/connections/mysql/mysql_connection.md b/docs/modules/connections/mysql/mysql_connection.md new file mode 100644 index 000000000..3204aa5db --- /dev/null +++ b/docs/modules/connections/mysql/mysql_connection.md @@ -0,0 +1,18 @@ +MYSQL Connection +================================== +MYSQL can connect mysql server. + +inheriting the RDBMSDatabase +``` +class MySQLConnect(RDBMSDatabase): + """Connect MySQL Database fetch MetaData + Args: + Usage: + """ + + type: str = "MySQL" + dialect: str = "mysql" + driver: str = "pymysql" + + default_db = ["information_schema", "performance_schema", "sys", "mysql"] +``` \ No newline at end of file diff --git a/docs/modules/knowledge.rst b/docs/modules/knowledge.rst new file mode 100644 index 000000000..72b97af98 --- /dev/null +++ b/docs/modules/knowledge.rst @@ -0,0 +1,40 @@ +Knowledge +--------- + +| As the knowledge base is currently the most significant user demand scenario, we natively support the construction and processing of knowledge bases. At the same time, we also provide multiple knowledge base management strategies in this project, such as pdf knowledge,md knowledge, txt knowledge, word knowledge, ppt knowledge: + + +**Create your own knowledge repository** + +1.Place personal knowledge files or folders in the pilot/datasets directory. + +We currently support many document formats: txt, pdf, md, html, doc, ppt, and url. + +before execution: python -m spacy download zh_core_web_sm + +2.Update your .env, set your vector store type, VECTOR_STORE_TYPE=Chroma +(now only support Chroma and Milvus, if you set Milvus, please set MILVUS_URL and MILVUS_PORT) + +2.Run the knowledge repository script in the tools directory. + +python tools/knowledge_init.py +note : --vector_name : your vector store name default_value:default + +3.Add the knowledge repository in the interface by entering the name of your knowledge repository (if not specified, enter "default") so you can use it for Q&A based on your knowledge base. + +Note that the default vector model used is text2vec-large-chinese (which is a large model, so if your personal computer configuration is not enough, it is recommended to use text2vec-base-chinese). Therefore, ensure that you download the model and place it in the models directory. + +- `pdf_embedding <./knowledge/pdf_embedding.html>`_: supported pdf embedding. + + +.. toctree:: + :maxdepth: 2 + :caption: Knowledge + :name: pdf_embedding + :hidden: + + ./knowledge/pdf/pdf_embedding.md + ./knowledge/markdown/markdown_embedding.md + ./knowledge/word/word_embedding.md + ./knowledge/url/url_embedding.md + ./knowledge/ppt/ppt_embedding.md \ No newline at end of file diff --git a/docs/modules/knowledge/markdown/markdown_embedding.md b/docs/modules/knowledge/markdown/markdown_embedding.md new file mode 100644 index 000000000..dfb42c7ff --- /dev/null +++ b/docs/modules/knowledge/markdown/markdown_embedding.md @@ -0,0 +1,42 @@ +MarkdownEmbedding +================================== +markdown embedding can import md text into a vector knowledge base. The entire embedding process includes the read (loading data), data_process (data processing), and index_to_store (embedding to the vector database) methods. + +inheriting the SourceEmbedding + +``` +class MarkdownEmbedding(SourceEmbedding): + """pdf embedding for read pdf document.""" + + def __init__(self, file_path, vector_store_config): + """Initialize with pdf path.""" + super().__init__(file_path, vector_store_config) + self.file_path = file_path + self.vector_store_config = vector_store_config +``` +implement read() and data_process() +read() method allows you to read data and split data into chunk + +``` +@register + def read(self): + """Load from markdown path.""" + loader = EncodeTextLoader(self.file_path) + textsplitter = SpacyTextSplitter( + pipeline="zh_core_web_sm", + chunk_size=CFG.KNOWLEDGE_CHUNK_SIZE, + chunk_overlap=100, + ) + return loader.load_and_split(textsplitter) +``` + +data_process() method allows you to pre processing your ways +``` +@register + def data_process(self, documents: List[Document]): + i = 0 + for d in documents: + documents[i].page_content = d.page_content.replace("\n", "") + i += 1 + return documents +``` \ No newline at end of file diff --git a/docs/modules/knowledge/pdf/pdf_embedding.md b/docs/modules/knowledge/pdf/pdf_embedding.md new file mode 100644 index 000000000..198a5297c --- /dev/null +++ b/docs/modules/knowledge/pdf/pdf_embedding.md @@ -0,0 +1,43 @@ +PDFEmbedding +================================== +pdfembedding can import PDF text into a vector knowledge base. The entire embedding process includes the read (loading data), data_process (data processing), and index_to_store (embedding to the vector database) methods. + +inheriting the SourceEmbedding +``` +class PDFEmbedding(SourceEmbedding): + """pdf embedding for read pdf document.""" + + def __init__(self, file_path, vector_store_config): + """Initialize with pdf path.""" + super().__init__(file_path, vector_store_config) + self.file_path = file_path + self.vector_store_config = vector_store_config +``` + +implement read() and data_process() +read() method allows you to read data and split data into chunk +``` +@register + def read(self): + """Load from pdf path.""" + loader = PyPDFLoader(self.file_path) + # textsplitter = CHNDocumentSplitter( + # pdf=True, sentence_size=CFG.KNOWLEDGE_CHUNK_SIZE + # ) + textsplitter = SpacyTextSplitter( + pipeline="zh_core_web_sm", + chunk_size=CFG.KNOWLEDGE_CHUNK_SIZE, + chunk_overlap=100, + ) + return loader.load_and_split(textsplitter) +``` +data_process() method allows you to pre processing your ways +``` +@register + def data_process(self, documents: List[Document]): + i = 0 + for d in documents: + documents[i].page_content = d.page_content.replace("\n", "") + i += 1 + return documents +``` diff --git a/docs/modules/knowledge/ppt/ppt_embedding.md b/docs/modules/knowledge/ppt/ppt_embedding.md new file mode 100644 index 000000000..e1d7754b9 --- /dev/null +++ b/docs/modules/knowledge/ppt/ppt_embedding.md @@ -0,0 +1,40 @@ +PPTEmbedding +================================== +ppt embedding can import ppt text into a vector knowledge base. The entire embedding process includes the read (loading data), data_process (data processing), and index_to_store (embedding to the vector database) methods. + +inheriting the SourceEmbedding +``` +class PPTEmbedding(SourceEmbedding): + """ppt embedding for read ppt document.""" + + def __init__(self, file_path, vector_store_config): + """Initialize with pdf path.""" + super().__init__(file_path, vector_store_config) + self.file_path = file_path + self.vector_store_config = vector_store_config +``` + +implement read() and data_process() +read() method allows you to read data and split data into chunk +``` +@register + def read(self): + """Load from ppt path.""" + loader = UnstructuredPowerPointLoader(self.file_path) + textsplitter = SpacyTextSplitter( + pipeline="zh_core_web_sm", + chunk_size=CFG.KNOWLEDGE_CHUNK_SIZE, + chunk_overlap=200, + ) + return loader.load_and_split(textsplitter) +``` +data_process() method allows you to pre processing your ways +``` +@register + def data_process(self, documents: List[Document]): + i = 0 + for d in documents: + documents[i].page_content = d.page_content.replace("\n", "") + i += 1 + return documents +``` diff --git a/docs/modules/knowledge/url/url_embedding.md b/docs/modules/knowledge/url/url_embedding.md new file mode 100644 index 000000000..637fa88c0 --- /dev/null +++ b/docs/modules/knowledge/url/url_embedding.md @@ -0,0 +1,47 @@ +URL Embedding +================================== +url embedding can import PDF text into a vector knowledge base. The entire embedding process includes the read (loading data), data_process (data processing), and index_to_store (embedding to the vector database) methods. + +inheriting the SourceEmbedding +``` +class URLEmbedding(SourceEmbedding): + """url embedding for read url document.""" + + def __init__(self, file_path, vector_store_config): + """Initialize with url path.""" + super().__init__(file_path, vector_store_config) + self.file_path = file_path + self.vector_store_config = vector_store_config +``` + +implement read() and data_process() +read() method allows you to read data and split data into chunk +``` +@register + def read(self): + """Load from url path.""" + loader = WebBaseLoader(web_path=self.file_path) + if CFG.LANGUAGE == "en": + text_splitter = CharacterTextSplitter( + chunk_size=CFG.KNOWLEDGE_CHUNK_SIZE, + chunk_overlap=20, + length_function=len, + ) + else: + text_splitter = CHNDocumentSplitter(pdf=True, sentence_size=1000) + return loader.load_and_split(text_splitter) +``` +data_process() method allows you to pre processing your ways +``` +@register + def data_process(self, documents: List[Document]): + i = 0 + for d in documents: + content = d.page_content.replace("\n", "") + soup = BeautifulSoup(content, "html.parser") + for tag in soup(["!doctype", "meta"]): + tag.extract() + documents[i].page_content = soup.get_text() + i += 1 + return documents +``` diff --git a/docs/modules/knowledge/word/word_embedding.md b/docs/modules/knowledge/word/word_embedding.md new file mode 100644 index 000000000..d978bf860 --- /dev/null +++ b/docs/modules/knowledge/word/word_embedding.md @@ -0,0 +1,38 @@ +WordEmbedding +================================== +word embedding can import word doc/docx text into a vector knowledge base. The entire embedding process includes the read (loading data), data_process (data processing), and index_to_store (embedding to the vector database) methods. + +inheriting the SourceEmbedding +``` +class WordEmbedding(SourceEmbedding): + """word embedding for read word document.""" + + def __init__(self, file_path, vector_store_config): + """Initialize with word path.""" + super().__init__(file_path, vector_store_config) + self.file_path = file_path + self.vector_store_config = vector_store_config +``` + +implement read() and data_process() +read() method allows you to read data and split data into chunk +``` +@register + def read(self): + """Load from word path.""" + loader = UnstructuredWordDocumentLoader(self.file_path) + textsplitter = CHNDocumentSplitter( + pdf=True, sentence_size=CFG.KNOWLEDGE_CHUNK_SIZE + ) + return loader.load_and_split(textsplitter) +``` +data_process() method allows you to pre processing your ways +``` +@register + def data_process(self, documents: List[Document]): + i = 0 + for d in documents: + documents[i].page_content = d.page_content.replace("\n", "") + i += 1 + return documents +``` diff --git a/docs/use_cases/chatbots.md b/docs/use_cases/chatbots.md deleted file mode 100644 index 547ae67cc..000000000 --- a/docs/use_cases/chatbots.md +++ /dev/null @@ -1 +0,0 @@ -# Chatbot \ No newline at end of file diff --git a/docs/use_cases/interacting_with_api.md b/docs/use_cases/interacting_with_api.md deleted file mode 100644 index 65f69ed2a..000000000 --- a/docs/use_cases/interacting_with_api.md +++ /dev/null @@ -1 +0,0 @@ -# Interacting with api \ No newline at end of file diff --git a/docs/use_cases/sql_generation_and_diagnosis.md b/docs/use_cases/sql_generation_and_diagnosis.md index f0448edd0..d608ce1ec 100644 --- a/docs/use_cases/sql_generation_and_diagnosis.md +++ b/docs/use_cases/sql_generation_and_diagnosis.md @@ -1 +1,5 @@ -# SQL generation and diagnosis \ No newline at end of file +# SQL generation and diagnosis + +DB-GPT provides SQL generation and diagnostic capabilities. With advanced natural language processing algorithms and a deep understanding of SQL syntax and semantics, the model can generate complex SQL queries from natural language input, as well as diagnose and fix issues with existing queries. This allows users to save time and streamline their workflow, while also improving the accuracy and efficiency of their SQL operations. + +[SQL Generation](../../assets/demo_en.gif) \ No newline at end of file diff --git a/pilot/source_embedding/markdown_embedding.py b/pilot/source_embedding/markdown_embedding.py index 60046d0cd..d8caee959 100644 --- a/pilot/source_embedding/markdown_embedding.py +++ b/pilot/source_embedding/markdown_embedding.py @@ -33,7 +33,7 @@ class MarkdownEmbedding(SourceEmbedding): textsplitter = SpacyTextSplitter( pipeline="zh_core_web_sm", chunk_size=CFG.KNOWLEDGE_CHUNK_SIZE, - chunk_overlap=200, + chunk_overlap=100, ) return loader.load_and_split(textsplitter) diff --git a/pilot/source_embedding/pdf_embedding.py b/pilot/source_embedding/pdf_embedding.py index 87ad9d1cf..dd8c39c03 100644 --- a/pilot/source_embedding/pdf_embedding.py +++ b/pilot/source_embedding/pdf_embedding.py @@ -31,7 +31,7 @@ class PDFEmbedding(SourceEmbedding): textsplitter = SpacyTextSplitter( pipeline="zh_core_web_sm", chunk_size=CFG.KNOWLEDGE_CHUNK_SIZE, - chunk_overlap=200, + chunk_overlap=100, ) return loader.load_and_split(textsplitter)