Skip to content

Commit

Permalink
docs: Add vector connector docs (eosphoros-ai#229)
Browse files Browse the repository at this point in the history
Add vector docs,  provide how to use vector connector in DB-GPT.

Closes eosphoros-ai#229
  • Loading branch information
csunny authored Jun 15, 2023
2 parents 7ec8875 + 6228b78 commit 6e4a985
Show file tree
Hide file tree
Showing 7 changed files with 226 additions and 49 deletions.
4 changes: 2 additions & 2 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
[**English**](README.md)|[**Discord**](https://discord.gg/ea6BnZkY) |[**Documents**](https://db-gpt.readthedocs.io/projects/db-gpt-docs-zh-cn/zh_CN/latest/)
</div>


## DB-GPT 是什么?

随着大模型的发布迭代,大模型变得越来越智能,在使用大模型的过程当中,遇到极大的数据安全与隐私挑战。在利用大模型能力的过程中我们的私密数据跟环境需要掌握自己的手里,完全可控,避免任何的数据隐私泄露以及安全风险。基于此,我们发起了DB-GPT项目,为所有以数据库为基础的场景,构建一套完整的私有大模型解决方案。 此方案因为支持本地部署,所以不仅仅可以应用于独立私有环境,而且还可以根据业务模块独立部署隔离,让大模型的能力绝对私有、安全、可控。

DB-GPT 是一个开源的以数据库为基础的GPT实验项目,使用本地化的GPT大模型与您的数据和环境进行交互,无数据泄露风险,100% 私密,100% 安全。

DB-GPT 是一个开源的以数据库为基础的GPT实验项目,使用本地化的GPT大模型与您的数据和环境进行交互,无数据泄露风险,100% 私密

[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&timestamp=1686307943&unique_k=bhO3lgQ&up_id=31375446)

Expand Down
4 changes: 0 additions & 4 deletions docs/getting_started/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

This tutorial gives you a quick walkthrough about use DB-GPT with you environment and data.

<figure class="video_container">
<iframe src="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&timestamp=1686307943&unique_k=bhO3lgQ&up_id=31375446" frameborder="0" allowfullscreen="true" height=600 width=800></iframe>
</figure>

## Installation

To get started, install DB-GPT with the following steps.
Expand Down
3 changes: 3 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ It's very important for DB-GPT, DB-GPT also provide standard, extendable interfa

- `Connections <./modules/connections.html>`_: Supported multi databases connection. management connections and interact with this.

- `Vector <./modules/vector.html>`_: Supported multi vector database.

.. toctree::
:maxdepth: 2
:caption: Modules
Expand All @@ -83,6 +85,7 @@ It's very important for DB-GPT, DB-GPT also provide standard, extendable interfa
./modules/plugins.md
./modules/connections.rst
./modules/knowledge.rst
./modules/vector.rst

Use Cases
---------
Expand Down
91 changes: 48 additions & 43 deletions docs/locales/zh_CN/LC_MESSAGES/index.po
Original file line number Diff line number Diff line change
Expand Up @@ -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-14 14:51+0800\n"
"POT-Creation-Date: 2023-06-15 21:28+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: zh_CN\n"
Expand All @@ -19,31 +19,31 @@ msgstr ""
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.12.1\n"

#: ../../index.rst:34 ../../index.rst:45 558ad9c9fc2240589fabce35463ca24c
#: ../../index.rst:34 ../../index.rst:45 ff89e1093f974141a3791696a8f007d1
msgid "Getting Started"
msgstr "开始"

#: ../../index.rst:56 ../../index.rst:75 abd248b06ac142a68a89e0fb7e477536
#: ../../index.rst:56 ../../index.rst:77 3ad12bad060f4210a83433b58b133491
msgid "Modules"
msgstr "模块"

#: ../../index.rst:88 ../../index.rst:104 e046db82aa5845598b373ca1b9a73ec2
#: ../../index.rst:91 ../../index.rst:107 4a6ebbeaf13b4f3ca3d3e7f7efc87a53
msgid "Use Cases"
msgstr "示例"

#: ../../index.rst:118 ../../index.rst:121 e6fbf08bf59b48afb4ac3f479d88256b
#: ../../index.rst:121 ../../index.rst:124 fc6d9b2ac37d4a72908c520487971641
msgid "Reference"
msgstr "参考"

#: ../../index.rst:145 ../../index.rst:151 03496f75357d4b4d9fd721516faa5e54
#: ../../index.rst:148 ../../index.rst:154 39ceeafdcf364920b861bf8c7e3ffc96
msgid "Resources"
msgstr "资源"

#: ../../index.rst:7 e0764d3d816244b4bf047032c1a28760
#: ../../index.rst:7 5d163c8c53014c9baedf15446369e44b
msgid "Welcome to DB-GPT!"
msgstr "欢迎来到DB-GPT中文文档"

#: ../../index.rst:8 a3500e3f721348ce859c7c774b59b41a
#: ../../index.rst:8 ca0d68c8a51b42aa887fb6df9573817c
msgid ""
"As large models are released and iterated upon, they are becoming "
"increasingly intelligent. However, in the process of using large models, "
Expand All @@ -61,7 +61,7 @@ msgstr ""
",我们启动了DB-"
"GPT项目,为所有基于数据库的场景构建一个完整的私有大模型解决方案。该方案“”支持本地部署,既可应用于“独立私有环境”,又可根据业务模块进行“独立部署”和“隔离”,确保“大模型”的能力绝对私有、安全、可控。"

#: ../../index.rst:10 a8d66309ae5244d88b3c599a5ff97137
#: ../../index.rst:10 fbf09f8fd0d542a4b60df422616bfd46
msgid ""
"**DB-GPT** is an experimental open-source project that uses localized GPT"
" large models to interact with your data and environment. With this "
Expand All @@ -71,155 +71,160 @@ msgstr ""
"DB-GPT 是一个开源的以数据库为基础的GPT实验项目,使用本地化的GPT大模型与您的数据和环境进行交互,无数据泄露风险100% 私密,100%"
" 安全。"

#: ../../index.rst:12 806ae939ad9349ccb4375a236cbaf418
#: ../../index.rst:12 25fc1d7c06a2475bbf8832f1f586c298
msgid "**Features**"
msgstr "特性"

#: ../../index.rst:13 abd6265d37a64b00939e9c0a78f11a5e
#: ../../index.rst:13 70fdcc9161f84fa189a355cb4c9d396d
msgid ""
"Currently, we have released multiple key features, which are listed below"
" to demonstrate our current capabilities:"
msgstr "目前我们已经发布了多种关键的特性,这里一一列举展示一下当前发布的能力。"

#: ../../index.rst:15 6484ed0d92654283a7cbee6cb6b54821
#: ../../index.rst:15 4820bb3c60a5422d9779ab59c21c1dd7
msgid "SQL language capabilities - SQL generation - SQL diagnosis"
msgstr "SQL语言能力 - SQL生成 - SQL诊断"

#: ../../index.rst:19 0d7ef0cf6ec649e5a9c7e076bc30ca1a
#: ../../index.rst:19 4e9555aa81f344eb8b5ee4668cbb17a8
msgid ""
"Private domain Q&A and data processing - Database knowledge Q&A - Data "
"processing"
msgstr "私有领域问答与数据处理 - 数据库知识问答 - 数据处理"

#: ../../index.rst:23 83d1fc0f88cc42bca5206c4b9915ce65
#: ../../index.rst:23 4ea169e9aa5f4bef9084ff512346f80b
msgid ""
"Plugins - Support custom plugin execution tasks and natively support the "
"Auto-GPT plugin, such as:"
msgstr "插件模型 - 支持自定义插件执行任务,并原生支持Auto-GPT插件,例如:* SQL自动执行,获取查询结果 * 自动爬取学习知识"

#: ../../index.rst:26 7790cb466b1d455298d5eaa7582fc5ed
#: ../../index.rst:26 8ad0cae06f134260a8f8e07839959f7a
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 7354784dc4ba494e82f5d3acaac7730b
#: ../../index.rst:29 62c34be5a1424c3193fb91ec1180f1e0
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)"

#: ../../index.rst:35 8598e71986834a24aa390603b84288d1
#: ../../index.rst:35 09be6ef241304499a2554f07884d0263
msgid ""
"How to get started using DB-GPT to interact with your data and "
"environment."
msgstr "开始使用DB-GPT与您的数据环境进行交互。"

#: ../../index.rst:36 8685d294df2040d294523c068969a966
#: ../../index.rst:36 03445e990cf9450b9fef7b05ee1f53ae
msgid "`Quickstart Guid <./getting_started/getting_started.html>`_"
msgstr "`使用指南 <./getting_started/getting_started.html>`_"

#: ../../index.rst:38 bd33c376f4d54a24957cdbd86ac969f1
#: ../../index.rst:38 dfb38d03edec4b968341deca703c680f
msgid "Concepts and terminology"
msgstr "相关概念"

#: ../../index.rst:40 2e9ac1f015bf4d37b0b76de94a831f5b
#: ../../index.rst:40 25896d39991445a9baaa7317995e7486
msgid "`Concepts and terminology <./getting_started/concepts.html>`_"
msgstr "`相关概念 <./getting_started/concepts.html>`_"

#: ../../index.rst:42 d641ad48ed334db983d8906948b4b430
#: ../../index.rst:42 c721cee2fa044ea9b0201e760e0fe336
msgid "Coming soon..."
msgstr ""

#: ../../index.rst:44 7b94cd856f154fbe9580d8595e9afe6a
#: ../../index.rst:44 815a4ab192ce4fc891c5358bdd28d3f7
msgid "`Tutorials <.getting_started/tutorials.html>`_"
msgstr "`教程 <.getting_started/tutorials.html>`_"

#: ../../index.rst:58 eaf73bfa0d484e79b90d4fa1d82d4cf6
#: ../../index.rst:58 465b205162a645b5a52d42884b4eee16
msgid ""
"These modules are the core abstractions with which we can interact with "
"data and environment smoothly."
msgstr "这些模块是我们可以与数据和环境顺利地进行交互的核心组成。"

#: ../../index.rst:59 4ccf7a955ed241b4ad7b80bef0a3ad59
#: ../../index.rst:59 f982a6c162864f59baf528d5fb2d7c09
msgid ""
"It's very important for DB-GPT, DB-GPT also provide standard, extendable "
"interfaces."
msgstr "DB-GPT还提供了标准的、可扩展的接口。"

#: ../../index.rst:61 93a217c7147f47e6a3917784313c2eb3
#: ../../index.rst:61 58b9c18db1f44a7c81c472ad44757f38
msgid ""
"The docs for each module contain quickstart examples, how to guides, "
"reference docs, and conceptual guides."
msgstr "每个模块的文档都包含快速入门的例子、操作指南、参考文档和相关概念等内容。"

#: ../../index.rst:63 1876f94cc11e44d29b4391011c175fd6
#: ../../index.rst:63 7c2cf06512664b4baaa132e6f5bad325
msgid "The modules are as follows"
msgstr "组成模块如下:"

#: ../../index.rst:65 c5c0bc53b69448389bf94c5b3b0230a1
#: ../../index.rst:65 28f01f96cfef4900a8f87d3b9c730963
msgid ""
"`LLMs <./modules/llms.html>`_: Supported multi models management and "
"integrations."
msgstr "`LLMs <./modules/llms.html>`_:基于FastChat提供大模型的运行环境。支持多模型管理和集成。 "

#: ../../index.rst:67 b382b320fdd746e1940b67c0b6ff3d7d
#: ../../index.rst:67 7815ccc422c645ecbf93f046f6a89e45
msgid ""
"`Prompts <./modules/prompts.html>`_: Prompt management, optimization, and"
" serialization for multi database."
msgstr ""
"`Prompt自动生成与优化 <./modules/prompts.html>`_: 自动化生成高质量的Prompt "
",并进行优化,提高系统的响应效率"

#: ../../index.rst:69 a2d90f213158420cad5a8d65e8484bbd
#: ../../index.rst:69 613c6a4afd2343cfb8d6ba0513c4d705
msgid "`Plugins <./modules/plugins.html>`_: Plugins management, scheduler."
msgstr "`Agent与插件: <./modules/plugins.html>`_:提供Agent和插件机制,使得用户可以自定义并增强系统的行为。"

#: ../../index.rst:71 a39a7a70dda94414b0625a897119795e
#: ../../index.rst:71 4d7f447adcfb41449f1cde3e0d860cbd
#, fuzzy
msgid ""
"`Knowledge <./modules/knowledge.html>`_: Knowledge management, embedding,"
" and search."
msgstr "`知识库能力: <./modules/knowledge.html>`_: 支持私域知识库问答能力, "

#: ../../index.rst:73 8c93459d2deb4085addb33628e5a6fde
#: ../../index.rst:73 a0528c0588594dfe8292e3615ea14def
msgid ""
"`Connections <./modules/connections.html>`_: Supported multi databases "
"connection. management connections and interact with this."
msgstr "`连接模块 <./modules/connections.html>`_: 用于连接不同的模块和数据源,实现数据的流转和交互 "

#: ../../index.rst:90 707311d87e294078a093c092dd9e61c8
#: ../../index.rst:75 187e08a3ce5c4eee8d7a1a4080e7cc5b
#, fuzzy
msgid "`Vector <./modules/vector.html>`_: Supported multi vector database."
msgstr "`LLMs <./modules/llms.html>`_:基于FastChat提供大模型的运行环境。支持多模型管理和集成。 "

#: ../../index.rst:93 ba66ec10385441659843b79176113d8d
msgid "Best Practices and built-in implementations for common DB-GPT use cases:"
msgstr "DB-GPT用例的最佳实践和内置方法:"

#: ../../index.rst:92 71c2be99432b413d928e5b18cbf3abd1
#: ../../index.rst:95 4b0c8553d1174cec9b901307600fe6f8
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生成和诊断。"

#: ../../index.rst:94 4101e1e6f9354c53addca1e3d07b0234
#: ../../index.rst:97 2d58029f77d64f41aeb5edf80f3a15a0
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聊天的重要场景\""

#: ../../index.rst:96 87ae536fb701462991897494606d4b15
#: ../../index.rst:99 9945fb5cd8264a2b9b4a23c7cbf9c4d6
msgid ""
"`Chatbots <./use_cases/chatbots.html>`_: Language model love to chat, use"
" multi models to chat."
msgstr "`聊天机器人 <./use_cases/chatbots.html>`_: 使用多模型进行对话"

#: ../../index.rst:98 bf65b6a3036f4984b2641e3c621d764c
#: ../../index.rst:101 79878fc3a54244f78d030555e8df903c
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>`_:从数据库中查询和分析数据并给出图表。"

#: ../../index.rst:100 c854edf150624005bd5f62f2e3e0789b
#: ../../index.rst:103 54280881381a49b6838bc2bf52bc5e35
msgid ""
"`Interacting with apis <./use_cases/interacting_with_api.html>`_: "
"Interact with apis, such as create a table, deploy a database cluster, "
Expand All @@ -228,33 +233,33 @@ msgstr ""
"`API交互 <./use_cases/interacting_with_api.html>`_: "
"与API交互,例如创建表、部署数据库集群、创建数据库等。"

#: ../../index.rst:102 55ed3ed4ec7a45458f6686c437d65e41
#: ../../index.rst:105 e9f9a28795d447b0a6cc4f7d1a42b4b5
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>`_: 根据插件使用工具自主管理数据库。"

#: ../../index.rst:119 e3b12d97d32c4c198a85e052b2a365c7
#: ../../index.rst:122 ce9606638e9d407e9d922f8548a9629f
msgid ""
"Full documentation on all methods, classes, installation methods, and "
"integration setups for DB-GPT."
msgstr "关于DB-GPT的所有方法、类、安装方法和集成设置的完整文档。"

#: ../../index.rst:130 1b82c35990b84b6bba05fd565ba6c32f
#: ../../index.rst:133 474ac86db3154a35bad4ae3e0a1f94a1
msgid "Ecosystem"
msgstr "环境系统"

#: ../../index.rst:132 ef97b07c83e7469bba5a8bc36e1ed83f
#: ../../index.rst:135 215a8df681a7487da420798507882bf4
msgid "Guides for how other companies/products can be used with DB-GPT"
msgstr "其他公司/产品如何与DB-GPT一起使用的方法指南"

#: ../../index.rst:147 e597de3a7df7460d985c1a30589ce3bb
#: ../../index.rst:150 57c73e56c1ec4df7922e8d45bba32b52
msgid ""
"Additional resources we think may be useful as you develop your "
"application!"
msgstr "“我们认为在您开发应用程序时可能有用的其他资源!”"

#: ../../index.rst:149 1438b93c57e6459799c5656893c15aa7
#: ../../index.rst:152 2bcbdab6b08b4280b7178bce430c3f48
msgid ""
"`Discord <https://discord.com/invite/twmZk3vv>`_: if your have some "
"problem or ideas, you can talk from discord."
Expand Down
66 changes: 66 additions & 0 deletions docs/locales/zh_CN/LC_MESSAGES/modules/vector.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2023, csunny
# This file is distributed under the same license as the DB-GPT package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: DB-GPT 👏👏 0.2.2\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-06-15 21:28+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: zh_CN\n"
"Language-Team: zh_CN <[email protected]>\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/vector.rst:2 ../../modules/vector.rst:16
#: 717d29faf59845cc86e24c343d574685
msgid "VectorConnector"
msgstr "VectorConnector"

#: ../../modules/vector.rst:4 18436a753b2c4d4199318383faa226f0
msgid "**VectorConnector Introduce**"
msgstr "VectorConnector介绍"

#: ../../modules/vector.rst:6 8bc42e668949407280d033cadcc898c8
msgid ""
"vector knowledge base is a method of mapping words in language to a high-"
"dimensional vector space. In the vector space, each word is represented "
"as a vector that contains many numerical features, which represent the "
"relationship between the word and other words. This mapping is a "
"clustering technique, and the semantic relationship between words can be "
"calculated by computing the differences between their vectors in the "
"vector space. Vector knowledge bases can be used for natural language "
"processing tasks such as sentiment analysis, text classification, and "
"machine translation. Common vector knowledge bases include Word2Vec, "
"GloVe, and FastText. The training of these vector knowledge bases usually"
" requires a large corpus and computing resources to complete."
msgstr "向量知识库是一种将语言中的单词映射到一个高维向量空间中的方法。在向量空间中,每个单词都表示为一个向量,这个向量包含了许多数值特征,这些特征代表了该单词与其他单词之间的关系。这种映射是一种聚类技术,通过将语言中的单词映射到向量空间中,单词之间的语义关系可以通过计算它们在向量空间中的差异来计算。向量知识库可以用于自然语言处理任务,如情感分析、文本分类、机器翻译等。常见的向量知识库有Word2Vec、GloVe、FastText等。这些向量知识库的训练通常需要大量的语料库和计算资源来完成。"

#: ../../modules/vector.rst:8 0be8cf38ca00436dac74a462f438940d
msgid ""
"VectorConnector is a vector database connection adapter that allows you "
"to connect different vector databases and abstracts away implementation "
"differences and underlying details of different vector data. For example,"
" it can be used to connect to databases such as Milvus, Chroma, "
"Elasticsearch, and Weaviate."
msgstr "vectorconnector是一个向量数据库连接适配器,你可以通过它来连接不同的向量数据库,并且屏蔽掉了不同的向量数据的是实现差异和底层细节。例如Milvus, Chroma, Elasticsearch, Weaviate..."

#: ../../modules/vector.rst:10 4d359cf0cf254b9392e9d3b963bc1071
msgid "DB-GPT VectorConnector currently support milvus and chroma vector database"
msgstr "DB-GPT VectorConnector当前支持Milvus和Chroma,未来会越来越多."

#: ../../modules/vector.rst:12 60809c6ecbb64cc8888b9dc2f9de398a
msgid "`Chroma <./vector/chroma.html>`_: supported chroma vector database."
msgstr "msgid "`Chroma <./vector/chroma.html>`_: 支持Chroma向量数据库"

#: ../../modules/vector.rst:13 e24aeb84d75741fe9517a0d5ec5d92f1
msgid "`Milvus <./vector/milvus.html>`_: supported milvus vector database."
msgstr "Milvus <./vector/milvus.html>`_: 支持Milvus向量数据库"

Loading

0 comments on commit 6e4a985

Please sign in to comment.