Anatomia di un messaggio

Una singola chiamata API /message è equivalente a un singolo turno in una conversazione, che consiste in un messaggio che viene inoltrato da un cliente e una risposta corrispondente dal tuo assistente.

Ogni risposta che un cliente effettua in risposta a una richiesta dell'assistente viene passata come una chiamata API /message indipendente.

Il corpo della richiesta e della risposta della chiamata API /message include i seguenti oggetti:

  • context: contiene le variabili che devono essere conservate. Affinché la finestra di dialogo faccia riferimento alle informazioni inoltrate dall'utente, è necessario memorizzare le informazioni nell'oggetto di contesto. Ad esempio, il dialogo può raccogliere il nome dell'utente e quindi fare riferimento all'utente utilizzando il nome nei nodi successivi. Il seguente esempio mostra come viene rappresentato l'oggetto context nell'editor JSON del dialogo:

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

    Per ulteriori informazioni, vedi Conservazione delle informazioni tra i turni di dialogo.

  • input: la stringa di testo che è stata inoltrata dall'utente. La stringa di testo può contenere fino a 2.048 caratteri. L'esempio seguente mostra come viene rappresentato l'oggetto input nell'editor JSON della finestra di dialogo:

    {
      "input" : {
        "text" : "Where's your nearest store?"
      }
    
  • output: la risposta del dialogo da restituire all'utente. Il seguente esempio mostra come viene rappresentato l'oggetto output nell'editor JSON del dialogo:

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

Nella risposta API /message risultante, la risposta di testo è formattata come segue:

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

È possibile definire più tipi di risposta diversi da una risposta di testo. Per ulteriori dettagli, vedi Risposte.

Per ulteriori informazioni sulla chiamata API /message, vedi la Guida di riferimento API.

Per informazioni su come fare riferimento a questi oggetti messaggio in una conversazione, consultare Espressioni per l'accesso agli oggetti.

Visualizzazione dei dettagli della chiamata API

Durante il test della conversazione, si potrebbe voler conoscere l'aspetto delle chiamate API sottostanti che vengono restituite dal servizio. È possibile utilizzare gli strumenti per sviluppatori forniti dal browser web per ispezionarli.

Da Chrome, ad esempio:

  1. Aprire gli strumenti per lo sviluppatore.

  2. Aprire lo strumento Rete. La sezione Nome elenca più chiamate API.

  3. Fare clic sulla chiamata del messaggio associata alla propria espressione di test

  4. Fai clic sulla colonna Risposta per vedere il corpo della risposta API. Elenca gli intenti e le entità riconosciuti nell'input utente con i relativi punteggi di affidabilità. Inoltre, elenca i valori delle variabili di contesto al momento della chiamata.

Mostra come visualizzare i dettagli della chiamata API utilizzando gli strumenti dello sviluppatore del browser web Chrome.
Utilizza gli strumenti di sviluppo Chrome per visualizzare la risposta API

  1. Per visualizzare il corpo della risposta in formato strutturato, fare clic sulla colonna Anteprima.