openkf

OpenKF（開放知識流）是一種在線智能客戶服務系統。配x

英語•中文

？很棒的功能

1. OpenKF是基於OpenIm的OpenSource客戶服務系統。
2. 支持LLM（本地知識庫）客戶服務。
3. 支持多通道客戶服務，並易於與第三方系統集成。
4. 易於部署和次要發展。

系統預覽

登錄頁面

配置頁

儀表板頁面

平台頁面

會話頁

？快速開始

注意：您可以使用OpenKF快速開始。

？安裝

git clone https://github.com/openimsdk/openkf openkf && export openkf= $( pwd ) /openkf && cd $openkf && make

跑步

注意：我們需要首先運行後端服務器

make build

打開另一個終端運行以下命令

 # make dev
cd web
npm run dev

貢獻者提高速度

擅長使用MakeFile，它可以確保您的項目質量。

Usage: make < TARGETS > ...

Targets:
  all                          Build all the necessary targets. 
  build                        Build binaries by default. 
  go.build                     Build the binary file of the specified platform. ?‍
  build-multiarch              Build binaries for multiple platforms. ?
  tidy                         tidy go.mod ?
  style                        Code style - > fmt,vet,lint ?
  fmt                          Run go fmt against code. 
  vet                          Run go vet against code. ?
  generate                     Run go generate against code and docs. ✅
  lint                         Run go lint against code. ?
  test                         Run unit test ✔️
  cover                        Run unit test with coverage. ?
  docker-build                 Build docker image with the manager. ?
  docker-push                  Push docker image with the manager. ?
  docker-buildx-push           Push docker image with the manager using buildx. ?
  copyright-verify             Validate boilerplate headers for assign files. ?
  copyright-add                Add the boilerplate headers for all files. 
  swagger                      Generate swagger document. 
  serve-swagger                Serve swagger spec and docs. 
  clean                        Clean all builds. ?
  help                         Show this help info. 

注意：強烈建議您在進行代碼之前運行make all 。

make all

？建築圖

MVC架構設計：

？文件目錄說明

目錄標準化設計結構：

 .
├── assets
│   └── images
├── build
├── deploy
├── docs
├── kf_plugins # Local knowledgebase with LLM
│   ├── chat
│   ├── config
│   ├── data
│   ├── logs
│   ├── model
│   └── utils
├── scripts
│   ├── githooks
│   └── LICENSE
├── server # OpenKF backend
│   ├── cmd
│   ├── data
│   ├── docs
│   ├── examples
│   ├── internal
│   ├── logs
│   ├── pkg
│   ├── test
│   └── tools
└── web # OpenKF frontend
    ├── public
    ├── scripts
    └── src

？社區會議

我們希望任何人參與我們的社區，我們提供禮物和獎勵，歡迎您每個星期四晚上加入我們。

我們的會議在OpenIm Slack openkf管道中，然後您可以搜索OpenKF管道以加入

我們在Github討論中進行每兩週一次的每兩週會議記錄，我們的會議記錄是在Google文檔中寫的。

？‍貢獻與發展

Openimsdk我們的目標是建立一個頂級開源社區。我們在社區存儲庫中有一套標準。

如果您想為此OpenKF存儲庫做出貢獻，請閱讀我們的撰稿人文檔。

在開始之前，請確保您的更改需求。最好的是創建一個新的討論或鬆弛溝通，或者如果發現問題，請先報告。

加入我們的微信開發商組

添加為朋友，並包括Note openkf ，以收到我們“ OpenKF”開發人員'組聊天的邀請。

執照

OpenKF已獲得Apache 2.0許可證的許可。有關完整許可文本，請參見許可證。

OpenKF徽標（包括其變體和動畫版本）在此存儲庫OpenKF中顯示在資產/徽標和資產/徽標GIF目錄下，受版權法律保護。

？感謝我們的貢獻者！