Guida rapida: crea un webhook

Questa guida mostra come utilizzare un webhook, in modo che l'agente possa essere più dinamico. Per la loro semplicità, Cloud Functions viene utilizzato per ospitare il webhook, ma esistono molti altri modi per ospitare un servizio webhook. Nell'esempio viene utilizzato anche il linguaggio di programmazione Go, ma puoi utilizzare qualsiasi linguaggio supportato da Cloud Functions. Non è necessario modificare il codice di questa guida.

Il codice webhook di esempio:

  • Legge i valori parametro dalla richiesta di webhook.
  • Scrive un valore parametro nella risposta webhook.
  • Fornisce una risposta di testo nella risposta webhook.

Prima di iniziare

Se non prevedi di utilizzare i webhook, puoi saltare questa guida rapida.

Prima di leggere questa guida, effettua le seguenti operazioni:

  1. Leggi le nozioni di base su Dialogflow CX.
  2. Esegui la procedura di configurazione.
  3. Esegui i passaggi nella guida rapida Creazione di un agente. I passaggi riportati di seguito continuano a funzionare per lo stesso agente. Se non hai più l'agente, puoi scaricarlo e ripristinarlo.

Crea la Cloud Function

È possibile creare Cloud Functions con la console Google Cloud (visita la documentazione, apri la console). Per creare una funzione per questa guida:

  1. È importante che l'agente Dialogflow e la funzione siano entrambi nello stesso progetto. Questo è il modo più semplice per Dialogflow di avere accesso sicuro alla tua funzione. Per selezionare il progetto, vai al selettore dei progetti.
  2. Vai alla pagina di riepilogo di Cloud Functions.
  3. Fai clic su Crea funzione e imposta i seguenti campi:
    • Ambiente: 1ª generazione
    • Nome funzione: shirts-agent-webhook
    • Regione: se hai specificato una regione per l'agente, utilizza la stessa regione.
    • Tipo di trigger HTTP: HTTP
    • URL: fai clic sul pulsante di copia qui e salva il valore. Questo URL ti servirà durante la configurazione del webhook.
    • Autenticazione: richiedi l'autenticazione
    • Richiedi HTTPS: selezionato
  4. Fai clic su Salva.
  5. Fai clic su Avanti (non sono necessarie impostazioni di runtime, build, connessioni o sicurezza speciali).
  6. Imposta i seguenti campi:
    • Runtime: seleziona il runtime Go più recente.
    • Codice sorgente: editor incorporato
    • Punto di ingresso: HandleWebhookRequest
  7. Sostituisci il codice con quanto segue: 
    // Package cxwh contains an example Dialogflow CX webhook
package cxwh

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
)

type fulfillmentInfo struct {
	Tag string `json:"tag"`
}

type sessionInfo struct {
	Session    string                 `json:"session"`
	Parameters map[string]interface{} `json:"parameters"`
}

type text struct {
	Text []string `json:"text"`
}

type responseMessage struct {
	Text text `json:"text"`
}

type fulfillmentResponse struct {
	Messages []responseMessage `json:"messages"`
}

// webhookRequest is used to unmarshal a WebhookRequest JSON object. Note that
// not all members need to be defined--just those that you need to process.
// As an alternative, you could use the types provided by the Dialogflow protocol buffers:
// https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#WebhookRequest
type webhookRequest struct {
	FulfillmentInfo fulfillmentInfo `json:"fulfillmentInfo"`
	SessionInfo     sessionInfo     `json:"sessionInfo"`
}

// webhookResponse is used to marshal a WebhookResponse JSON object. Note that
// not all members need to be defined--just those that you need to process.
// As an alternative, you could use the types provided by the Dialogflow protocol buffers:
// https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/dialogflow/cx/v3#WebhookResponse
type webhookResponse struct {
	FulfillmentResponse fulfillmentResponse `json:"fulfillmentResponse"`
	SessionInfo         sessionInfo         `json:"sessionInfo"`
}

// confirm handles webhook calls using the "confirm" tag.
func confirm(request webhookRequest) (webhookResponse, error) {
	// Create a text message that utilizes the "size" and "color"
	// parameters provided by the end-user.
	// This text message is used in the response below.
	t := fmt.Sprintf("You can pick up your order for a %s %s shirt in 5 days.",
		request.SessionInfo.Parameters["size"],
		request.SessionInfo.Parameters["color"])

	// Create session parameters that are populated in the response.
	// The "cancel-period" parameter is referenced by the agent.
	// This example hard codes the value 2, but a real system
	// might look up this value in a database.
	p := map[string]interface{}{"cancel-period": "2"}

	// Build and return the response.
	response := webhookResponse{
		FulfillmentResponse: fulfillmentResponse{
			Messages: []responseMessage{
				{
					Text: text{
						Text: []string{t},
					},
				},
			},
		},
		SessionInfo: sessionInfo{
			Parameters: p,
		},
	}
	return response, nil
}

// handleError handles internal errors.
func handleError(w http.ResponseWriter, err error) {
	w.WriteHeader(http.StatusInternalServerError)
	fmt.Fprintf(w, "ERROR: %v", err)
}

// HandleWebhookRequest handles WebhookRequest and sends the WebhookResponse.
func HandleWebhookRequest(w http.ResponseWriter, r *http.Request) {
	var request webhookRequest
	var response webhookResponse
	var err error

	// Read input JSON
	if err = json.NewDecoder(r.Body).Decode(&request); err != nil {
		handleError(w, err)
		return
	}
	log.Printf("Request: %+v", request)

	// Get the tag from the request, and call the corresponding
	// function that handles that tag.
	// This example only has one possible tag,
	// but most agents would have many.
	switch tag := request.FulfillmentInfo.Tag; tag {
	case "confirm":
		response, err = confirm(request)
	default:
		err = fmt.Errorf("Unknown tag: %s", tag)
	}
	if err != nil {
		handleError(w, err)
		return
	}
	log.Printf("Response: %+v", response)

	// Send response
	if err = json.NewEncoder(w).Encode(&response); err != nil {
		handleError(w, err)
		return
	}
}
  8. Fai clic su Esegui il deployment.
  9. Attendi finché l'indicatore di stato non indica che il deployment della funzione è stato eseguito correttamente. Durante l'attesa, esamina il codice di cui hai appena eseguito il deployment. I commenti al codice descrivono dettagli importanti.

Crea il webhook

Ora che il webhook esiste come funzione Cloud Functions, assocerai questo webhook all'agente. Per creare il webhook per l'agente:

  1. Apri la console Dialogflow CX.
  2. Scegli il tuo progetto Google Cloud.
  3. Seleziona l'agente.
  4. Seleziona la scheda Gestisci.
  5. Fai clic su Webhook.
  6. Fai clic su Crea.
  7. Completa i seguenti campi:
    • Nome visualizzato: shirts-agent-webhook
    • URL webhook: fornisci l'URL webhook che hai salvato durante la creazione della funzione.
    • Sottotipo: standard.
    • Tutti gli altri campi utilizzano valori predefiniti.
  8. Fai clic su Salva.

Utilizzare il webhook

Ora che il webhook è disponibile per l'agente, lo utilizzerai in fulfillment. La pagina Conferma dell'ordine include un evasione della voce, che attualmente presenta una risposta di testo statica. Per aggiornare il fulfillment in modo che utilizzi il webhook:

  1. Seleziona la scheda Crea.
  2. Fai clic sulla pagina Conferma ordine per espandere la pagina nel grafico del generatore di agenti.
  3. Fai clic sul campo Entry Fulfillment nella pagina per aprire il riquadro relativo all'evasione degli ordini.
  4. Elimina il testo di risposta esistente sotto l'intestazione L'agente dice. Quando passi il mouse sopra il testo, viene visualizzato il pulsante Elimina .
  5. Fai clic su Attiva webhook.
  6. Seleziona l'opzione shirts-agent-webhook dal menu a discesa Webhook.
  7. Inserisci confirm nel campo Tag.
  8. Fai clic su Salva.
  9. Chiudi il riquadro di evasione degli ordini.

Screenshot del grafico dell'agente

Il codice webhook di cui è stato eseguito il deployment invia una risposta che crea un parametro denominato cancel-period. Aggiorna l'agente in modo che faccia riferimento a questo parametro nella risposta dell'agente finale per la stessa pagina Conferma ordine:

  1. Fai clic sulla condizione percorso mostrata con una condizione true per aprire il riquadro del percorso.
  2. Scorri verso il basso fino alla sezione Fulfillment del riquadro del percorso e aggiungi il seguente testo di risposta sotto l'intestazione L'agente dice: You can cancel your order within $session.params.cancel-period days. Goodbye.
  3. Fai clic su Salva.
  4. Chiudi il riquadro del percorso.

Screenshot del grafico dell'agente

Testa l'agente nel simulatore

L'agente e il webhook sono pronti per essere testati con il simulatore:

  1. Fai clic su Test Agent (Agente di test).
  2. Inserisci I want to buy a large red shirt e premi Invio.

Poiché hai fornito sia una taglia sia un colore, hai fornito all'agente tutto il necessario per creare un ordine di camicie, in modo che il passaggio venga indirizzato direttamente alla pagina Conferma ordine.

Screenshot del grafico dell'agente

Di seguito vengono descritte le risposte dell'agente:

Risposta Spiegazione
Ok, iniziamo un nuovo ordine. Quando la pagina Nuovo ordine è diventata attiva, è stata chiamata l'evasione degli ordini. La risposta è stata attivata da questo fulfillment.
Hai selezionato una camicia rossa taglia L. Quando sono stati forniti tutti i parametri del modulo per la pagina Nuovo ordine, viene richiamato il controllo del percorso di condizione per la compilazione del modulo. La risposta è stata attivata dal fulfillment per questa route. Anche in questo percorso viene eseguita la transizione alla pagina Conferma ordine.
Puoi ritirare il tuo ordine per una camicia rossa taglia L tra 5 giorni. Il fulfillment della voce per la pagina Conferma dell'ordine chiama il webhook. Visualizza la funzione confirm nel codice del webhook. Questa funzione crea questa risposta di testo e utilizza i parametri forniti nella richiesta webhook.
Puoi annullare l'ordine entro 2 giorni. Arrivederci. La pagina Conferma ordine include una route di condizione con una condizione sempre vera. Questa risposta viene attivata dal fulfillment per quella route. Tieni presente che la risposta utilizza il parametro impostato dal webhook nella risposta webhook.
Indietro
Crea un agente
Avanti
Interazioni con un'integrazione