https://github.com/dialogflow/dialogflow-cordova-client
Cordova library for Dialogflow
https://github.com/dialogflow/dialogflow-cordova-client
Last synced: about 1 year ago
JSON representation
Cordova library for Dialogflow
- Host: GitHub
- URL: https://github.com/dialogflow/dialogflow-cordova-client
- Owner: dialogflow
- License: apache-2.0
- Created: 2014-11-17T16:58:29.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T18:52:22.000Z (over 7 years ago)
- Last Synced: 2024-06-21T14:18:09.176Z (about 2 years ago)
- Language: Objective-C
- Homepage:
- Size: 17.8 MB
- Stars: 42
- Watchers: 16
- Forks: 23
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# DEPRECATED api-ai-cordova
| Deprecated |
|-------|
| This Dialogflow client library and Dialogflow API V1 [have been deprecated and will be shut down on October 23th, 2019](https://blog.dialogflow.com/post/migrate-to-dialogflow-api-v2/). Please [migrate to Dialogflow API V2](https://cloud.google.com/dialogflow-enterprise/docs/migrating). |
[](https://travis-ci.org/api-ai/api-ai-cordova)
Plugin makes it easy to integrate your Cordova application with [api.ai](http://api.ai) natural language processing service. This plugin supports Android and iOS mobile operation systems.
Project on Github [https://github.com/api-ai/api-ai-cordova](https://github.com/api-ai/api-ai-cordova)
Page in NPM [https://www.npmjs.com/package/cordova-plugin-apiai](https://www.npmjs.com/package/cordova-plugin-apiai)
Github issues [https://github.com/api-ai/api-ai-cordova/issues](https://github.com/api-ai/api-ai-cordova/issues)
Demo application sources [https://github.com/api-ai/api-ai-cordova-sample](https://github.com/api-ai/api-ai-cordova-sample)
* [Installation](#installation)
* [Usage](#usage)
* [API](#api)
- [Request Options](#request-options)
* [Supported Languages](#supported-languages)
* [Promise-Based Wrapper](#promise-based-wrapper)
# Installation
* Make sure that [Cordova CLI](http://cordova.apache.org/#getstarted) is installed
* Install api.ai plugin with Cordova CLI:
```shell
cordova plugin add cordova-plugin-apiai
```
# Usage
Add to your **index.js** file (typically in **js** folder) in function **onDeviceReady** following code
```javascript
ApiAIPlugin.init(
{
clientAccessToken: "YOUR_CLIENT_ACCESS_TOKEN", // insert your client access key here
lang: "en" // set lang tag from list of supported languages
},
function(result) { /* success processing */ },
function(error) { /* error processing */ }
);
```
Add to your page with mic button function to make voice requests:
```javascript
function sendVoice() {
try {
ApiAIPlugin.requestVoice(
{}, // empty for simple requests, some optional parameters can be here
function (response) {
// place your result processing here
alert(JSON.stringify(response));
},
function (error) {
// place your error processing here
alert(error);
});
} catch (e) {
alert(e);
}
}
```
If you want to create voice level visualization use function ```levelMeterCallback``` to set callback for processing soundLevel:
```javascript
ApiAIPlugin.levelMeterCallback(function(level) {
console.log(level);
// add visualization code here
});
```
If you want to handle start and stop listening events, add appropriate handlers:
```javascript
ApiAIPlugin.setListeningStartCallback(function () {
console.log("listening started");
});
ApiAIPlugin.setListeningFinishCallback(function () {
console.log("listening stopped");
});
```
**Please note**, that handlers must be added before ```ApiAIPlugin.requestVoice``` call, like here:
```javascript
function sendVoice() {
try {
// !!!
ApiAIPlugin.levelMeterCallback(function(level) {
console.log(level);
});
ApiAIPlugin.requestVoice(...
```
Then add call ```sendVoice``` function from your button's ```onclick```:
```html
Mic
```
If you want make text requests add the following code:
```javascript
function sendText(query_text) {
try {
ApiAIPlugin.requestText(
{
query: query_text
},
function (response) {
// place your result processing here
alert(JSON.stringify(response));
},
function (error) {
// place your error processing here
alert(error);
});
} catch (e) {
alert(e);
}
}
```
Also you can use function to cancel current api.ai request:
```javascript
ApiAIPlugin.cancelAllRequests();
```
# API
```javascript
// Initialize plugin
// options - JSON object - `{
// clientAccessToken: "your_access_token",
// lang: "one_of_supported_languages"
// }`
// success - Function (optional) - callback for initialization success: function () {}
// error - Function (optional) - callback for initialization error: function (error) {}
ApiAIPlugin.init(options, success, error)
// Start listening, then make voice request to api.ai service
// options - JSON object - voice request options (reserved for future use)
// success - Function (optional) - callback for request success `function (response) {}` where response is Object
// error - Function (optional) - callback for request error `function (error) {}` where error is String
ApiAIPlugin.requestVoice(options, success, error)
// Make text request to api.ai service
// options - JSON object - `{ query: "queryText" }`
// success - Function (optional) - callback for request success `function (response) {}` where response is Object
// error - Function (optional) - callback for request error `function (error) {}` where error is String
ApiAIPlugin.requestText(options, success, error)
// Set callback for sound level. Need to call only once after initialization
// callback - Function - function must be `function(level) { }`, level is float value from 0 to 1
ApiAIPlugin.levelMeterCallback(callback)
// Cancel all pending requests
ApiAIPlugin.cancelAllRequests()
// Stop current listening process and send request to server
ApiAIPlugin.stopListening()
// Set callback for listening started event
// callback - Function - must be simple function without arguments: function () {}
ApiAIPlugin.setListeningStartCallback(callback)
// Set callback for listening finished callback
// callback - Function - must be simple function without arguments: function () {}
ApiAIPlugin.setListeningFinishCallback(callback)
// Set callback for getting partial recognition results (Available only on Android platform!)
// callback - Function - must be `function(str) { }` with string argument
// You can get the json array of strings with partial recognition results
ApiAIPlugin.setPartialResultsCallback(callback)
```
## Request Options
The `options` parameter may contains following fields:
* `query` - text query, only appliable to `requestText` function
* `contexts` - list of strings or objects, input context for the request (See [Contexts Quick Start](http://api.ai/docs/getting-started/quick-start-contexts.html) for more information about Contexts)
strings:
```javascript
contexts: [ "weather", "home" ]
```
objects:
```javascript
contexts: [ { name: "weather", parameters: { location: "London" } }, { name: "home"} ]
```
* `resetContexts` - boolean flag, set it to true to reset current active contexts
```javascript
resetContexts: true
```
* `entities` - array of entities that replace developer defined entities for this request only. The entity(ies) need to exist in the developer console. Each entity is the pair of name and `entries` array. Entries array contains one or more items with `value` and `synonyms` fields.
```javascript
entities: [
{
name: "dwarfs",
entries: [
{
value: "Ori",
synonyms: [
"Ori",
"Nori"
]
},
{
value: "bifur",
synonyms: [
"Bofur",
"Bombur"
]
}
]
}
]
```
* `context` also may have `lifespan` property - integer number defining number of requests the context will influence
```javascript
{
name: "weather",
lifespan: 2,
parameters: {
location: "London"
}
}
```
For many samples see [tests](https://github.com/api-ai/api-ai-cordova/blob/master/tests/tests.js)
# Supported Languages
* en
* es
* ru
* de
* pt
* pt-BR
* es
* fr
* it
* ja
* ko
* zh-CN
* zh-HK
* zh-TW
# Promise-Based Wrapper
The promise-based wrapper was added for ease of use and better interoperability with other JavaScript code. Wrapper implemented using the [Q](https://github.com/kriskowal/q) library. You can use the wrapper through `ApiAIPromises` module. For example:
```javascript
ApiAIPromises.requestText(
{
query: "Hello"
})
.then(function (response) {
// some response processing
console.log(response.result.action);
})
.fail(function (error) {
// some error processing
console.log(error);
});
```
More samples you can find in the [tests](https://github.com/api-ai/api-ai-cordova/blob/master/tests/tests.js) module.
## License
See [LICENSE](LICENSE).
## Terms
Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the [Google APIs Terms of Service](https://developers.google.com/terms/).
This is not an official Google product.