Questa guida fornisce le best practice per l'utilizzo del servizio Dialogflow. Queste linee guida sono progettate per una maggiore efficienza e precisione, nonché per tempi di risposta ottimali del servizio.
Consulta anche la guida alla progettazione di agenti generici per tutti i tipi di agenti e la guida alla progettazione di agenti vocali specifica per la progettazione di agenti vocali.
Produzione
Prima di eseguire l'agente in produzione, assicurati di implementare le seguenti best practice:
- Utilizzare le versioni degli agenti
- Riutilizzare i client di sessione
- Implementare la gestione degli errori con i tentativi di nuovo
Abilita audit log
Abilita gli audit log di accesso ai dati per l'API Dialogflow nel tuo progetto. In questo modo puoi monitorare le modifiche apportate in fase di progettazione gli agenti Dialogflow collegati a questo progetto.
Versioni dell'agente
Devi sempre utilizzare le versioni dell'agente per il traffico di produzione. Per informazioni dettagliate, consulta Versioni e ambienti.
Crea il backup dell'agente
Mantieni aggiornato un backup dell'agente esportato. In questo modo potrai recuperare rapidamente se tu o i membri del tuo team eliminate accidentalmente l'agente o il progetto.
Riutilizzo del client
Puoi migliorare il rendimento della tua applicazione riutilizzando le istanze della libreria client *Client
per tutta la durata dell'esecuzione dell'applicazione.
Soprattutto,
puoi migliorare il rendimento delle chiamate API di rilevamento dell'intenzione
riutilizzando un'istanza della libreria client SessionsClient
.
Per ulteriori informazioni, consulta la guida Best practice con le librerie client.
Aggiornamenti batch all'agente
Se invii molte richieste API di aggiornamento degli agenti individualmente in un breve periodo di tempo, le tue richieste potrebbero essere limitate. Questi metodi API di design non sono implementati per gestire tassi di aggiornamento elevati per un singolo agente.
Alcuni tipi di dati hanno metodi batch per questo scopo:
- Anziché inviare molte richieste EntityTypes
create
,patch
odelete
, utilizza i metodibatchUpdate
obatchDelete
. - Invece di inviare molte richieste di intent
create
,patch
odelete
, utilizza i metodibatchUpdate
obatchDelete
.
Nuovi tentativi in caso di errore dell'API
Quando chiami i metodi dell'API, potresti ricevere risposte di errore. Per alcuni errori è necessario riprovare, poiché spesso sono dovuti a problemi temporanei. Ci sono due tipi di errori:
- Errori dell'API Cloud.
- Errori inviati dal servizio webhook.
Inoltre, devi implementare un backoff esponenziale per i tentativi. In questo modo, il sistema può trovare una frequenza accettabile mentre il servizio API è sotto un carico elevato.
Errori dell'API Cloud
Se utilizzi una libreria client fornita da Google, le ripetizioni degli errori dell'API Cloud con backoff esponenziale sono implementate per te.
Se hai implementato la tua libreria client utilizzando REST o gRPC, devi implementare i tentativi di nuovo per il client. Per informazioni sugli errori per i quali devi o non devi riprovare, consulta Proposte di miglioramento dell'API: configurazione del nuovo tentativo automatico.
Errori webhook
Se la chiamata API attiva una chiamata webhook, il webhook potrebbe restituire un errore.
Anche se utilizzi una libreria client fornita da Google,
non verrà eseguito automaticamente un nuovo tentativo per gli errori relativi ai webhook.
Il codice dovrebbe riprovare per gli errori 503 Service Unavailable
ricevuti dal webhook.
Consulta la documentazione del servizio webhook per informazioni sui tipi di errori webhook e su come verificarli.
Test di carico
È buona prassi eseguire test di carico per il sistema prima di rilasciare il codice in produzione. Prendi in considerazione questi punti prima di implementare i test di carico:
Riepilogo | Dettagli |
---|---|
Aumenta il carico. | Il test di carico deve aumentare il carico applicato al servizio Dialogflow. Il servizio non è progettato per gestire picchi improvvisi di carico, che si verificano raramente con il traffico reale. Il servizio ha bisogno di tempo per adeguarsi alle richieste di carico, quindi aumenta lentamente la tasso di richieste finché il test non raggiunge il carico desiderato. |
Le chiamate API sono a pagamento. | Ti verranno addebitate le chiamate API durante un test e le chiamate saranno limitate dalla quota del progetto. |
Utilizza doppioni di test. | Potresti non dover chiamare l'API durante il test di carico. Se lo scopo del test di carico è determinare in che modo il sistema gestisce il carico, spesso è meglio utilizzare un doppio di test anziché le chiamate effettive all'API. La controfigura di test può simulare il comportamento dell'API sotto carico. |
Utilizza i tentativi di nuovo. | Il test di carico deve eseguire riprova con un backoff. |
Chiamare Dialogflow in sicurezza da un dispositivo dell'utente finale
Non devi mai memorizzare le tue chiavi private utilizzate per accedere all'API Dialogflow su un dispositivo dell'utente finale. Questo vale per la memorizzazione delle chiavi direttamente sul dispositivo e per la codifica delle chiavi nelle applicazioni. Quando l'applicazione client deve chiamare l'API Dialogflow, deve inviare richieste a un servizio proxy di proprietà dello sviluppatore su una piattaforma sicura. Il servizio proxy può effettuare le chiamate Dialogflow effettive e autenticate.
Ad esempio, non dovresti creare un'applicazione mobile che chiama direttamente Dialogflow. Per farlo, devi memorizzare le chiavi private su un dispositivo dell'utente finale. L'applicazione mobile deve invece trasmettere le richieste tramite un servizio proxy sicuro.