README

一个用于 Koko Keywords API 的 PHP 客户端。客户端处理缓存以确保非常低的延迟。

安装

确保已安装 php ffi 模块

在 php.ini 中启用扩展

extension=ffi

安装 php 模块

安装模块

composer require koko/koko-keywords

用法

将 KOKO_KEYWORDS_AUTH 环境变量设置为 Koko 提供的认证字符串。要获取 API 密钥，请完成我们的注册表单。

export KOKO_KEYWORDS_AUTH=username:password

导入模块

include 'vendor/autoload.php';

use Koko\Keywords;

$koko_keywords = new Keywords();

您可能需要根据您的配置在 PHP 中设置环境变量

include 'vendor/autoload.php';

putenv("KOKO_KEYWORDS_AUTH=username:password")
use Koko\Keywords;

$koko_keywords = new Keywords();

建议您仅实例化一次，以最小化加载库的开销。

然后使用 match 函数来检查查询提示是否与风险关键词匹配。该函数返回一个 bool 值，表示是否匹配。如果存在问题，该函数将抛出异常。

if ($koko_keywords->match("some value", "") {
  // Code if there is a match
}

有一个可选参数，filter，如果您不使用它，请将其设置为空字符串。

过滤

使用以冒号分隔的“dimension=value”过滤器的列表根据分类法过滤关键词。省略维度则不按该维度过滤，例如。

$koko_keywords->match("sewerslide", "category=eating,parenting:confidence=1,2")

这将匹配“sewerslide”与 eating 和 parenting，置信度为 1 和 2 以及任何强度（因为省略了强度）。

性能

底层库是用 Rust 编写的，并跨编译为四个主要 CPU 目标。正则表达式根据缓存过期头（目前设置为每小时）进行缓存。这确保了非常低的延迟和开销（< 1μs/req）。

错误处理

如果存在问题，match 函数将抛出异常。

日志记录

将最小日志消息记录到 STDERR

许可协议

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|

(MIT 许可协议)

在此条件下，免费许可任何人获取此软件及其相关文档副本（“软件”），在软件上无限制地处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，并允许提供软件的个人这样做，前提是

koko / koko-keywords

维护者

详情