Aufbau einer Nachricht

Ein einzelner /message-API-Aufruf entspricht einem einzelnen Turnus in einem Dialog, der aus einer vom Kunden übergebenen Nachricht und einer entsprechenden Antwort von Ihrem Assistenten besteht.

Jede Antwort eines Kunden auf eine Eingabeaufforderung des Assistenten wird als unabhängiger /message-API-Aufruf übergeben.

Der Hauptteil des API-Aufrufs /message mit zugehöriger Anforderung und Antwort enthält die folgenden Objekte:

• context: Enthält die Variablen, die als persistent definiert werden sollen. Damit der Dialog auf Informationen verweisen kann, die vom Benutzer übermittelt wurden, müssen Sie die Informationen im Kontextobjekt speichern. Das Dialogmodul kann zum Beispiel den Benutzernamen erfassen und in den nachfolgenden Knoten über diesen Namen auf den Benutzer verweisen. Das folgende Beispiel zeigt, wie das Kontextobjekt im JSON-Editor für das Dialogmodul dargestellt wird:

  {
    "context" : {
      "user_name" : "<? @name.literal ?>"
    }
  

  Weitere Informationen finden Sie unter Informationen über Dialogmodulumgänge hinweg erhalten.

• input: Die vom Benutzer übermittelte Textzeichenfolge. Die Textzeichenfolge kann maximal 2.048 Zeichen umfassen. Das folgende Beispiel zeigt, wie das Objekt input im JSON-Editor für das Dialogmodul dargestellt wird:

  {
    "input" : {
      "text" : "Where's your nearest store?"
    }
  

• output: Die Antwort des Dialogmoduls, die an den Benutzer zurückgegeben werden soll. Das folgende Beispiel zeigt, wie das Ausgabeobjekt im JSON-Editor für das Dialogmodul dargestellt wird:

  {
  "output": {
    "generic": [
      {
        "values": [
          {
            "text": "This is my response text."
          }
        ],
        "response_type": "text",
        "selection_policy": "sequential"
      }
    ]
  }
  }
  

In der resultierenden Antwort auf den API-Aufruf /message ist die Textantwort wie folgt formatiert:

{
   "text": "This is my response text.",
   "response_type": "text"
}

Sie können mehr Antworttypen als eine Textantwort definieren. Weitere Details enthält der Abschnitt Antworten.

Weitere Informationen zum API-Aufruf /message finden Sie in der API-Referenz.

Informationen zum Referenzieren dieser Nachrichtenobjekte in einem Dialog finden Sie unter Ausdrücke für den Zugriff auf Objekte.

Details zu API-Aufrufen anzeigen

Beim Testen Ihres Dialogs möchten Sie möglicherweise wissen, wie die zugrunde liegenden API-Aufrufe aussehen, die vom Service zurückgegeben werden. Sie können die von Ihrem Webbrowser bereitgestellten Entwicklerwerkzeuge verwenden, um sie zu prüfen.

In Chrome zum Beispiel:

1. Öffnen Sie die Entwicklertools.

2. Öffnen Sie das Tool "Netzwerk". Der Abschnitt Name listet mehrere API-Aufrufe auf.

3. Klicken Sie auf den Nachrichtenaufruf, der Ihrer Testäußerung zugeordnet ist.

4. Klicken Sie auf die Spalte Antwort, um den API-Antworthauptteil anzuzeigen. Es listet die Absichten und Entitäten auf, die in der Benutzereingabe mit ihren Konfidenzscores erkannt wurden. Außerdem werden die Werte von Kontextvariablen zum Zeitpunkt des Aufrufs aufgelistet.

1. Klicken Sie auf die Spalte Vorschau, um den Antworttext in strukturiertem Format anzuzeigen.