# wordscheck

**Repository Path**: z4zr/wordscheck

## Basic Information

- **Project Name**: wordscheck
- **Description**: 敏感词检测，违禁词过滤，敏感词过滤，敏感词库，一键启动，本地运行，私有化部署，1分钟接入完成，支持docker，支持在线api
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://www.wordscheck.com/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 13
- **Created**: 2023-07-18
- **Last Updated**: 2023-07-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 敏感词检测API - 私有化部署
提供文本识别、智能鉴黄、敏感词过滤、涉政检测等服务，

可部署至「本地服务器」或「专有云服务器」，保障数据私密性，提供一键启动软件部署包私有化。

『开箱即用的检测服务』


## ChatGPT类产品的搭档
+ 检测功能可用于：应用提审上架、主管部门审核、云服务商巡查、对手举报
+ 可以部署到：中国香港、新加坡、日本、美国、韩国、西班牙 等
+ 支持各类云服务器：阿里云、腾讯云、亚马逊云、华为云 等


## 简介
+ 敏感词库从大量词条中整理出来，基于NLP算法检测
+ 支持Windows、MacOs、Linux等64位主流系统
+ 可以部署在本地服务器，或部署到阿里云、腾讯云、华为云、百度云等云服务器
+ 通过下载部署包，即可一键启动私有化的"敏感词检测 API服务"
+ 支持自动云更新最新词库
+ 支持http json方式或grpc方式查询
+ 单服务参考查询效率70000次/分钟，同时支持并行服务
+ 支持自定义添加文本白名单/黑名单
+ 服务运行内存100M左右，非常轻便


## 应用场景
+ 昵称简介、聊天消息、直播弹幕、评论留言、商品详情、AI智能问答 等内容合规检测过滤
+ 境外产品 内容合规需要


## 演示地址
[坚果墙在线敏感词检测]


## 快速接入文档
[文档地址]

##  敏感词分类
![avatar](classify.png)

##  部署(Linux环境示例)
1. 下载*svc*文件夹到服务器，运行
```shell
[root@localhost svc]# ls
blacklist.txt  config.ini  whitelist.txt  wordscheck
[root@localhost svc]# ./wordscheck
```

2. curl测试下服务
```shell
[root@localhost ~]# curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d "{\"content\":\"他在传播艳情内容\"}" http://localhost:8080/wordscheck
```

curl结果
```json
{
	"code": "0",
	"msg": "检测成功",
	"return_str": "他在传播**内容",
	"word_list": [{
		"keyword": "艳情",
		"category": "色情",
		"position": "4-5",
		"level": "高"
	}]
}
```

config.ini  配置文件

Windows、MacOs部署基本相同

| **运行文件**  | **环境说明**  |
| ------------ | ------------ |
| wordscheck | Linux环境，常用的服务器x86_64、amd64 |
| wordscheck_arm64 | Linux环境，aarch64、arm64的服务器 |
| wordscheck_win.exe | Windows环境 |
| wordscheck_mac_arm64 | MacOs环境，m1、m2芯片的电脑 |
| wordscheck_mac | MacOs环境，intel芯片的电脑 |

##  http方式查询
代码示例目录`example/http/`

##  rpc方式查询
代码示例目录`example/rpc/`

### 如何调整服务中的敏感词？
blacklist.txt：黑名单，追加新的敏感词到检测服务中

whitelist.txt：白名单，从检测服务中排除某些敏感词

##  Docker方式部署
修改Dockerfile，调整系统环境、执行文件；配置config.ini

通过Dockerfile，自行build镜像

`docker build -t 镜像名字 .`

运行容器

`docker run -p 8080:8080 -d 镜像名字`



[坚果墙在线敏感词检测]:https://www.wordscheck.com
[文档地址]:https://doc.wordscheck.com/docs/docs