From dcc039f1ac8c60ee824a03ba9b8e6e9b48731506 Mon Sep 17 00:00:00 2001
From: baixin <52996290+baixin513@users.noreply.github.com>
Date: Tue, 19 Mar 2024 11:20:46 +0800
Subject: [PATCH] Update README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
更新 Readme
---
README.md | 137 ++++++++++++++++++++----------------------------------
1 file changed, 51 insertions(+), 86 deletions(-)
diff --git a/README.md b/README.md
index 069079be8..1915feb9d 100644
--- a/README.md
+++ b/README.md
@@ -1,107 +1,72 @@
-# maxkb
+
+ 基于大语言模型的知识库问答系统
+
+ 
+ 
+ 
+ 
+
+
+
-## 1 项目结构
-!!! Abstract ""
+MaxKB（ Max Knowlegde Base 的简称）是一款基于大语言模型的知识库问答系统，其核心目标是利用大语言模型对自然语言理解和生成的能力揣摩用户意图，对原始知识点进行汇总、整合，生成更贴切的答案。
+MaxKB 的产品特性：
+- **多模型对接**
+MaxKB 支持对接市场上主流的模型供应商，包括百度千帆大模型、 Azure OpenAI 和 Ollama 私有模型平台等。
+
+- **开箱即用**
+支持一键获取在线文本或直接上传文档，MaxKB 系统自动进行文本拆分、知识向量化；构建应用实现 LLM 问答功能，根据用户提问和知识库内容生成精确回答。
+
+- **无缝集成**
+MaxKB 应用支持零编码集成到企业第三方系统。
+
+## 一键启动
+
+MaxKB 支持一键启动，仅需执行以下命令：
```
-.
-├── LICENSE # License 申明
-├── README.md
-├── apps # 后端项目根目录
-│ ├── common # 项目公共资源目录
-│ ├── smartdoc # 项目主目录
-│ ├── users # 用户相关
-│ ├── manage.py # django项目入口
-│ └── sdk # 项目通用的前后端依赖/网关的前端
-├── pyproject.toml # 后端依赖 配置文件
-└── ui # 前端项目根目录
-├── config_example.yml # 项目配置示例
-├── main.py # 项目入口文件 python main.py start 启动项目
+docker run --name="maxkb" -p 8000:8000 -d registry.fit2cloud.com/maxkb/maxkb:v1.0.0
```
-## 2 环境准备
+## 整体架构
-### 1 前端环境准备
+
-- 安装 [node](https://nodejs.org/)
+## 实现原理
-### 2 后端环境准备
+- 获取本地文档；
+- 读取文本；
+- 文本分割；
+- 文本向量化；
+- Query 向量化；
+- 向量匹配最相似的 TOP N 个文本；
+- 匹配出的文本作为上下文和问题一起添加到 prompt 中；
+- 提交给 LLM 做生成回答。
+
+
)
-- 安装 [python](https://www.python.org/downloads/release/python-3115/)
-- 安装 [pycharm](https://www.jetbrains.com/pycharm/download/)
+## 社区
-### 3 开发环境搭建
+如果您在使用过程中有任何疑问或建议，欢迎提交 GitHub Issue 或到我们官方论坛进行交流沟通：
-#### 安装poetry包管理器
+- [论坛](https://bbs.fit2cloud.com/)
-!!! Abstract ""
+## 技术栈
-``` bash
-pip install poetry
-```
+- 前端：[Vue3.js](https://cn.vuejs.org/)、[Element Plus](https://element-plus.org/zh-CN/)、[TypeScript](https://www.tslang.cn/)
+- 后端：[django](https://www.djangoproject.com/)、[langchain](https://www.langchain.com/)
+- 中间件：[postgresql](https://www.postgresql.org/)
+- 基础设施：[Docker](https://www.docker.com/)
-# 3 开发准备
-### 3.2 本地配置
-!!! Abstract ""
-若要项目启动，需要准备配置文件及目录
+## License
-- 准备配置文件
- ```bash
- #将config_example.yml配置文件 目录拷贝至 /opt/maxkb/conf目录下
- cp config_example.yml /opt/maxkb/conf
- ```
- - 配置`/opt/maxkb/conf/config_example.yml`
- ```
- # 邮箱配置
- EMAIL_ADDRESS: xxx
- EMAIL_USE_TLS: False
- EMAIL_USE_SSL: True
- EMAIL_HOST: smtp.qq.com
- EMAIL_PORT: 465
- EMAIL_HOST_USER:
- EMAIL_HOST_PASSWORD:
- # 数据库配置
- DB_NAME: smart-doc
- DB_HOST: localhost
- DB_PORT: 5432
- DB_USER: root
- DB_PASSWORD: xxx
- DB_ENGINE: django.db.backends.postgresql_psycopg2
- ```
+Copyright (c) 2014-2024 飞致云 FIT2CLOUD, All rights reserved.
-# 4 开发调试
+Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
-## 4.1 启动前端项目
+
-先在ui执行安装前端需要的依赖
-
-```bash
-npm install
-```
-
-启动项目
-
-``` bash
-npm run dev
-```
-
-## 启动后端项目
-
-### 4.2 启动后端项目
-
-!!! Abstract ""
-先在根目录执行安装后端需要的依赖
-
-```bash
-poetry install
-```
-
-启动项目
-
-``` bash
-python main.py start
-```
-
\ No newline at end of file
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.