alphaolomi/sarufi-php

Sarufi for PHP

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

Requires

• php: >=7.4
• guzzlehttp/guzzle: ^7.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• pestphp/pest: ^1.20
• symfony/yaml: ^5.4

Suggests

• symfony/yaml: To use YAML configuration

MIT

• Alpha Olomi

• alphaolomi
• sarufi
• convesional ai

README

Installation

You can install the package via Composer:

composer require alphaolomi/sarufi-php

Usage

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 available

• 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)

Testing

Uses PestPHP.

composer test

Changelog

Please see CHANGELOG for more information on recent changes.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on reporting security vulnerabilities.

Credits

• Alpha Olomi
• All Contributors

License

The MIT License (MIT). Please see License File for more information.