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目录下，受版权法律保护。

？感谢我们的贡献者！