応答のビルド
Note: Sign in to the developer console to build or publish your skill.
応答のビルド
標準的な応答
Lambdaをスキルのエンドポイントに使用している場合は、Alexaがユーザーリクエストに応答するための応答本文を提供するだけで済みます。応答本文のJSON構造についてのドキュメントは、こちらを参照してください。
応答本文には、次のプロパティが含まれる場合があります。
- version
- sessionAttributes
- response
ASK SDK v2 for Node.jsを使用すると、versionとsessionAttributesを入力してくれるので、ボイラープレートコード（毎回書かなければならないお決まりのコード）を書く手間が省け、その分応答の作成に集中できます。
ResponseBuilder
ResponseBuilderには応答を作成するためのヘルパーメソッドが含まれています。Responseには複数の要素が含まれる場合があり、ヘルパーメソッドによって、各応答の要素を初期化したり設定したりする必要がなくなり、応答を生成しやすくなります。ResponseBuilderは、HandlerInputコンテナオブジェクトからハンドラーで使用できます。ResponseBuilderの詳細については、TypeDocを参照してください。
利用可能なメソッド
speak(speechOutput: string, playBehavior? : ui.PlayBehavior): this;
reprompt(repromptSpeechOutput: string, playBehavior? : ui.PlayBehavior): this;
withSimpleCard(cardTitle: string, cardContent: string): this;
withStandardCard(cardTitle: string, cardContent: string, smallImageUrl?: string, largeImageUrl?: string): this;
withLinkAccountCard(): this;
withAskForPermissionsConsentCard(permissionArray: string[]): this;
withCanFulfillIntent(canFulfillIntent : CanFulfillIntent) : this;
addDelegateDirective(updatedIntent?: Intent): this;
addElicitSlotDirective(slotToElicit: string, updatedIntent?: Intent): this;
addConfirmSlotDirective(slotToConfirm: string, updatedIntent?: Intent): this;
addConfirmIntentDirective(updatedIntent?: Intent): this;
addAudioPlayerPlayDirective(playBehavior: interfaces.audioplayer.PlayBehavior, url: string, token: string, offsetInMilliseconds: number, expectedPreviousToken?: string, audioItemMetadata? : AudioItemMetadata): this;
addAudioPlayerStopDirective(): this;
addAudioPlayerClearQueueDirective(clearBehavior: interfaces.audioplayer.ClearBehavior): this;
addRenderTemplateDirective(template: interfaces.display.Template): this;
addHintDirective(text: string): this;
addVideoAppLaunchDirective(source: string, title?: string, subtitle?: string): this;
withShouldEndSession(val: boolean): this;
addDirective(directive: Directive): this;
getResponse(): Response;
以下の例は、ResponseBuilderヘルパーメソッドを使用して応答を作成する方法を示しています。
const response = handlerInput.responseBuilder
.speak('foo')
.reprompt('bar')
.withSimpleCard('title', 'cardText')
.getResponse();
const response = handlerInput.responseBuilder
.speak('foo')
.reprompt('bar')
.withSimpleCard('title', 'cardText')
.getResponse();
注： speakとreprompt値のコンテンツはSSMLタグで囲みます。つまり、値に含まれるXMLの特殊文字はエスケープ処理をする必要があります。ASK SDKで提供される
•
•
•
•
•
SsmlUtilsを使うと、以下の無効なXML文字をエスケープ処理できます。•
& -> &•
> -> >•
< -> <•
' -> '•
" -> "画像とテキストのヘルパー
ASK SDK v2 for Node.jsは以下のヘルパークラスを提供しています。これらは、Echo Showと互換性のあるスキルで広く使用されるテキストや画像の要素の作成に便利です。
ImageHelper
const Alexa = require('ask-sdk-core');
const myImage = new Alexa.ImageHelper()
.withDescription('FooDescription')
.addImageInstance('http://BarImageSource')
.getImage();
import { ImageHelper } from 'ask-sdk-core';
import { interfaces } from 'ask-sdk-model';
import Image = interfaces.display.Image;
const myImage : Image = new ImageHelper()
.withDescription('FooDescription')
.addImageInstance('http://BarImageSource')
.getImage();
PlainTextContentHelper
const Alexa = require('ask-sdk-core');
const myTextContent = new Alexa.PlainTextContentHelper()
.withPrimaryText('Foo')
.withSecondaryText('Bar')
.withTertiaryText('Baz')
.getTextContent();
import { PlainTextContentHelper } from 'ask-sdk-core';
import { interfaces } from 'ask-sdk-model';
import TextContent = interfaces.display.TextContent;
const myTextContent : TextContent = new PlainTextContentHelper()
.withPrimaryText('Foo')
.withSecondaryText('Bar')
.withTertiaryText('Baz')
.getTextContent();
RichTextContentHelper
const Alexa = require('ask-sdk-core');
const myTextContent = new Alexa.RichTextContentHelper()
.withPrimaryText('Foo')
.withSecondaryText('Bar')
.withTertiaryText('Baz')
.getTextContent();
import { RichTextContentHelper } from 'ask-sdk-core';
import { interfaces } from 'ask-sdk-model';
import TextContent = interfaces.display.TextContent;
const myTextContent : TextContent = new RichTextContentHelper()
.withPrimaryText('Foo')
.withSecondaryText('Bar')
.withTertiaryText('Baz')
.getTextContent();