dialogflow fulfillment webhook php Download - dialogflow fulfillment webhook php Quellcode herunterladen

Dialogflow Fulfillment PHP-Bibliothek

Diese Bibliothek ist von dialogflow/dialogflow-fulfillment-nodejs inspiriert.

Es unterstützt die Erfüllung von Webhook-JSON-Anfragen und -Antworten von Dialogflow für v1- und v2-Agenten.

Die vollständige Klassenreferenz finden Sie im Dokument.

Installation
Verwendung
- Agent einleiten
- Holen Sie sich Informationen zur Anfrage
- Antwort senden
- Reichhaltige Botschaft
  - Text
  - Bild
  - Karte
  - Anregung
  - Benutzerdefinierte Nutzlast
- Aktionen bei Google
  - Antwort senden
  - Antworten
    - Einfache Antwort
    - Bild
    - Basiskarte
    - Liste
    - Karussell
    - Karussell durchsuchen
    - Vorschlag Chip
    - Medienreaktionen
  - Helfer
    - Benutzerinformationen
    - Datum und Uhrzeit
    - Ort und Lage
    - Bestätigung
  - Oberflächenfähigkeiten

Installation

Installation über Composer: composer require eristemena/dialogflow-fulfillment-webhook-php .

Verwendung

Agent einleiten

Um den Agenten zu initiieren, verwenden Sie den Konstruktor DialogflowWebhookClient mit dem Eingabeparameter als Array der von Dialogflow kommenden Anfrage.

In Vanilla PHP kann dies wie folgt erfolgen:

 use Dialogflow  WebhookClient ;

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

// or

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

oder wenn Sie Laravel verwenden,

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

Holen Sie sich Informationen zur Anfrage

Absicht

 $ intent = $ agent -> getIntent ();

Aktion

 $ action = $ agent -> getAction ();

Abfrage

 $ query = $ agent -> getQuery ();

Parameter

 $ parameters = $ agent -> getParameters ();

Sitzung

 $ session = $ agent -> getSession ();

Kontexte

 $ contexts = $ agent -> getContexts ();

Sprache

 $ language = $ agent -> getLocale ();

Anfragequelle (z. B. google , facebook , slack usw.)

 $ originalRequest = $ agent -> getRequestSource ();

Ursprüngliche Anfrage, plattformspezifische Nutzlast

 $ originalRequest = $ agent -> getOriginalRequest ();

Agent-Version (1 oder 2)

 $ agentVersion = $ agent -> getAgentVersion ();

Antwort senden

Um eine Antwort zu senden, verwenden Sie die Methode reply() .

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

Verwenden Sie dann render() um eine Antwort im Array zu erhalten. Sie müssen lediglich das Array als JSON drucken.

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

oder in Laravel,

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

Die Antwortnutzlast wird automatisch entsprechend der Agent-Version der Anfrage formatiert.

Reichhaltige Botschaft

Text

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

Bild

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

Karte

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

Anregung

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

Benutzerdefinierte Nutzlast

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

Aktionen bei Google

Diese Bibliothek unterstützt auch Actions on Google-spezifische Funktionen. Es befindet sich noch in der Entwicklung, daher werden in Zukunft weitere Funktionen hinzugefügt.

Um Aktionen im Google Dialogflow-Konversationsobjekt zu verwenden, müssen Sie zunächst sicherstellen, dass die requestSource von Google Assistant stammt.

 if ( $ agent -> getRequestSource ()== ' google ' ) {
    $ conv = $ agent -> getActionConversation ();
    
    // here you can use the rest of Actions on Google responses and helpers
    
    $ agent -> reply ( $ conv );
}

Oder Sie rufen einfach die Methode getActionConversation() auf. Sie gibt null zurück, wenn die Anfrage nicht von Google Assistant kommt.

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

Antwort senden

Mit dem Dialogflow-Konversationsobjekt können Sie eine Antwort auf zwei Arten senden:

Senden Sie eine Antwort und schließen Sie die Konversation

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

Senden Sie eine Antwort und warten Sie auf die Antwort des Benutzers

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