mirror of
https://github.com/1Panel-dev/MaxKB.git
synced 2025-12-26 01:33:05 +00:00
130 lines
6.4 KiB
Markdown
130 lines
6.4 KiB
Markdown
<p align="center"><img src= "https://github.com/1Panel-dev/maxkb/assets/52996290/c0694996-0eed-40d8-b369-322bf2a380bf" alt="MaxKB" width="300" /></p>
|
||
<h3 align="center">Ready-to-use, flexible RAG Chatbot</h3>
|
||
<h3 align="center">基于大模型和 RAG 的开源知识库问答系统</h3>
|
||
<p align="center"><a href="https://trendshift.io/repositories/9113" target="_blank"><img src="https://trendshift.io/api/badge/repositories/9113" alt="1Panel-dev%2FMaxKB | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a></p>
|
||
<p align="center">
|
||
<a href="https://www.gnu.org/licenses/gpl-3.0.html#license-text"><img src="https://img.shields.io/github/license/1Panel-dev/maxkb?color=%231890FF" alt="License: GPL v3"></a>
|
||
<a href="https://github.com/1Panel-dev/maxkb/releases/latest"><img src="https://img.shields.io/github/v/release/1Panel-dev/maxkb" alt="Latest release"></a>
|
||
<a href="https://github.com/1Panel-dev/maxkb"><img src="https://img.shields.io/github/stars/1Panel-dev/maxkb?color=%231890FF&style=flat-square" alt="Stars"></a>
|
||
<a href="https://hub.docker.com/r/1panel/maxkb"><img src="https://img.shields.io/docker/pulls/1panel/maxkb?label=downloads" alt="Download"></a><br/>
|
||
[<a href="/README_CN.md">中文(简体)</a>] | [<a href="/README.md">English</a>]
|
||
</p>
|
||
<hr/>
|
||
|
||
MaxKB = Max Knowledge Base, it is a chatbot based on Large Language Models (LLM) and Retrieval-Augmented Generation (RAG). MaxKB is widely applied in scenarios such as intelligent customer service, corporate internal knowledge bases, academic research, and education.
|
||
|
||
- **Ready-to-Use**: Supports direct uploading of documents / automatic crawling of online documents, with features for automatic text splitting, vectorization, and RAG (Retrieval-Augmented Generation). This effectively reduces hallucinations in large models, providing a superior smart Q&A interaction experience.
|
||
- **Flexible Orchestration**: Equipped with a powerful workflow engine and function library, enabling the orchestration of AI processes to meet the needs of complex business scenarios.
|
||
- **Seamless Integration**: Facilitates zero-coding rapid integration into third-party business systems, quickly equipping existing systems with intelligent Q&A capabilities to enhance user satisfaction.
|
||
- **Model-Agnostic**: Supports various large models, including private models (such as DeepSeek, Llama, Qwen, etc.) and public models (like OpenAI, Claude, Gemini, etc.).
|
||
|
||
## Quick start
|
||
|
||
Execute the script below to start a MaxKB container using Docker:
|
||
|
||
```bash
|
||
docker run -d --name=maxkb --restart=always -p 8080:8080 -v ~/.maxkb:/var/lib/postgresql/data -v ~/.python-packages:/opt/maxkb/app/sandbox/python-packages 1panel/maxkb
|
||
```
|
||
|
||
Access MaxKB web interface at `http://your_server_ip:8080` with default admin credentials:
|
||
|
||
- username: admin
|
||
- password: MaxKB@123..
|
||
|
||
中国用户如遇到 Docker 镜像 Pull 失败问题，请参照该 [离线安装文档](https://maxkb.cn/docs/installation/offline_installtion/) 进行安装。
|
||
|
||
## Screenshots
|
||
|
||
<table style="border-collapse: collapse; border: 1px solid black;">
|
||
<tr>
|
||
<td style="padding: 5px;background-color:#fff;"><img src= "https://maxkb.hk/images/overview.png" alt="MaxKB Demo1" /></td>
|
||
<td style="padding: 5px;background-color:#fff;"><img src= "https://maxkb.hk/images/screenshot-models.png" alt="MaxKB Demo2" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td style="padding: 5px;background-color:#fff;"><img src= "https://maxkb.hk/images/screenshot-knowledge.png" alt="MaxKB Demo3" /></td>
|
||
<td style="padding: 5px;background-color:#fff;"><img src= "https://maxkb.hk/images/screenshot-function.png" alt="MaxKB Demo4" /></td>
|
||
</tr>
|
||
</table>
|
||
|
||
## Technical stack
|
||
|
||
- Frontend：[Vue.js](https://vuejs.org/)
|
||
- Backend：[Python / Django](https://www.djangoproject.com/)
|
||
- LLM Framework：[LangChain](https://www.langchain.com/)
|
||
- Database：[PostgreSQL + pgvector](https://www.postgresql.org/)
|
||
|
||
## Feature Comparison
|
||
|
||
MaxKB is positioned as an Ready-to-use RAG (Retrieval-Augmented Generation) intelligent Q&A application, rather than a middleware platform for building large model applications. The following table is merely a comparison from a functional perspective.
|
||
|
||
<table style="width: 100%;">
|
||
<tr>
|
||
<th align="center">Feature</th>
|
||
<th align="center">LangChain</th>
|
||
<th align="center">Dify.AI</th>
|
||
<th align="center">Flowise</th>
|
||
<th align="center">MaxKB <br>（Built upon LangChain）</th>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">Supported LLMs</td>
|
||
<td align="center">Rich Variety</td>
|
||
<td align="center">Rich Variety</td>
|
||
<td align="center">Rich Variety</td>
|
||
<td align="center">Rich Variety</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">RAG Engine</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">Agent</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">❌</td>
|
||
<td align="center">✅</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">Workflow</td>
|
||
<td align="center">❌</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">Observability</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">❌</td>
|
||
<td align="center">✅</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">SSO/Access control</td>
|
||
<td align="center">❌</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">❌</td>
|
||
<td align="center">✅ (Pro)</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center">Local Deployment</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
<td align="center">✅</td>
|
||
</tr>
|
||
</table>
|
||
|
||
## Star History
|
||
|
||
[](https://star-history.com/#1Panel-dev/MaxKB&Date)
|
||
|
||
## License
|
||
|
||
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
|
||
|
||
<https://www.gnu.org/licenses/gpl-3.0.html>
|
||
|
||
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.
|