larva / think-qcs
腾讯云内容安全(文字图片内容审核)服务
Installs: 5 600
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Requires
- ext-json: *
- intervention/image: ^2.5
- larva/tencentcloud-sdk-php: ^3.0
- topthink/framework: ^6.0
Requires (Dev)
- brainmaestro/composer-git-hooks: ^2.8
- friendsofphp/php-cs-fixer: ^3.0
- mockery/mockery: ^1.2
- orchestra/testbench: ^6.18
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-10-29 06:25:10 UTC
README
T-Sec 天御内容安全服务使用了深度学习技术,识别文本/图片中出现的可能令人反感、不安全或不适宜内容,支持用户配置词库/图片黑名单,识别自定义的识别类型。
Installing
$ composer require larva/think-qcs -vvv
Config
请在 config/services.php
中配置以下内容:
//... // 文字识别服务 'tms' => [ 'secret_id' => env('TMS_SECRET_ID'), 'secret_key' => env('TMS_SECRET_KEY'), 'endpoint' => env('TMS_ENDPOINT'), ], // 图片审核/识别服务 'ims' => [ 'secret_id' => env('IMS_SECRET_ID'), 'secret_key' => env('IMS_SECRET_KEY'), 'endpoint' => env('IMS_ENDPOINT'), ],
API
获取检查结果
调用对应 API 返回数组结果,返回值结构请参考官方 API 文档。
文本
接口请求频率限制:1000次/秒。
use Larva\ThinkQcs\Tms; array Tms::check(string $input);
图片
- 接口请求频率限制:100次/秒。
- 图片检测接口为图片文件内容,大小不能超过5M
- 图片将会缩放成 300*300 后检查
use Larva\ThinkQcs\Ims; array Ims::check(string $contents);
💡
$contents
可以为:图片内容、图片本地路径或 URL。
检查并返回是否通过
use Larva\LaravelQcs\Tms; use Larva\LaravelQcs\Ims; bool Tms::validate(string $contents, string $strategy = 'strict') bool Ims::validate(string $contents, string $strategy = 'strict')
直接替换敏感文本内容
直接将检测到的敏感词替换为 *
:
use Larva\ThinkQcs\Tms; string Tms::mask(string $input, string $char = '*', string $strategy = 'strict'); // 示例: echo Tms::mask('这是敏感内容哦'); // "这是**哦"
在模型中使用
文本校验(CheckTextWithTms)
use think\Model; use Larva\ThinkQcs\Traits\CheckTextWithTms; class Post extends Model { // 文本校验 use CheckTextWithTms; protected array $tmsCheckable = ['name', 'description']; protected string $tmsCheckStrategy = 'strict'; // 可选,默认使用最严格模式 //... }
文本打码(MaskTextWithTms)
检测到敏感内容时不抛出异常,而是替换为 * 号。
use think\Model; use Larva\ThinkQcs\Traits\MaskTextWithTms; class Post extends Model { use MaskTextWithTms; protected $tmsMaskable = ['name', 'description']; protected $tmsMaskStrategy = 'review'; // 开启打码的策略情况,可选,默认使用最严格模式 //... }
配置策略
你可以通过以下方式注册一个或多个自定义校验规则,决定是否通过校验:
// 文字 Tms::setStrategy('strict', function($result) { return $result['Suggestion'] === 'Pass'; }); // 图片 Ims::setStrategy('logo', function($result) { return $result['Suggestion'] === 'Pass'; });
Events
异常处理
验证失败将抛出以下异常:
Larva\ThinkQcs\InvalidTextException
$contents
- (string) 被检测的文本内容$response
- (array) API 原始返回值
Larva\ThinkQcs\InvalidImageException
$response
- (array) API 原始返回值
Contributing
You can contribute in one of three ways:
- File bug reports using the issue tracker.
- Answer questions or fix bugs on the issue tracker.
- Contribute new features or update the wiki.
The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.
PHP 扩展包开发
想知道如何从零开始构建 PHP 扩展包?
请关注我的实战课程,我会在此课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》
License
MIT