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
}