La funzionalità Suggerimenti articoli di Agent Assist segue una conversazione tra un agente umano e un utente finale e fornisce all'agente umano suggerimenti per documenti pertinenti. Un operatore umano può esaminare questi suggerimenti mentre la conversazione procede e prendere una decisione su quali documenti leggere o condividere con l'utente finale. Puoi utilizzare il suggerimento di articoli per aiutare un operatore umano a comprendere e risolvere i problemi degli utenti finali mentre l'operatore umano e l'utente finale sono in una conversazione.
Agent Assist fornisce modelli di base per il suggerimento di articoli che puoi utilizzare per suggerire articoli ai tuoi agenti. Se vuoi, puoi addestrare un modello personalizzato utilizzando i tuoi dati delle conversazioni caricati per migliorare il rendimento. Se vuoi addestrare un modello di suggerimenti personalizzato da utilizzare con il suggerimento di articoli, contatta il tuo rappresentante di Google.
Questo documento descrive la procedura di utilizzo dell'API per implementare il suggerimento di articoli e ricevere suggerimenti da questa funzionalità durante l'esecuzione. Hai la possibilità di utilizzare la console Agent Assist per testare i risultati dei suggerimenti di articoli in fase di progettazione, ma devi chiamare l'API direttamente in fase di runtime. Per informazioni dettagliate sul test delle prestazioni delle funzionalità utilizzando la console di Agent Assist, consulta la sezione esercitazioni.
Prima di iniziare
Prima di iniziare questa guida, completa le seguenti operazioni:
- Abilita l'API Dialogflow per il tuo progettoGoogle Cloud .
Configurare un profilo di conversazione
Per ricevere suggerimenti da Agent Assist, devi creare una knowledge base contenente i documenti caricati e configurare un profilo di conversazione. Puoi anche eseguire queste azioni utilizzando la console Agent Assist se preferisci non chiamare direttamente l'API.
Creazione di una knowledge base
Prima di poter iniziare a caricare i documenti, devi prima creare una knowledge base
in cui inserirli. Per creare una knowledge base, chiama il metodo create
sul tipo
KnowledgeBase
.
REST
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Google Cloud
- KNOWLEDGE_BASE_DISPLAY_NAME: il nome della knowledge base che vuoi
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/knowledgeBases
Corpo JSON della richiesta:
{ "displayName": "KNOWLEDGE_BASE_DISPLAY_NAME" }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/knowledgeBases/NDA4MTM4NzE2MjMwNDUxMjAwMA", "displayName": "KNOWLEDGE_BASE_DISPLAY_NAME" }
Il segmento di percorso dopo knowledgeBases
contiene il nuovo ID knowledge base.
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Crea un documento della knowledge base
Ora puoi aggiungere documenti alla knowledge base. Per creare un documento nella knowledge base, chiama il metodo create
sul tipo Document
.
Imposta
KnowledgeType
su ARTICLE_SUGGESTION
. Questo esempio utilizza un file HTML con informazioni sull'ordine di reso caricato in un bucket Cloud Storage condiviso pubblicamente. Quando configuri
il suggerimento di articoli nel tuo sistema, i documenti devono essere in uno dei
seguenti formati. Per saperne di più sulle best practice
per i documenti, consulta la documentazione
sui documenti di conoscenza.
Formati dei documenti pertinenti:
- Un file archiviato in un bucket Cloud Storage. Puoi specificare il percorso quando chiami l'API.
- I contenuti di testo di un documento, che puoi inviare in una richiesta API.
- Un URL pubblico.
REST
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Google Cloud
- KNOWLEDGE_BASE_ID: l'ID della knowledge base restituito dalla richiesta precedente
- DOCUMENT_DISPLAY_NAME: il nome del documento di conoscenza desiderato
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/knowledgeBases/KNOWLEDGE_BASE_ID/documents
Corpo JSON della richiesta:
{ "displayName": "DOCUMENT_DISPLAY_NAME", "mimeType": "text/html", "knowledgeTypes": "ARTICLE_SUGGESTION", "contentUri": "gs://agent-assist-public-examples/public_article_suggestion_example_returns.html" }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/operations/ks-add_document-MzA5NTY2MTc5Mzg2Mzc5NDY4OA" }
La risposta è un'operazione a lunga esecuzione, che puoi eseguire il polling per verificare il completamento.
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Creare un profilo di conversazione
Un profilo di conversazione configura un insieme di parametri che controllano i
suggerimenti forniti a un agente durante una conversazione. I passaggi riportati di seguito creano un
ConversationProfile
con un oggetto
HumanAgentAssistantConfig
. Puoi eseguire queste azioni anche utilizzando la console
Agent Assist se preferisci non
chiamare direttamente l'API.
Ti consigliamo di impostare una soglia di confidenza iniziale di 0,44 (0,1 se utilizzi il modello di base legacy). Se necessario, puoi aumentare la soglia oltre l'intervallo consigliato. L'aumento della soglia comporta una maggiore accuratezza e una minore copertura (meno suggerimenti); la diminuzione della soglia comporta una minore accuratezza e una maggiore copertura (più suggerimenti).
I suggerimenti in linea sono attivi per impostazione predefinita. Se vuoi, puoi attivare le notifiche di Cloud Pub/Sub quando configuri il profilo conversazione.
REST
Per creare un profilo di conversazione, chiama il metodocreate
sulla risorsa
ConversationProfile
.
noSmallTalk
: Se true
, i suggerimenti non verranno attivati dopo i messaggi di conversazione informale (ad esempio "ciao", "come stai" e così via). Se false
, i suggerimenti
verranno attivati dopo i messaggi di conversazione spicciola.
onlyEndUser
: se true
, i suggerimenti verranno attivati solo dopo i messaggi dell'utente finale. Se false
, i suggerimenti verranno attivati dopo i messaggi dell'utente finale e dell'agente umano.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Google Cloud
- KNOWLEDGE_BASE_ID: l'ID della knowledge base
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversationProfiles
Corpo JSON della richiesta:
{ "name": "projects/PROJECT_ID/conversationProfiles/CONVERSATION_PROFILE_ID", "displayName": "my-conversation-profile-display-name", "humanAgentAssistantConfig": { "notificationConfig": {}, "humanAgentSuggestionConfig": { "featureConfigs": [ { "enableInlineSuggestion": true, "SuggestionTriggerSettings": { "noSmallTalk": true, "onlyEndUser": true, }, "suggestionFeature": { "type": "ARTICLE_SUGGESTION" }, "queryConfig": { "knowledgeBaseQuerySource": { "knowledgeBases": [ "projects/PROJECT_ID/knowledgeBases/KNOWLEDGE_BASE_ID" ] } } } ] } }, "sttConfig": {}, "languageCode": "en-US" }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/conversationProfiles/CONVERSATION_PROFILE_ID", "displayName": "my-conversation-profile-display-name", "humanAgentAssistantConfig": { ... } }
Il segmento di percorso dopo conversationProfiles
contiene il nuovo ID profilo
di conversazione.
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
(Facoltativo) Impostare le impostazioni di sicurezza
Hai la possibilità di impostare parametri di sicurezza per risolvere problemi come
l'oscuramento e la conservazione dei dati. Per farlo, devi creare una risorsa
SecuritySettings
e poi collegarla a un profilo conversazionale utilizzando il campo
securitySettings
.
Le impostazioni di sicurezza aggiunte a un profilo di conversazione influiscono sul comportamento dei messaggi di testo di Agent Assist soltanto. Il comportamento della cronologia delle interazioni di Dialogflow è controllato dalle impostazioni di sicurezza di Dialogflow, che puoi configurare utilizzando la console Dialogflow CX.
Gestire le conversazioni in fase di runtime
Creare una conversazione
Quando inizia un dialogo tra un utente finale e un agente umano o virtuale, crei una conversazione. Per visualizzare i suggerimenti, devi anche creare un partecipante utente finale e un partecipante agente umano e aggiungerli alla conversazione. Le sezioni seguenti illustrano questa procedura.
Innanzitutto, devi creare una conversazione:
REST
Per creare una conversazione, chiama il metodocreate
sulla risorsa
Conversation
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Cloud
- LOCATION_ID: il tuo ID località
- CONVERSATION_PROFILE_ID: l'ID che hai ricevuto durante la creazione del profilo di conversazione
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations
Corpo JSON della richiesta:
{ "conversationProfile": "projects/PROJECT_ID/locations/LOCATION_ID/conversationProfiles/CONVERSATION_PROFILE_ID", }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID", "lifecycleState": "IN_PROGRESS", "conversationProfile": "projects/PROJECT_ID/locations/LOCATION_ID/conversationProfiles/CONVERSATION_PROFILE_ID", "startTime": "2018-11-05T21:05:45.622Z" }
Il segmento del percorso dopo conversations
contiene il nuovo ID conversazione.
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Crea un partecipante utente finale
Per visualizzare i suggerimenti, devi aggiungere alla conversazione sia i partecipanti utenti finali sia quelli agenti umani. Innanzitutto, aggiungi il partecipante utente finale alla conversazione:
REST
Per creare un partecipante utente finale, chiama il metodo create
sulla risorsa
Participant
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Cloud
- LOCATION_ID: il tuo ID località
- CONVERSATION_ID: il tuo ID conversazione
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants
Corpo JSON della richiesta:
{ "role": "END_USER", }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID", "role": "END_USER" }
Il segmento di percorso dopo participants
contiene il nuovo ID partecipante utente finale.
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Crea un partecipante agente umano
Aggiungi un partecipante agente umano alla conversazione:
REST
Per creare un partecipante agente umano, chiama il metodo create
sulla risorsa
Participant
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Cloud
- LOCATION_ID: il tuo ID località
- CONVERSATION_ID: il tuo ID conversazione
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants
Corpo JSON della richiesta:
{ "role": "HUMAN_AGENT", }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID", "role": "HUMAN_AGENT" }
Il segmento di percorso dopo participants
contiene il nuovo ID partecipante dell'agente umano.
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Aggiungere e analizzare un messaggio dell'agente umano
Ogni volta che uno dei partecipanti digita un messaggio nella conversazione, devi inviarlo all'API per l'elaborazione. Agent Assist basa i suoi suggerimenti sull'analisi dei messaggi degli agenti umani e degli utenti finali. Nell'esempio seguente, l'operatore umano inizia la conversazione chiedendo "Come posso aiutarti?". Nella risposta non sono ancora stati restituiti suggerimenti.
REST
Per aggiungere e analizzare un messaggio dell'agente umano nella conversazione, chiama il metodo
analyzeContent
nella risorsa
Participant
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Google Cloud
- CONVERSATION_ID: il tuo ID conversazione
- PARTICIPANT_ID: il tuo ID partecipante agente umano
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent
Corpo JSON della richiesta:
{ "textInput": { "text": "How may I help you?", "languageCode": "en-US" } }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "message": { "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID", "content": "How may I help you?", "languageCode": "en-US", "participant": "PARTICIPANT_ID", "participantRole": "HUMAN_AGENT", "createTime": "2020-02-13T00:01:30.683Z" }, "humanAgentSuggestionResults": [ { "suggestArticlesResponse": { "latestMessage": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID", "contextSize": 1 } } ] } } ] }
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Aggiungi un messaggio dell'utente finale e ricevi suggerimenti
In risposta all'agente umano, l'utente finale dice "Voglio restituire il mio ordine". Questa volta, la risposta dell'API contiene un documento suggerito con il relativo punteggio di affidabilità. In precedenza in questo tutorial abbiamo aggiunto un documento della knowledge base alla knowledge base e questo documento è stato restituito. I punteggi di affidabilità vanno da 0 a 1; i valori più alti indicano una maggiore probabilità che il documento sia pertinente alla conversazione. Viene restituito anche uno snippet contenente i primi 100 caratteri del documento. Lo snippet può aiutare un operatore umano a determinare rapidamente se il documento è utile. Ti consigliamo di fornire queste informazioni all'operatore umano, che potrebbe scegliere di condividere il documento consigliato con l'utente finale.
REST
Per aggiungere e analizzare un messaggio dell'utente finale per la conversazione, chiama il metodo
analyzeContent
sulla risorsa
Participant
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Google Cloud
- CONVERSATION_ID: il tuo ID conversazione
- PARTICIPANT_ID: il tuo ID partecipante utente finale
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent
Corpo JSON della richiesta:
{ "textInput": { "text": "I want to return my order.", "languageCode": "en-US" } }
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "message": { "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID", "content": "I want to return my order.", "languageCode": "en-US", "participant": "PARTICIPANT_ID", "participantRole": "END_USER", "createTime": "2020-02-13T00:07:35.925Z" }, "humanAgentSuggestionResults": [ { "suggestArticlesResponse": { "articleAnswers": [ { "title": "Return an order", "uri": "gs://agent-assist-public-examples/public_article_suggestion_example_returns.html", "snippets": [ "\u003cb\u003eReturn\u003c/b\u003e an \u003cb\u003eorder\u003c/b\u003e. Follow the steps below for Made-up Store \u003cb\u003ereturns\u003c/b\u003e. At this time, \nwe don't offer exchanges. In most cases, you can drop off \u003cb\u003ereturns\u003c/b\u003e at any Made-up\n ..." ], "metadata": { "title": "Return an order", "snippet": "\n \n\n\u003ch1\u003eReturn an order\u003c/h1\u003e \nFollow the steps below for Made-up Store returns. At this time, we do...", "document_display_name": "my-kdoc" }, "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID" } ], "latestMessage": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID", "contextSize": 2 } } ] }
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Completare la conversazione
Al termine della conversazione, utilizza l'API per completarla.
REST
Per completare la conversazione, chiama il metodocomplete
sulla risorsa
conversations
.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
- PROJECT_ID: il tuo ID progetto Google Cloud
- CONVERSATION_ID: l'ID che hai ricevuto durante la creazione della conversazione
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID:complete
Per inviare la richiesta, espandi una di queste opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID", "lifecycleState": "COMPLETED", "conversationProfile": "projects/PROJECT_ID/conversationProfiles/CONVERSATION_PROFILE_ID", "startTime": "2018-11-05T21:05:45.622Z", "endTime": "2018-11-06T03:50:26.930Z" }
Python
Per eseguire l'autenticazione in Agent Assist, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Opzioni di richiesta API
Le sezioni precedenti mostrano come creare un semplice
ConversationProfile
per ricevere suggerimenti. Le sezioni seguenti descrivono alcune funzionalità opzionali
che puoi implementare durante una conversazione.
Notifiche di suggerimento Pub/Sub
Nelle sezioni precedenti, il
ConversationProfile
è stato creato solo con un assistente agente umano. Durante la conversazione,
era necessario chiamare l'API per ricevere suggerimenti dopo l'aggiunta di ogni messaggio
alla conversazione. Se preferisci ricevere eventi di notifica per i suggerimenti,
puoi impostare il campo notificationConfig
quando crei il profilo
della conversazione. Questa opzione utilizza Cloud Pub/Sub per inviare notifiche
di suggerimento alla tua applicazione man mano che la conversazione procede e nuovi
suggerimenti sono disponibili.