https://github.com/alphaolomi/laravel-sarufi

Sarufi AI for Laravel
https://github.com/alphaolomi/laravel-sarufi

laravel-package sarufi sarufi-laravel

Last synced: about 2 months ago
JSON representation

Sarufi AI for Laravel

• Host: GitHub
• URL: https://github.com/alphaolomi/laravel-sarufi
• Owner: alphaolomi
• License: mit
• Created: 2022-10-28T23:19:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T23:50:44.000Z (about 1 year ago)
• Last Synced: 2024-05-21T05:14:17.129Z (8 months ago)
• Topics: laravel-package, sarufi, sarufi-laravel
• Language: PHP
• Homepage:
• Size: 38.1 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Sarufi for Laravel

[![Latest Version on Packagist](https://img.shields.io/packagist/v/alphaolomi/laravel-sarufi.svg?style=flat-square)](https://packagist.org/packages/alphaolomi/laravel-sarufi)

[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/alphaolomi/laravel-sarufi/run-tests?label=tests)](https://github.com/alphaolomi/laravel-sarufi/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/alphaolomi/laravel-sarufi/Fix%20PHP%20code%20style%20issues?label=code%20style)](https://github.com/alphaolomi/laravel-sarufi/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/alphaolomi/laravel-sarufi.svg?style=flat-square)](https://packagist.org/packages/alphaolomi/laravel-sarufi)

## Installation

You can install the package via composer:

```bash

composer require alphaolomi/laravel-sarufi

```

```bash

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

```

## Configuration 

in your `.env` file add

```ini

SARUFI_USERNAME="your_nice_username"

SARUFI_PASSWORD="your_nice_password"

```

## Usage

```php

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

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Alpha Olomi](https://github.com/alphaolomi)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.