Una Knowledge Base rappresenta una raccolta di documenti informativi. che fornisci a Dialogflow. I tuoi documenti della conoscenza contengono informazioni che possono essere utili durante le conversazioni con gli utenti finali. Alcune funzionalità di Dialogflow utilizzano le basi di conoscenza quando cercano una risposta a un'espressione dell'utente finale. Questa guida descrive come creare e gestire le knowledge base.
Una knowledge base viene applicata a livello di agente.
Prima di iniziare
Prima di leggere questa guida, devi:
- Leggi le nozioni di base su Dialogflow.
- Esegui la procedura di configurazione.
Creazione di una knowledge base
Gli esempi di seguito mostrano come
utilizzare la console di Dialogflow, l'API REST (compresa la riga di comando),
librerie client o librerie per creare una knowledge base.
Per utilizzare l'API, chiama il metodo create
sul tipo KnowledgeBase
.
UI web
Utilizza la console di Dialogflow per creare una knowledge base:- Vai alla console Dialogflow ES.
- Select an agent
- Fai clic su Conoscenza nel menu della barra laterale sinistra.
- Fai clic su Crea knowledge base.
- Inserisci un nome per la knowledge base
- Fai clic su Salva.
REST
Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo progetto Google Cloud
- KNOWLEDGE_BASE_DISPLAY_NAME: nome desiderato della knowledge base
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2beta1/projects/PROJECT_ID/knowledgeBases
Corpo JSON della richiesta:
{ "displayName": "KNOWLEDGE_BASE_DISPLAY_NAME" }
Per inviare la richiesta, espandi una delle seguenti opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/knowledgeBases/NDA4MTM4NzE2MjMwNDUxMjAwMA", "displayName": "KNOWLEDGE_BASE_DISPLAY_NAME" }
Prendi nota del valore del campo name
.
Questo è il nome della nuova knowledge base.
Il segmento di percorso dopo knowledgeBases
è il tuo nuovo ID della knowledge base.
Salva questo ID per le richieste riportate di seguito.
Java
Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Aggiungere un documento alla knowledge base
La tua nuova knowledge base al momento non contiene documenti, quindi dovresti aggiungere un documento. Consulta la sezione Contenuti supportati di seguito per una descrizione di tutte le opzioni di contenuti supportate. Puoi utilizzare lo Domande frequenti su Cloud Storage per questo esempio.
Gli esempi riportati di seguito mostrano come utilizzare la console Dialogflow, l'API REST (inclusa la riga di comando) o le librerie client per creare un documento del knowledge base.
Per utilizzare l'API, chiama il metodo create
sul tipo
Document
.
UI web
Utilizza la console Dialogflow per creare un documento informativo:- Se non prosegui con i passaggi precedenti,
vai alle impostazioni della knowledge base:
- Vai alla console Dialogflow ES.
- Select an agent
- Fai clic su Conoscenza nel menu della barra laterale sinistra.
- Fai clic sul nome della knowledge base.
- Fai clic su Nuovo documento o Crea il primo.
- Inserisci un nome per il documento
- Seleziona text/html per Tipo MIME
- Seleziona Domande frequenti per Tipo di conoscenza.
- Seleziona URL per Origine dati.
- Inserisci https://cloud.google.com/storage/docs/faq nel campo URL
- Fai clic su CREA.
REST
Prima di utilizzare i dati della richiesta, effettua le seguenti sostituzioni:
- PROJECT_ID: l'ID del tuo progetto Google Cloud
- KNOWLEDGE_BASE_ID: l'ID della knowledge base restituito dalla richiesta precedente
- DOCUMENT_DISPLAY_NAME: nome desiderato del documento informativo
Metodo HTTP e URL:
POST https://dialogflow.googleapis.com/v2beta1/projects/PROJECT_ID/knowledgeBases/KNOWLEDGE_BASE_ID/documents
Corpo JSON della richiesta:
{ "displayName": "DOCUMENT_DISPLAY_NAME", "mimeType": "text/html", "knowledgeTypes": "FAQ", "contentUri": "https://cloud.google.com/storage/docs/faq" }
Per inviare la richiesta, espandi una delle seguenti opzioni:
Dovresti ricevere una risposta JSON simile alla seguente:
{ "name": "projects/PROJECT_ID/operations/ks-add_document-MzA5NTY2MTc5Mzg2Mzc5NDY4OA" }
Il segmento di percorso dopo operations
è l'ID operazione.
Java
Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
La creazione di un documento è un'operazione a lunga esecuzione, quindi il completamento potrebbe richiedere molto tempo. Puoi verificare lo stato di questa operazione per verificare se è stata completata. Al termine, l'operazione conterrà l'ID documento appena creato. Salva questo ID per elaborazioni future. Per ulteriori informazioni, vedi Operazioni a lunga esecuzione.
Gestisci i documenti informativi
Aggiornare i contenuti del documento informativo
Se aggiorni i contenuti a cui fa riferimento un documento della conoscenza, il documento della conoscenza potrebbe non aggiornarsi automaticamente. I contenuti vengono aggiornati automaticamente solo se vengono forniti come URL pubblico e se hai selezionato l'opzione Attiva ricarica automatica per il documento.
Per aggiornare manualmente i contenuti dei documenti di Cloud Storage o dell'URL pubblico,
chiama il metodo reload
nella
Document
di testo.
Per aggiornare manualmente i contenuti non elaborati caricati,
usa i metodi delete
e create
nella
Document
:
per ricreare il documento.
Elenca documenti informativi
Puoi elencare tutti i documenti informativi relativi alla tua knowledge base.
Per utilizzare l'API, chiama il metodo list
nella
Document
di testo.
Elimina i documenti informativi
Puoi eliminare i documenti informativi per la tua knowledge base.
Per utilizzare l'API, chiama il metodo delete
nella
Document
di testo.
Se non disponi dell'ID documento,
puoi elencare i documenti come descritto sopra.
Contenuti supportati
Sono supportati i seguenti tipi di documenti informativi:
- Domande frequenti: il contenuto del documento contiene coppie di domanda e risposta. in formato HTML o CSV. I tipici formati HTML delle domande frequenti vengono analizzati in modo accurato, ma potrebbe non essere possibile analizzare formati insoliti. Il file CSV deve includere le domande nella prima colonna e le risposte nella seconda, senza intestazione. A causa di questo formato esplicito, vengono sempre analizzati in modo accurato.
- Controllo qualità estrattivo: documenti per i quali viene estratto il testo non strutturato e utilizzato per rispondere alle domande.
La seguente tabella mostra i tipi MIME supportati per Tipo di conoscenza e Origine.
Conoscenza Digita \ Origine | File caricato (Document.content) (NON consigliato) | File caricato (Document.raw_content) (consigliato) | File da Cloud Storage (Document.contentUri) | File dall'URL pubblico (Document.contentUri) |
---|---|---|---|---|
Domande frequenti | text/csv | text/csv | text/csv | testo/html |
QA per il recupero di informazioni | testo/normale, testo/html | testo/normale, testo/html, application/pdf | testo/normale, testo/html, application/pdf | N/D |
I contenuti dei documenti presentano i seguenti problemi noti, limitazioni e best practice:
Informazioni generali:
- I file di URL pubblici devono essere stati sottoposti a scansione dall'indicizzatore della Ricerca Google. in modo che esistano nell'indice di ricerca. Puoi verificarlo con Google Search Console. Tieni presente che l'indicizzatore non mantiene aggiornati i tuoi contenuti. Devi aggiornare esplicitamente il documento informativo quando cambiano i contenuti di origine.
- I file CSV devono utilizzare le virgole come delimitatori.
- I punteggi di affidabilità non sono ancora calibrati tra le domande frequenti e gli articoli della knowledge base, Pertanto, se utilizzi sia articoli della sezione Domande frequenti sia articoli della knowledge base, il risultato migliore potrebbe non essere sempre il più alto.
- Dialogflow rimuove i tag HTML dai contenuti durante la creazione delle risposte. Per questo motivo, è meglio evitare i tag HTML e utilizzare il testo normale, se possibile.
- Le risposte dell'Assistente Google hanno un limite di 640 caratteri per fumetto della chat. le risposte lunghe vengono troncate durante l'integrazione con l'Assistente Google.
- La dimensione massima dei documenti è 50 MB.
- Quando utilizzi i file Cloud Storage, devi utilizzare URI pubblici oppure URI privati a cui ha accesso il tuo account utente o il tuo account di servizio.
Informazioni specifiche sulle domande frequenti:
- Il file CSV deve includere le domande nella prima colonna e le risposte nella seconda, senza intestazione.
- Utilizza il formato CSV quando possibile, perché il file CSV viene analizzato in modo più accurato.
- I contenuti HTML pubblici con una singola coppia di QA non sono supportati.
- Il numero di coppie di QA in un documento non deve superare 2000.
- Non sono supportate domande duplicate con risposte diverse.
- Puoi utilizzare qualsiasi documento sulle domande frequenti; l'analizzatore sintattico delle domande frequenti è in grado di gestire la maggior parte dei formati delle domande frequenti.
Specifico per il QA estrattivo:
- Il QA estrattivo è attualmente in fase sperimentale. Si basa su tecnologie simili provate e testati da Google in prodotti quali la Ricerca e l'assistente. Inviaci il tuo feedback su come funziona per Dialogflow.
- I contenuti con testo denso sono i migliori. Evita contenuti con molti paragrafi di una sola frase.
- Tabelle ed elenchi non sono supportati.
- Il numero di paragrafi in un documento non deve essere superiore a 2000.
- Se un articolo è lungo (più di 1000 parole), prova a suddividerlo in più articoli di dimensioni inferiori. Se l'articolo tratta più problemi, può essere suddiviso in articoli più brevi che trattano i singoli problemi. Se l'articolo tratta un solo problema, quindi concentrati sull'articolo sulla descrizione del problema, e fai in modo che la risoluzione del problema sia breve.
- Idealmente, dovrebbero essere forniti solo i contenuti principali di un articolo (descrizione e risoluzione del problema). Contenuti aggiuntivi come nome dell'autore, cronologia delle modifiche, link correlati, e gli annunci non sono importanti.
- Prova a includere una descrizione dei problemi per i quali un articolo può essere d'aiuto e/o query di esempio a cui questo articolo può rispondere.
Utilizzo di Cloud Storage
Se i tuoi contenuti non sono pubblici, la soluzione consigliata è archiviarli in Cloud Storage. Quando crei documenti informativi, fornisci gli URL per gli oggetti Cloud Storage.
Creazione di bucket e oggetti Cloud Storage
Quando crei il bucket Cloud Storage:
- Assicurati di aver selezionato il progetto Google Cloud che utilizzi per Dialogflow.
- Assicurati che l'account utente o l'account di servizio che usi normalmente per accedere all'API Dialogflow ha autorizzazioni di lettura agli oggetti del bucket.
- Utilizza la classe Standard Storage.
- Imposta la località del bucket
alla sede più vicina a te.
Per alcune chiamate API, ti servirà l'ID posizione (ad es.
us-west1
), quindi prendi nota della tua scelta.
Segui la guida rapida di Cloud Storage. istruzioni per creare un bucket e caricare i file.
Fornire un oggetto Cloud Storage a un documento della knowledge base
Per fornire i tuoi contenuti:
- Crea una knowledge base come descritto sopra.
- Crea un documento informativo come
descritto sopra.
Quando chiami il metodo
create
sul tipoDocument
, imposta il campocontentUri
sull'URL del documento Cloud Storage. Il formato di questo URL ègs://bucket-name/object-name
.