Skip to content
/ MaxKB Public
forked from 1Panel-dev/MaxKB

💬 Knowledge base question answering system based on LLM large language model. It works out of the box and supports quick embedding into third-party business systems. It is officially produced by 1Panel.

License

Notifications You must be signed in to change notification settings

lunf/MaxKB

 
 

MaxKB

Based on LLM Big Language Model Knowledge Base Questions System

License: GPL v3 Codacy Latest release Stars Download


This is English version. For the latest updates, please visit the original at:
MaxKB It is based on LLM Big Language Model Knowledge Base Questions System. MaxKB = Max Knowledge Base, It is designed to be the strongest brain of the company.
  • Open the box.:Support for direct upload of documents. Automatic retrieval of online documents, Support text automatic separation. to Quantity. Intelligent Questions Interactive Experience;
  • Smoothly Embedded.:Support zero-coding rapidly embedded into third-party business systems;
  • Multi-Model Support:Supporting large-scale connectivity models, Included Ollama Local private model.(as Llama 2、Llama 3、qwen)、A Thousand Questions、OpenAI、Azure OpenAI、Kimi、Intelligence AI、Starfire and a hundred-thousand-layer model.

Start quickly.

docker run -d --name=maxkb -p 8080:8080 -v ~/.maxkb:/var/lib/postgresql/data 1panel/maxkb

# User Name: admin
# The code: MaxKB@123..

Development

The official guide

Prerequisite

Install Python 3.11

# Add the deadsnakes repository
sudo add-apt-repository ppa:deadsnakes/ppa

# Update package lists
sudo apt update

# Install Python 3.11
sudo apt install python3.11

Enable Python virtual env

# Install the venv package for Python 3.11
sudo apt install python3.11-venv

# Make a folder for venv virtual environments
mkdir ~/.venvs

# Create a new venv virtual environment with Python 3.11 in it
python3.11 -m venv ~/.venvs/my-venv-name

# Activate the new venv
source ~/.venvs/my-venv-name/bin/activate

Exit from the virtual environment

deactivate

Setup peotry

# Install poetry
pipx install poetry

# Install application dependencies
poetry install

# Check install debug
poetry debug info

# Set Python verion
poetry env use 3.11

Update config_example.yml file & rename it to config.yml

Start Backend system

Run Postgres Docker image (equals or above:15.x)

docker compose -f installer/docker-compose-dev.yml up -d

Start main application (python:3.11.x)

poetry python main.py start

You might need to change the following paths

main.py --> looking for HF_HOME --> change it to the source code folder 
apps/smartdoc/const.py --> CONFIG --> abspath('./') --> change it to the source code folder

# config file
EMBEDDING_MODEL_PATH: ./models

# Change cache dir for Tokenizer
apps/common/config/tokenizer_manage_config.py  ---> cache_dir

Start Frontend system

# Frontend code
cd ui

# Node version >= v18.20.2 -->  nvm use v18.20.2 
yarn install

# Start UI app
yarn dev

Inital credentials

# User Name: admin
# The code: MaxKB@123..

UI Showing

MaxKB Demo1 MaxKB Demo2
MaxKB Demo3

Technical Stack

License

Copyright (c) 2014-2024 Flying to the cloud. FIT2CLOUD, All rights reserved.

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.

About

💬 Knowledge base question answering system based on LLM large language model. It works out of the box and supports quick embedding into third-party business systems. It is officially produced by 1Panel.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 56.2%
  • Vue 29.0%
  • TypeScript 11.1%
  • JavaScript 2.1%
  • SCSS 1.2%
  • HTML 0.3%
  • Other 0.1%