From 99c328177f3eef62a583ba9b5e6c211d6993617d Mon Sep 17 00:00:00 2001
From: maninhill <41712985+maninhill@users.noreply.github.com>
Date: Tue, 19 Mar 2024 16:35:25 +0800
Subject: [PATCH] Update README.md
---
README.md | 60 ++++++++++++++++++-------------------------------------
1 file changed, 19 insertions(+), 41 deletions(-)
diff --git a/README.md b/README.md
index e048003ff..767597bf0 100644
--- a/README.md
+++ b/README.md
@@ -1,58 +1,38 @@
-
- 
- 基于大语言模型的知识库问答系统
-
- 
- 
- 
- 
-
+
+基于 LLM 大语言模型的知识库问答系统
+
+
+
+
+
+MaxKB 是一款基于 LLM 大语言模型的知识库问答系统。
-MaxKB（ Max Knowlegde Base 的简称）是一款基于大语言模型的知识库问答系统，其核心目标是利用大语言模型对自然语言理解和生成的能力揣摩用户意图，对原始知识点进行汇总、整合，生成更贴切的答案。
-
-MaxKB 的产品特性：
-- **多模型对接**
-MaxKB 支持对接市场上主流的模型供应商，包括百度千帆大模型、 Azure OpenAI 和 Ollama 私有模型平台等。
-
-- **开箱即用**
-支持一键获取在线文本或直接上传文档，MaxKB 系统自动进行文本拆分、知识向量化；构建应用实现 LLM 问答功能，根据用户提问和知识库内容生成精确回答。
-
-- **无缝集成**
-MaxKB 应用支持零编码集成到企业第三方系统。
+- **多模型**：支持对接主流的大模型，包括本地私有大模型平台（如 Llama 2）、Azure OpenAI 和 百度千帆大模型 等；
+- **开箱即用**：支持直接上传文档、自动爬取在线文档，支持文本自动拆分、向量化，智能问答交互体验好；
+- **无缝嵌入**：支持零编码快速嵌入到第三方业务系统。
## 一键启动
-MaxKB 支持一键启动，仅需执行以下命令：
```
-docker run --name="maxkb" -p 8000:8000 -d ghcr.io/1panel-dev/maxkb
+docker run -d --name=maxkb -p 8000:8000 ghcr.io/1panel-dev/maxkb
```
+也可以通过 [1Panel 应用商店](https://apps.fit2cloud.com/1panel) 快速部署 MaxKB + Ollama（Llama 2），30 分钟内即可上线基于本地大模型的知识库问答系统。
+
## 整体架构
+
-## 实现原理
+## UI 展示
-- 获取本地文档；
-- 读取文本；
-- 文本分割；
-- 文本向量化；
-- Query 向量化；
-- 向量匹配最相似的 TOP N 个文本；
-- 匹配出的文本作为上下文和问题一起添加到 prompt 中；
-- 提交给 LLM 做生成回答。
+TBD
-
+## 微信交流群
-
-
-## 社区
-
-如果您在使用过程中有任何疑问或建议，欢迎提交 GitHub Issue 或到我们官方论坛进行交流沟通：
-
-- [论坛](https://bbs.fit2cloud.com/)
+TBD
## 技术栈
@@ -61,8 +41,6 @@ docker run --name="maxkb" -p 8000:8000 -d ghcr.io/1panel-dev/maxkb
- 中间件：[postgresql](https://www.postgresql.org/)
- 基础设施：[Docker](https://www.docker.com/)
-
-
## License
Copyright (c) 2014-2024 飞致云 FIT2CLOUD, All rights reserved.