JavaScript
Node.js
Alexa

Alexaスキル作成におけるLambda側の基本


はじめに

Alexaスキルの作成は大きく分けて2つからなります。


  • 対話モデルの作成

  • スキルの実際の処理部の作成

対話モデルはAlexa開発者コンソールからグラフィカルに作成するのが一般的です。

(画像は公式のチュートリアルより)

image.png

作成された対話モデルに従ってインテントが作成され、それがJSON形式でスキルの処理部分に渡されます。

このスキルの処理部分がインテントハンドラとしてAWS Lambda関数として実装される部分になります。

実装に使うことができる言語はいくつかありますが、公式のチュートリアルではNode.jsで説明されているので素直にNode.jsを選ぶと良いでしょう。

この記事でもNode.jsで話をします。

さて、この記事ではLambda関数として作成するインテントハンドラの基本的な構成について説明したいと思います。

コード部分はぱっと見だと複雑そうですが、少し落ち着いて見てみると意外とシンプルな構成であることがわかります。

基本的な構成がわかれば、自分でカスタマイズするのが格段に容易になると思います。


環境


  • Alexa SDK for Node.js Ver.2

Alexa SDK for Node.jsはVer.2になりました。公式のチュートリアルもVer.2を用いたものになりました。

Ver.1は、以下のようなemitが使われているバージョンです。

Ver.2になるとemitが使われず、canHandlehandleといったメソッドが使われます。


 index.jsにインテントハンドラを書く

Alexa開発者コンソールで作成したインテントに対応するインテントハンドラをここに書き連ねていきます。

なので、index.jsの基本的な構成はこんな感じです。


index.js


インテントハンドラ1の定義

インテントハンドラ2の定義

インテントハンドラ3の定義

・・・

インテントハンドラ10の定義

インテントハンドラ110の登録


というように、インテントハンドラを定義し、Alexaからのリクエストに対してそれらのインテントハンドラが機能するように登録する、というのが一連の流れ。


インテントハンドラの定義と基本形

まずはインテントハンドラの定義の仕方について説明します。

定義の基本的な形は以下のとおりです。

canHandleメソッドで、そのインテントハンドラが応答する条件を記述します。

基本形はリクエストのタイプインテント名のチェックを行って、TrueFalseをreturnします。

ここでTrueを返すと、handleメソッド内の処理が行われます。

//例:「ほげほげIntent」というインテントに対応するインテントハンドラ

const ほげほげIntentHandler = {//名前は何でもいいけれど、対応がわかりやすい名前を。
canHandle(handlerInput) {
return handlerInput.requestEnvelope.request.type === 'IntentRequest'
&& handlerInput.requestEnvelope.request.intent.name === 'ほげほげIntent';//受け取ったインテントのタイプが「IntentRequest」で、インテント名が「ほげほげIntent」のときに、このインテントハンドラの処理を実行する。
},
handle(handlerInput) {//実行される部分

//何かしらの処理を書く
//何かしらの処理というのは主にAlexaに喋らせる情報を取得する処理
  //気象情報とか、電車の運行情報とか

//Alexaへ返すレスポンスを作る。
return handlerInput.responseBuilder
.speak('Alexaに喋らせる内容')
.reprompt('次の問いかけ')//続いてユーザーに問いかける場合に使う。なければここでスキルが終了する。
.withSimpleCard('カードタイトル','カード本文')//Echo Spotなどのディスプレイ付きのデバイスに表示させる場合に使う。
.getResponse();//最後にかならずつける。
},
};

これを1セットとして、インテントの数だけ作る。

LaunchIntentHelpIntentなどスキルに必ず実装しなければならない特別なインテントもあるけれど、基本的には同じです。


インテントハンドラの登録

上で作成したインテントハンドラですが、これはインテントハンドラを定義しただけなので、呼び出されることはありません。

これらのインテントハンドラが機能するためには、それを登録する必要があります。

それが以下の部分です。

const skillBuilder = Alexa.SkillBuilders.custom();//お約束

exports.handler = skillBuilder
.addRequestHandlers(//機能させたいインテントハンドラを引数として与える
LaunchRequestHandler, //ビルトイン
ほげほげIntentHandler, //ユーザー定義
もがもがIntentHandler, //ユーザー定義
おろおろIntentHandler, //ユーザー定義
HelpIntentHandler,//ビルトイン
CancelAndStopIntentHandler,//ビルトイン
SessionEndedRequestHandler //ビルトイン
)
.addErrorHandlers(ErrorHandler) //エラーハンドラ
.lambda(); //必ずつける

機能させたいインテントハンドラをここで登録します。

登録しないと「あれ?応答しないぞ」ということになります。

また、当然のことながら定義していないインテントハンドラを登録すると、プログラム的にエラーになります。


まとめ

つまり、以下のような流れです。

Alexa開発者コンソールで対話モデルを作成します。

ここで、例えばHogeHogeIntentを作成したとしましょう。

image.png

そうしたら、このHogeHogeIntentに対応するインテントハンドラをAWS Lambda側のindex.js内に定義します。

名前は対応がわかりやすいようにHogeHogeIntentHandlerとするのが良いでしょう。

const HogeHogeIntentHandler = {

canHandle(handlerInput) {
return handlerInput.requestEnvelope.request.type === 'IntentRequest'
&& handlerInput.requestEnvelope.request.intent.name === 'HogeHogeIntent';
},
handle(handlerInput) {
var speechText = 'ほげほげ';

//Alexaに「ほげほげ」喋らせてスキルが終了する。
//repromptを書かないでおく。
return handlerInput.responseBuilder
.speak(speechText)//Alexaに「ほげほげ」喋らせる。
.withSimpleCard('Alexaほげほげ', speechText)//カードのタイトルと、メッセージ
.getResponse();
},
};

そして、定義したHogeHogeIntentHandlerを登録します。

const skillBuilder = Alexa.SkillBuilders.custom();//お約束

exports.handler = skillBuilder
.addRequestHandlers(
LaunchRequestHandler,
HogeHogeIntentHandler,//← これ
HelpIntentHandler,
CancelAndStopIntentHandler,
SessionEndedRequestHandler
)
.addErrorHandlers(ErrorHandler)
.lambda(); //必ずつける

以上です。