dialogflow fulfillment webhook php
1.3.0
このライブラリは、dialogflow/dialogflow-fulfillment-nodejs からインスピレーションを得ています。
これは、v1 および v2 エージェントに対する Dialogflow のフルフィルメント Webhook JSON リクエストとレスポンスをサポートします。
クラスの完全なリファレンスについては、ドキュメントを参照してください。
コンポーザー経由でインストールします: composer require eristemena/dialogflow-fulfillment-webhook-php 。
エージェントを開始するには、Dialogflow からのリクエストの配列として入力パラメーターを指定したDialogflowWebhookClientコンストラクターを使用します。
Vanilla PHP では、これは次のように実行できます。
use Dialogflow WebhookClient ;
$ agent = new WebhookClient ( json_decode ( file_get_contents ( ' php://input ' ), true ));
// or
$ agent = WebhookClient :: fromData ( $ _POST );または、Laravel を使用している場合は、
$ agent = Dialogflow WebhookClient :: fromData ( $ request -> json ()-> all ()); $ intent = $ agent -> getIntent (); $ action = $ agent -> getAction (); $ query = $ agent -> getQuery (); $ parameters = $ agent -> getParameters (); $ session = $ agent -> getSession (); $ contexts = $ agent -> getContexts (); $ language = $ agent -> getLocale ();google 、 facebook 、 slackなど) $ originalRequest = $ agent -> getRequestSource (); $ originalRequest = $ agent -> getOriginalRequest (); $ agentVersion = $ agent -> getAgentVersion ();返信を送信するには、 reply()メソッドを使用します。
$ agent -> reply ( ' Hi, how can I help? ' );次に、 render()使用して配列で応答を取得します。配列を JSON として出力するだけです。
header ( ' Content-type: application/json ' );
echo json_encode ( $ agent -> render ());またはLaravelでは、
return response ()-> json ( $ agent -> render ());応答ペイロードは、要求のエージェント バージョンに従って自動的にフォーマットされます。
$ text = Dialogflow RichMessage Text :: create ()
-> text ( ' This is text ' )
-> ssml ( ' <speak>This is <say-as interpret-as="characters">ssml</say-as></speak> ' )
;
$ agent -> reply ( $ text ); $ image = Dialogflow RichMessage Image :: create ( ' https://www.example.com/image.png ' );
$ agent -> reply ( $ image ); $ card = Dialogflow RichMessage Card :: create ()
-> title ( ' This is title ' )
-> text ( ' this is text body ' )
-> image ( ' https://www.example.com/image.png ' )
-> button ( ' This is a button ' , ' https://docs.dialogflow.com/ ' )
;
$ agent -> reply ( $ card ); $ suggestion = Dialogflow RichMessage Suggestion :: create ([ ' Suggestion one ' , ' Suggestion two ' ]);
$ agent -> reply ( $ suggestion ); if ( $ agent -> getRequestSource ()== ' google ' ) {
$ agent -> reply ( Dialogflow RichMessage Payload :: create ([
' expectUserResponse ' => false
]));
}このライブラリは、Actions on Google 固有の機能もサポートしています。まだ開発中のため、今後さらに機能が追加される予定です。
Actions on Google Dialogflow Conversation オブジェクトを使用するには、まずrequestSourceが Google アシスタントからのものであることを確認する必要があります。
if ( $ agent -> getRequestSource ()== ' google ' ) {
$ conv = $ agent -> getActionConversation ();
// here you can use the rest of Actions on Google responses and helpers
$ agent -> reply ( $ conv );
}または、単にgetActionConversation()メソッドを呼び出すこともできます。リクエストが Google アシスタントからのものでない場合は、 nullが返されます。
$ conv = $ agent -> getActionConversation ();
if ( $ conv ) {
// here you can use the rest of Actions on Google responses and helpers
} else {
// the request does not come from Google Assistant
}Dialogflow Conversation オブジェクトを使用すると、次の 2 つの方法で返信を送信できます。
$ conv -> close ( ' Have a nice day! ' ); $ conv -> ask ( ' Hi, how can I help? ' );こちらのドキュメントをご覧ください。
use Dialogflow Action Responses SimpleResponse ;
$ conv -> ask ( SimpleResponse :: create ()
-> displayText ( ' Hello, how can i help? ' )
-> ssml ( ' <speak>Hello,<break time="0.5s"/> <prosody rate="slow">how can i help?</prosody></speak> ' )
); use Dialogflow Action Responses Image ;
$ conv -> close ( Image :: create ( ' https://picsum.photos/400/300 ' ));こちらのドキュメントをご覧ください。
use Dialogflow Action Responses BasicCard ;
$ conv -> close ( BasicCard :: create ()
-> title ( ' This is a title ' )
-> formattedText ( ' This is a subtitle ' )
-> image ( ' https://picsum.photos/400/300 ' )
-> button ( ' This is a button ' , ' https://docs.dialogflow.com/ ' )
);こちらのドキュメントをご覧ください。
単一選択リストは、複数の項目の縦方向のリストをユーザーに提示し、ユーザーが 1 つの項目を選択できるようにします。リストから項目を選択すると、リスト項目のタイトルを含むユーザー クエリ (チャット バブル) が生成されます。
use Dialogflow Action Questions ListCard ;
use Dialogflow Action Questions ListCard Option ;
$ conv -> ask ( ' Please choose below ' );
$ conv -> ask ( ListCard :: create ()
-> title ( ' This is a title ' )
-> addOption ( Option :: create ()
-> key ( ' OPTION_1 ' )
-> title ( ' Option 1 ' )
-> synonyms ([ ' option one ' , ' one ' ])
-> description ( ' Select option 1 ' )
-> image ( ' https://picsum.photos/48/48 ' )
)
-> addOption ( Option :: create ()
-> key ( ' OPTION_2 ' )
-> title ( ' Option 2 ' )
-> synonyms ([ ' option two ' , ' two ' ])
-> description ( ' Select option 2 ' )
-> image ( ' https://picsum.photos/48/48 ' )
)
);ユーザーが選択したオプションをキャプチャするには、 actions_intent_OPTIONイベントを使用して Dialogflow インテントを作成します。インテントの名前をGet Optionとすると、次のように引数を取得できます。
if ( ' Get Option ' == $ agent -> getIntent ()) {
$ conv = $ agent -> getActionConversation ();
$ option = $ conv -> getArguments ()-> get ( ' OPTION ' );
switch ( $ option ) {
case ' OPTION_1 ' :
$ conv -> close ( ' You choose option 1 ' );
break ;
case ' OPTION_2 ' :
$ conv -> close ( ' You choose option 2 ' );
break ;
default :
$ conv -> close ( ' Sorry, i do not understand ' );
break ;
}
}こちらのドキュメントをご覧ください。
カルーセルは水平にスクロールし、1 つの項目を選択できます。リスト セレクターと比較して、タイルが大きいため、より豊富なコンテンツを表示できます。カルーセルを構成するタイルは、画像付きの基本カードに似ています。カルーセルから項目を選択すると、リスト セレクターの場合と同様に、応答としてチャット バブルが生成されます。
use Dialogflow Action Questions Carousel ;
use Dialogflow Action Questions Carousel Option ;
$ conv -> ask ( ' Please choose below ' );
$ conv -> ask (
Carousel :: create ()
-> Option (
Option :: create ()
-> key ( ' OPTION_1 ' )
-> title ( ' Option 1 ' )
-> synonyms ([ ' option one ' , ' one ' ])
-> description ( ' Select option 1 ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
-> Option (
Option :: create ()
-> key ( ' OPTION_2 ' )
-> title ( ' Option 2 ' )
-> synonyms ([ ' option two ' , ' two ' ])
-> description ( ' Select option 2 ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
-> Option (
Option :: create ()
-> key ( ' OPTION_3 ' )
-> title ( ' Option 3 ' )
-> synonyms ([ ' option three ' , ' three ' ])
-> description ( ' Select option 3 ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
-> Option (
Option :: create ()
-> key ( ' OPTION_4 ' )
-> title ( ' Option 4 ' )
-> synonyms ([ ' option four ' , ' four ' ])
-> description ( ' Select option 4 ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
);ユーザーが情報を付与したかどうかを確認してデータにアクセスするには、 actions_intent_OPTIONイベントを使用して Dialogflow インテントを作成します。インテントの名前をGet Optionとすると、次のように引数を取得できます。
if ( ' Get Option ' == $ agent -> getIntent ()) {
$ conv = $ agent -> getActionConversation ();
$ option = $ conv -> getArguments ()-> get ( ' OPTION ' );
switch ( $ option ) {
case ' OPTION_1 ' :
$ conv -> close ( ' You choose option 1 ' );
break ;
case ' OPTION_2 ' :
$ conv -> close ( ' You choose option 2 ' );
break ;
case ' OPTION_3 ' :
$ conv -> close ( ' You choose option 3 ' );
break ;
case ' OPTION_4 ' :
$ conv -> close ( ' You choose option 4 ' );
break ;
default :
$ conv -> close ( ' Sorry, i do not understand ' );
break ;
}
}こちらのドキュメントをご覧ください。
ブラウジング カルーセルは、水平方向にスクロールしてユーザーがタイルを選択できるようにするカルーセル レスポンスに似たリッチ レスポンスです。ブラウズ カルーセルは、選択したタイルを Web ブラウザ (すべてのタイルが AMP 対応の場合は AMP ブラウザ) で開くことで、Web コンテンツ専用に設計されています。閲覧カルーセルは、後で閲覧するためにユーザーのアシスタント画面にも残ります。
use Dialogflow Action Responses BrowseCarousel ;
use Dialogflow Action Responses BrowseCarousel Option ;
$ conv -> ask ( ' Please choose below ' );
$ conv -> ask (
BrowseCarousel :: create ()
-> imageDisplayOptions ( ' CROPPED ' )
-> addOption (
Option :: create ()
-> title ( ' Title of item 1 ' )
-> description ( ' Description of item 1 ' )
-> footer ( ' Item 1 footer ' )
-> url ( ' http://www.example.com ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
-> addOption (
Option :: create ()
-> title ( ' Title of item 2 ' )
-> description ( ' Description of item 2 ' )
-> footer ( ' Item 2 footer ' )
-> url ( ' http://www.example.com ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
-> addOption (
Option :: create ()
-> title ( ' Title of item 3 ' )
-> description ( ' Description of item 3 ' )
-> footer ( ' Item 3 footer ' )
-> url ( ' http://www.example.com ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
-> addOption (
Option :: create ()
-> title ( ' Title of item 4 ' )
-> description ( ' Description of item 4 ' )
-> footer ( ' Item 4 footer ' )
-> url ( ' http://www.example.com ' )
-> image ( ' https://picsum.photos/300/300 ' )
)
);カルーセルがブラウザーのハンドオフを処理するため、ブラウズ カルーセル アイテムとのユーザー操作にフォローアップ フルフィルメントは必要ありません。
こちらのドキュメントをご覧ください。
use Dialogflow Action Responses LinkOutSuggestion ;
use Dialogflow Action Responses Suggestions ;
$ conv -> ask ( ' Please choose ' );
$ conv -> ask ( new Suggestions ([ ' Suggestion 1 ' , ' Suggestion 2 ' ]));
$ conv -> ask ( new Suggestions ( ' Suggestion 3 ' ));
$ conv -> ask ( new LinkOutSuggestion ( ' Website ' , ' http://www.example.com ' ));こちらのドキュメントをご覧ください。
メディア応答を使用すると、アクションで SSML の制限である 120 秒を超える再生時間のオーディオ コンテンツを再生できるようになります。メディア応答の主なコンポーネントはシングルトラック カードです。
use Dialogflow Action Responses MediaObject ;
use Dialogflow Action Responses MediaResponse ;
use Dialogflow Action Responses Suggestions ;
$ conv -> ask ( ' Here you go ' );
$ conv -> ask (
new MediaResponse (
MediaObject :: create ( ' http://storage.googleapis.com/automotive-media/Jazz_In_Paris.mp3 ' )
-> name ( ' Jazz in Paris ' )
-> description ( ' A funky Jazz tune ' )
-> icon ( ' http://storage.googleapis.com/automotive-media/album_art.jpg ' )
-> image ( ' http://storage.googleapis.com/automotive-media/album_art.jpg ' )
)
);
$ conv -> ask ( new Suggestions ([ ' Pause ' , ' Stop ' , ' Start over ' ]));こちらのドキュメントをご覧ください。
use Dialogflow Action Questions Permission ;
$ conv -> ask ( Permission :: create ( ' To address you by name and know your location ' , [ ' NAME ' , ' DEVICE_PRECISE_LOCATION ' ]));ユーザーが情報を付与したかどうかを確認してデータにアクセスするには、 actions_intent_PERMISSIONイベントを使用して Dialogflow インテントを作成します。インテントの名前をGet Permissionとすると、次のように情報を取得できます。
if ( ' Get Permission ' == $ agent -> getIntent ()) {
$ conv = $ agent -> getActionConversation ();
$ approved = $ conv -> getArguments ()-> get ( ' PERMISSION ' );
if ( $ approved ) {
$ name = $ conv -> getUser ()-> getName ()-> getDisplay ();
$ latlng = $ conv -> getDevice ()-> getLocation ()-> getCoordinates ();
$ lat = $ latlng -> getLatitude ();
$ lng = $ latlng -> getLongitude ();
$ conv -> close ( ' Got it, your name is ' . $ name . ' and your coordinates are ' . $ lat . ' , ' . $ lng );
} else {
$ conv -> close ( ' Never mind then ' );
}
}こちらのドキュメントをご覧ください。
use Dialogflow Action Questions DateTime ;
$ conv -> ask ( new DateTime ( ' When do you want to come in? ' , ' What is the best date to schedule your appointment? ' , ' What time of day works best for you? ' ));ユーザーがアクセスを許可したかどうかを確認してからデータにアクセスするには、 actions_intent_DATETIMEイベントを使用して Dialogflow インテントを作成します。インテントの名前をGet Date Timeとすると、次のように情報を取得できます。
if ( ' Get Date Time ' == $ agent -> getIntent ()) {
$ conv = $ agent -> getActionConversation ();
$ date = $ conv -> getArguments ()-> get ( ' DATETIME ' );
if ( $ date ) {
$ conv -> close ( ' Ok, got it, i will see you at ' . $ date -> format ( ' r ' ));
} else {
$ conv -> close ( ' Never mind then ' );
}
}こちらのドキュメントをご覧ください。
use Dialogflow Action Questions Place ;
$ conv -> ask ( new Place ( ' Where do you want to have lunch? ' , ' To find lunch locations ' ));ユーザーがアクセスを許可したかどうかを確認してからデータにアクセスするには、 actions_intent_PLACEイベントを使用して Dialogflow インテントを作成します。インテントの名前をGet Placeとすると、次のように情報を取得できます。
if ( ' Get Place ' == $ agent -> getIntent ()) {
$ conv = $ agent -> getActionConversation ();
$ place = $ conv -> getArguments ()-> get ( ' PLACE ' );
if ( $ place ) {
$ conv -> close ( ' Ok, got it, we ' ll meet at ' . $ place -> getFormattedAddress ());
} else {
$ conv -> close ( ' Never mind then ' );
}
}こちらのドキュメントをご覧ください。
use Dialogflow Action Questions Confirmation ;
$ conv -> ask ( new Confirmation ( ' Can you confirm? ' ));ユーザーが確認したかどうかを確認するには、 actions_intent_CONFIRMATIONイベントを使用して Dialogflow インテントを作成します。インテントの名前をGet Confirmationとすると、次のように情報を取得できます。
if ( ' Get Confirmation ' == $ agent -> getIntent ()) {
$ conv = $ agent -> getActionConversation ();
$ confirmed = $ conv -> getArguments ()-> get ( ' CONFIRMATION ' );
if ( $ confirmed ) {
$ conv -> close ( ' Ok, it is confirmed ' );
} else {
$ conv -> close ( ' Alright then, it is canceled ' );
}
}Google アシスタントは、オーディオとディスプレイのエクスペリエンスをサポートするモバイル デバイスや、オーディオのみのエクスペリエンスをサポートする Google Home デバイスなど、さまざまな環境で使用できます。
すべてのサーフェスで適切に機能する会話を設計および構築するには、サーフェス機能を使用して会話を適切に制御し、範囲を設定します。
$ surface = $ conv -> getSurface ();
if ( $ surface -> hasScreen ()) {
// surface has screen
} elseif ( $ surface -> hasAudio ()) {
// surface has audio
} elseif ( $ surface -> hasMediaPlayback ()) {
// surface can play audio
} elseif ( $ surface -> hasWebBrowser ()) {
// user can interact with the content in a web browser
}
