README

这是一个用于 TextMod API 的 SDK，它允许您轻松地对文本内容进行各种情感上的审查，例如垃圾邮件、仇恨言论和色情。

安装

要使用 TextMod SDK for PHP，您可以在 composer.json 文件中将它添加为依赖项

{
    "require": {
        "textmod/textmod-php": "^8.0"
    }
}

然后，运行 composer install 安装 SDK。

使用方法

要使用 TextMod SDK，您需要从 TextMod 网站 获取 API 认证令牌。一旦您有了它，您就可以创建一个 TextMod 类的实例

<?php

use TextMod\TextMod;

$textmod = new TextMod([
    'authToken' => '<YOUR_AUTH_TOKEN>',
    'filterSentiments' => [
        TextMod::SPAM,
        TextMod::SELF_PROMOTING,
        TextMod::HATE,
        TextMod::TERRORISM,
        TextMod::EXTREMISM,
        TextMod::SELF_HARM
    ]
]);

filterSentiments 选项是可选的，默认为允许所有情感。如果指定，则仅对指定的情感进行审查。

然后，您可以使用审查方法来审查文本内容

<?php

$text = 'Hello world!';
$result = $textmod->moderate($text);
var_dump($result);

moderate 方法返回一个 ModerationResult 对象。您可以通过 ModerationResult 对象的属性访问审查后的情感。

API 文档

TextMod

TextMod 类是此 SDK 的主类。它有一个方法

moderate(string $text): ModerationResult

审查指定的文本并返回一个 ModerationResult 对象。$text 参数是要审查的内容的字符串表示。

ModerationResult

ModerationResult 类表示 moderate 方法返回的结果。它为已审查的每个情感都有布尔属性。

示例

以下是如何使用 TextMod 类的示例

<?php

use TextMod\TextMod;

$textmod = new TextMod([
    'authToken' => '<YOUR_AUTH_TOKEN>',
    'filterSentiments' => [
        TextMod::SPAM,
        TextMod::SELF_PROMOTING,
        TextMod::HATE,
        TextMod::TERRORISM,
        TextMod::EXTREMISM,
        TextMod::SELF_HARM
    ]
]);

$text = 'Hello world!';
$result = $textmod->moderate($text);
// var_dump($result);

贡献

如果您有关于如何改进此 SDK 或想要报告错误的建议，请创建一个问题！我们欢迎社区的贡献。

许可证

此 SDK 根据 MIT 许可证 发布。