dialogflow fulfillment webhook php

Dialogflow 履行 PHP 函式庫

函式庫的靈感來自dialogflow/dialogflow-fulfillment-nodejs。

它支援 Dialogflow 的 v1 和 v2 代理程式的履行 Webhook JSON 請求和回應。

有關完整課程參考，請參閱文件。

• 安裝
• 用法
  • 發起代理
  • 獲取請求訊息
  • 發送回覆
  • 豐富的留言
    • 文字
    • 影像
    • 卡片
    • 建議
    • 自訂負載
  • 在 Google 上的操作
    • 發送回覆
    • 回應
      • 簡單的回應
      • 影像
      • 基本卡
      • 清單
      • 輪播
      • 瀏覽輪播
      • 建議籌碼
      • 媒體回應
    • 幫手
      • 使用者資訊
      • 日期和時間
      • 地點和地點
      • 確認
    • 表面能力

安裝

透過composer安裝： composer require eristemena/dialogflow-fulfillment-webhook-php 。

用法

發起代理

若要啟動代理，請使用DialogflowWebhookClient建構函數，並將輸入參數作為來自 Dialogflow 的請求陣列。

在 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 ();

• 代理版本（1 或 2）

 $ 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
    ]));
}

在 Google 上的操作

該程式庫還支援 Actions on Google 特定功能。它仍在開發中，因此將來會添加更多功能。

要在 Google Dialogflow Conversation 物件上使用 Actions，您必須先確保requestSource來自 Google Assistant，

 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 Assistant，它將傳回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 對象，您可以透過兩種方式傳送回复，

1. 發送回應並關閉對話

 $ conv -> close ( ' Have a nice day! ' );

2. 發送回覆並等待用戶回复

 $ 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/ ' )
);

清單

請參閱此處的文件。

單選列表向使用者呈現多個項目的垂直列表，並允許使用者選擇單一項目。從清單中選擇一個項目會產生一個包含清單項目標題的使用者查詢（聊天氣泡）。

 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 ;
    }
}

輪播

請參閱此處的文件。

輪播水平滾動並允許選擇一項。與清單選擇器相比，它具有較大的圖塊，可以提供更豐富的內容。組成輪播的圖塊與帶有圖像的基本卡片類似。從輪播中選擇一個項目將簡單地產生一個聊天氣泡作為回應，就像清單選擇器一樣。

 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 內容而設計，透過在 Web 瀏覽器（或 AMP 瀏覽器，如果所有圖塊均啟用了 AMP）中開啟所選圖塊來實現。瀏覽輪播也將保留在用戶的 Assistant 表面上，以便稍後瀏覽。

 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 Assistant 可在各種表面上使用，例如支援音訊和顯示體驗的行動裝置或支援純音訊體驗的 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
}