recastai/recastai

The official PHP SDK Recast.ai

Recast.AI - SDK PHP

, _(*1)

Recast.AI official SDK in PHP, _(*2)

Synospis

This module is a PHP interface to the Recast.AI API. It allows you to make request to your bots, _(*3)

Installation

composer require recastai/sdk-php

Usage

textRequest(YOUR_TEXT);
YOUR_INTENT = $res->intent();
// Do your code...

?>

Specs

Classes

This module contains 4 classes, as follows:, _(*4)

• Client is the client allowing you to make requests.
• Response contains the response from Recast.AI.
• Entity represents an entity found by Recast.AI in your user's input.
• RecastError is the error returned by the module.

Don't hesitate to dive into the code, it's commented ;), _(*5)

class Client

The Client can be instanciated with a token and a language (both optional)., _(*6)

$client = new Client(YOUR_TOKEN, YOUR_LANGUAGE);

Your tokens:, _(*7)

, _(*8)

Copy paste your request access token from your bot's settings., _(*9)

Your language, _(*10)

$client = new Client(YOUR_TOKEN, 'en');

The language is a lowercase 639-1 isocode., _(*11)

Text Request

textRequest(text, options = { token: YOUR_TOKEN, language: YOUR_LANGUAGE, proxy: YOUR_URL_PROXY }), _(*12)

If your pass a token or a language in the options parameter, it will override your default client language or token. You can pass a proxy url in the options if needed., _(*13)

$res = $client->textRequest(YOUR_TEXT);
// Do your code...¯

})

// With optional parameters

$options = array('language' => 'YOUR_LANGUAGE', 'token' => 'YOUR_TOKEN');

$res = $client->textRequest(YOUR_TEXT, $options);  

// Do your code...

If a language is provided: the language you've given is used for processing if your bot has expressions for it, else your bot's primary language is used., _(*14)

If no language is provided: the language of the text is detected and is used for processing if your bot has expressions for it, else your bot's primary language is used for processing., _(*15)

File Request

fileRequest(file, callback, options = { token: YOUR_TOKEN, language: YOUR_LANGUAGE, proxy: YOUR_PROXY_URL }), _(*16)

If your pass a token or a language in the options parameter, it will override your default client language or token. You can pass a proxy url in the options if needed., _(*17)

file format: .wav, _(*18)

$res = $client->fileRequest('myFile.wav');

// Do your code...

})

$options = array('language' => 'en', 'token' => YOUR_TOKEN);

$res = $client->fileRequest('myFile.wav', $options);
  // Do your code...

If a language is provided: Your bot's primary language is used for processing as we do not provide language detection for speech., _(*19)

If no language is provided: The language you've given is used for processing if your bot has expressions for it, else your bot's primary language is used, _(*20)

class Response

The Response is generated after a call to either fileRequest or textRequest., _(*21)

Get the first detected intent

$res = $client->textRequest($text);
$lol = $res->intent();

if ($result->slug == 'weather') {
  // Do your code...
}

Get one entity

$res = $client->textRequest($text);

$result = $res->get('location');

Get all entities matching name

$res = $client->textRequest($text);

$lol = $res->all('location');

Getters

Each of the following methods corresponds to a Response attribute, _(*22)

class Entity

The Entity is generated by the Sentence constructor., _(*23)

Getters

Each of the following methods corresponds to a Response attribute, _(*24)

In addition to those methods, more attributes are generated depending of the nature of the entity. The full list can be found there: man.recast.ai, _(*25)

$res = $client->textRequest($text);

$result = $res->get('location');

var_dump($result->slug);
var_dump($result->raw);

class RecastError

The Recast.AI Error is thrown when receiving an non-200 response from Recast.AI., _(*26)

As it inherits from Error, it implements the default Error methods., _(*27)

More

You can view the whole API reference at man.recast.ai., _(*28)

Author

Bruno Gantelmi, bruno.gantelmi@recast.ai, _(*29)

You can follow us on Twitter at @recastai for updates and releases., _(*30)

License

Copyright (c) [2016] Recast.AI, _(*31)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:, _(*32)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., _(*33)

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE., _(*34)