Edited at

API.AIのFulfillmentにIFTTTのWebhooksサービスを使う

More than 1 year has passed since last update.


問題

API.AIは、エージェントのintentに対してFulfillmentを設定することで、外部のウェブサービスに対してwebhookを発行できます。一方で、IFTTTWebhooksというwebhookを扱うサービスをサポートしています。このため、API.AIのエージェントからIFTTTのWebhooksサービスを叩くことは原理的には可能です。しかしながら、API.AIが発行するwebhookの形式はIFTTTのWebhooksサービスが受け取れる形式とは異なるため、直接叩くことができません。


API.AIが発行するwebhookの例(ドキュメントより抜粋)

POST https://my-service.com/action

Headers:
Content-type: application/json

POST body:
{
"lang": "en",
"status": {
"errorType": "success",
"code": 200
},
"timestamp": "2017-02-09T16:06:01.908Z",
"sessionId": "1486656220806",
"result": {
...
"action": "greetings",



IFTTTのWebhooksサービスが受け取るwebhookの例

POST/GET https://maker.ifttt.com/trigger/{event}/with/key/*********************

Headers:
Content-Type: application/json

POST body:
{
"value1":"value1"
}



解決法

API.AIが発行するwebhookをIFTTTのWebhooksサービスが受け取れる形式に変換するブリッジを用意する。


解説


実装例

まず、以下のようなコードをいずれかのサーバで実行します。ここで、IFTTTのイベント名はapi_aiに固定し、value1としてAPI.AIからのwebhook中のactionを割り当てています。利用方法によっては、API.AIのactionをIFTTTのイベント名にした方がいいかもしれません。


app.js

'use strict';

const express = require('express');
const request = require('request');
const bodyParser = require('body-parser');

const app = express();
app.use(bodyParser.json());

app.post('/', (req, res) => {
// API.AIからのwebhookのヘッダに記載されたkeyをIFTTTのkeyとして使用
const KEY = req.headers['key'];

// API.AIからのwebhookのresult/actionをIFTTTのイベントのvalue1として使用
const ACTION = req.body['result']['action'];

// IFTTTのイベント名は「api_ai」で固定
var options = {
uri: 'https://maker.ifttt.com/trigger/api_ai/with/key/' + KEY,
form: {
value1: ACTION,
value2: '',
value3: ''
},
json: true
};

request.post(options, (error, response, body) => {
let responseToApiAi;

if (!error && response.statusCode === 200) {
console.log(body);

responseToApiAi = {
'speech': 'OK!',
'displayText': 'OK!'
};
} else {
console.log('error: ' + response.statusCode);

responseToApiAi = {
'speech': 'ERROR!',
'displayText': 'ERROR: ' + response.statusCode
};
}

res.json(responseToApiAi);
});
});

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
console.log(`App listening on port ${PORT}`);
});


次に、API.AIのエージェントの設定Fulfillment>WebhookでサーバのURLを記入すると共に、ヘッダにIFTTTのkeyを追加します。

これにより、API.AIがwebhookを発行すると、IFTTTのWebhooksサービスを叩いてトリガーを発生させることができます。


補足

IFTTTはGoogle Assistantサービスもサポートしているため、簡単な音声リモコンを実現したいだけであればわざわざAPI.AIでエージェントをつくる必要はありません。



図:IFTTTのGoogle Assistantサービスのトリガーとしての設定項目。最大で3つまでフレーズの例を与えられる。言語は、英語、フランス語、ドイツ語、日本語の4種類から選択できる(2017年10月8日の段階において)。

しかしながら、Google Assistantをトリガーとして使用する際には、提供した3つの例に正確にマッチする必要があります。アルファベットで完結する他の言語と異なり、日本語の場合にはちょっと厄介で、ひらがな/カタカナ/漢字の表記が異なるだけでもマッチしなくなってしまいます。スマートフォンのGoogle Assistantアプリであればどのように認識されたかが確認できますが、Google Homeは音声だけのため、上手く動かない場合どこに問題があるのかがわからずストレスがたまってしまうこともあるでしょう。

こうした場合、IFTTTのGoogle Assistantサービスをそのまま使うのでなく、API.AIで簡単なエージェントを作成してそのエージェント経由で会話することにより、多少の揺れにも対応できるようになると思います。