alphaolomi/laravel-sarufi

Sarufi for Laravel

v0.0.1 2022-10-29 00:27 UTC

Requires

• php: ^8.1
• alphaolomi/sarufi-php: ^0.0.1
• illuminate/contracts: ^9.0
• spatie/laravel-package-tools: ^1.13.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^6.0
• orchestra/testbench: ^7.0
• pestphp/pest: ^1.21
• pestphp/pest-plugin-laravel: ^1.1
• phpunit/phpunit: ^9.5

MIT

• Alpha Olomi

• sarufi
• laravel-sarufi

README

Installation

You can install the package via composer:

composer require alphaolomi/laravel-sarufi

php artisan vendor:publish --tag="sarufi-config"

Configuration

in your .env file add

SARUFI_USERNAME="your_nice_username"
SARUFI_PASSWORD="your_nice_password"

Usage

use Alphaolomi\Laravel\Sarufi\Facades\Sarufi;
$bot = Sarufi::createBot(
    name: "Danny bot",
    description: "PUT DESCRIPTION HERE",
    industry: "YOUR BOT INDUSTRY",
    intents: [],
    flows: []
);

print_r($bot1);
// Output
// => [
//      "intents" => [],
//      "user_id" => 54,
//      "description" => "PUT DESCRIPTION HERE",
//      "industry" => "YOUR BOT INDUSTRY",
//      "created_at" => "2022-10-20T14:24:32.862859",
//      "name" => "Danny bot",
//      "flows" => [],
//      "id" => 81,
//      "model_name" => "models/24bea90e2ad6f9d279d4fa86795c8ea0.pkl",
//      "visible_on_community" => false,
//      "updated_at" => "2022-10-20T14:24:32.862872",
//    ]


// OR
// From files with intent and metadata/
// Assume you have you file in storage/data/intents.yaml example
$bot2 Sarufi::createFromFile(
    intents: storage_path('data/intents.yaml'),
    flow:  storage_path('data/flow.yaml'),
    metadata: storage_path('data/metadata.yaml'
);
print_r($bot);

API avalable

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

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Alpha Olomi
• All Contributors

License

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