README

用于访问 fuzzy.ai API 的 PHP 库。

要求

PHP 5.3.3 或更高版本，并安装了 cURL 扩展。

安装

您可以通过 Composer 安装此库。

composer require fuzzy-ai/sdk

要加载库，请使用 Composer 的自动加载功能

require_once('vendor/autoload.php');

使用方法

所有 API 调用都需要从 https://fuzzy.ai/ 获取 API 密钥

$client = new FuzzyAi\Client('YourAPIKey');

list($result, $evalID) = $client->evaluate('YourAgentID', array('input1' => 42));

客户端

这是主类，也是 API 的入口点。

• FuzzyAi\Client($key, $root) 构造函数接受以下参数并返回一个新的客户端对象。
  • key: 您的 Fuzzy.ai API 密钥
  • root (可选): API 端点（默认为 https://api.fuzzy.ai）
• evaluate($agentId, $inputs) 这是主要使用的方法，它执行单个推理。返回一个输出数组和一个评估 ID（有关训练反馈，请参阅下文）。
  • agentId: 执行评估的代理的 ID
  • inputs: 一个关联数组，表示输入名称 => 值。
• feedback($evaluationId, $performance) 这是用于训练更好结果的方法。返回一个反馈对象。
  • evaluationId: 从 evaluate() 调用返回的唯一标识符。
  • performance: 提供学习的性能指标（作为一个关联数组）。
• newAgent($props) 使用此方法创建新的代理。返回一个代理对象。
  • props: 表示代理的关联数组，至少包括 inputs、outputs 和 rules。
• getAgent($agentId) 这将获取现有的代理定义。返回一个代理对象。
  • agentId : 要检索的代理的 ID

代理

此类代表代理并提供完整的 CRUD 功能。

• FuzzyAi\Agent($client) 构造函数 - 接受一个 HTTP 客户端对象，但使用上面的 newAgent 或 getAgent 创建代理对象更容易。
• evaluate($inputs) 与 Client::evaluate 类似，但针对现有的代理实例。 注意 返回一个评估对象。
  • inputs: 一个关联数组，表示输入名称 => 值。
• create($props) 创建新的代理（尽管 Client::newAgent 可能更容易）。
  • props: 表示代理的关联数组，至少包括 inputs、outputs 和 rules。
• read($props) 从 API 读取代理定义。可能使用 Client::getAgent() 更容易。
  • id : 要读取的代理 ID。
• update($props) 使用 $props 更新当前代理实例。
  • props: 新的代理属性。
• delete() 从 API 删除当前代理。

评估

此类代表单个评估。

• read($id) 通过 ID 加载单个评估对象。
• feedback($values) 向单个评估提供学习反馈数据。返回一个反馈对象。
  • values: 为反馈提供的性能指标。

示例

examples/ 目录包含一些使用库的示例。

开发

安装依赖项

composer install

运行测试

./vendor/bin/phpunit