dialogflow fulfillment webhook php Download - dialogflow fulfillment webhook php Download do código-fonte

Biblioteca PHP de atendimento do Dialogflow

Esta biblioteca é inspirada em dialogflow/dialogflow-fulfillment-nodejs.

Ele oferece suporte a solicitações e respostas JSON de webhook de atendimento do Dialogflow para agentes v1 e v2.

Para referência completa da aula, consulte o documento.

Instalação
Uso
- Iniciar agente
- Obter informações de solicitação
- Enviar resposta
- Mensagem rica
  - Texto
  - Imagem
  - Cartão
  - Sugestão
  - Carga personalizada
- Ações no Google
  - Enviar resposta
  - Respostas
    - Resposta Simples
    - Imagem
    - Cartão Básico
    - Lista
    - Carrossel
    - Carrossel de navegação
    - Chip de sugestão
    - Respostas da mídia
  - Ajudantes
    - Informações do usuário
    - Data e hora
    - Lugar e localização
    - Confirmação
  - Capacidades de superfície

Instalação

Instale via compositor: composer require eristemena/dialogflow-fulfillment-webhook-php .

Uso

Iniciar agente

Para iniciar o agente, use o construtor DialogflowWebhookClient com parâmetro de entrada como matriz de solicitação proveniente do Dialogflow.

No Vanilla PHP, isso pode ser feito da seguinte maneira,

 use Dialogflow  WebhookClient ;

$ agent = new WebhookClient ( json_decode ( file_get_contents ( ' php://input ' ), true ));

// or

$ agent = WebhookClient :: fromData ( $ _POST );

ou se você estiver usando Laravel,

 $ agent =  Dialogflow  WebhookClient :: fromData ( $ request -> json ()-> all ());

Obter informações de solicitação

Intenção

 $ intent = $ agent -> getIntent ();

Ação

 $ action = $ agent -> getAction ();

Consulta

 $ query = $ agent -> getQuery ();

Parâmetros

 $ parameters = $ agent -> getParameters ();

Sessão

 $ session = $ agent -> getSession ();

Contextos

 $ contexts = $ agent -> getContexts ();

Linguagem

 $ language = $ agent -> getLocale ();

Fonte da solicitação (ex: google , facebook , slack , etc)

 $ originalRequest = $ agent -> getRequestSource ();

Solicitação original, carga útil específica da plataforma

 $ originalRequest = $ agent -> getOriginalRequest ();

Versão do agente (1 ou 2)

 $ agentVersion = $ agent -> getAgentVersion ();

Enviar resposta

Para enviar uma resposta, use o método reply() .

 $ agent -> reply ( ' Hi, how can I help? ' );

Em seguida, use render() para obter resposta no array. Tudo que você precisa fazer é imprimir o array como JSON,

 header ( ' Content-type: application/json ' );
echo json_encode ( $ agent -> render ());

ou em Laravel,

 return response ()-> json ( $ agent -> render ());

A carga útil da resposta será formatada automaticamente de acordo com a versão do agente da solicitação.

Mensagem rica

Texto

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

Imagem

 $ image =  Dialogflow  RichMessage  Image :: create ( ' https://www.example.com/image.png ' );
$ agent -> reply ( $ image );

Cartão

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

Sugestão

 $ suggestion =  Dialogflow  RichMessage  Suggestion :: create ([ ' Suggestion one ' , ' Suggestion two ' ]);
$ agent -> reply ( $ suggestion );

Carga personalizada

 if ( $ agent -> getRequestSource ()== ' google ' ) {
    $ agent -> reply ( Dialogflow  RichMessage  Payload :: create ([
        ' expectUserResponse ' => false
    ]));
}

Ações no Google

Esta biblioteca também oferece suporte a funcionalidades específicas do Actions on Google. Ainda está em desenvolvimento, portanto mais recursos serão adicionados no futuro.

Para usar o objeto Actions on Google Dialogflow Conversation, primeiro você precisa garantir que requestSource seja proveniente do 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 );
}

ou você pode simplesmente chamar o método getActionConversation() e ele retornará null se a solicitação não vier do Google Assistente.

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

Enviar resposta

Usando o objeto Dialogflow Conversation, você pode enviar uma resposta de duas maneiras,

Envie uma resposta e feche a conversa

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

Envie uma resposta e aguarde a resposta do usuário

 $ conv -> ask ( ' Hi, how can I help? ' );