alphaolomi/sarufi-php

Sarufi for PHP

v0.1.0 2023-07-05 06:52 UTC

README

Latest Version on Packagist Tests Total Downloads

安装

您可以通过 Composer 安装此包

composer require alphaolomi/sarufi-php

用法

use Alphaolomi\Sarufi\Sarufi;

$sarufi = new Sarufi('your_token');

// Create an Empty bot
$bot1 = $sarufi->createBot([
    "name" => "YOUR AWESOME BOT NAME",
    "description" => "PUT DESCRIPTION HERE",
    "industry" => "YOUR BOT INDUSTRY",
    "intents" => [],
    "flows" => [],
]);
print_r($bot1);

// OR
// From files with intent and metadata
$bot2 = $sarufi->createFromFile(
    intents: __DIR__ . 'data/intents.yaml',
    flow:  __DIR__ . 'data/flow.yaml',
    metadata:  __DIR__ . 'data/metadata.yaml'
);


print_r($bot2);

API 可用

  • Sarufi(string $token)
  • public function createBot(string $name, null|string $description = null, string $industry = "general", $flows = [], $intents = [], bool $visibleOnCommunity = false)
  • public function createFromFile($metadata = null, $intents = null, $flows = null)
  • public function updateBot($id, $name, $industry, $description, $intents, $flows, $visibleOnCommunity)
  • public function updateFromFile( $id, $intents, $flows, $metadata)
  • public function getBot($id)
  • public function chat(int $botId, string $chatId, string $message = "Hello", string $messageType = "text", string $channel = "general")
  • public function deleteBot($id)

测试

使用 PestPHP

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请审查 我们的安全策略 以了解报告安全漏洞的方法。

鸣谢

许可协议

MIT 许可协议 (MIT)。请参阅 许可文件 了解更多信息。