Gestione delle knowledge base

Una knowledge base rappresenta una raccolta di documentazione informativa che fornisci a Dialogflow. I documenti informativi contengono informazioni che possono essere utili durante le conversazioni con gli utenti finali. Alcune funzionalità di Dialogflow utilizzano le knowledge base per cercare 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, effettua le seguenti operazioni:

  1. Leggi le nozioni di base di Dialogflow.
  2. Esegui la procedura di configurazione.

Creazione di una knowledge base

Gli esempi riportati di seguito mostrano come utilizzare la console di Dialogflow, l'API REST (inclusa la riga di comando) o le librerie client per creare una knowledge base. Per utilizzare l'API, chiama il metodo create nel tipo KnowledgeBase.

UI web

Utilizza la console di Dialogflow per creare una knowledge base:

  1. Vai alla console Dialogflow ES.
  2. Select an agent
  3. Fai clic su Conoscenza nel menu della barra laterale di sinistra
  4. Fai clic su Crea Knowledge Base
  5. Inserisci un nome per la knowledge base
  6. 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 della knowledge base desiderato

Metodo HTTP e URL: 

POST https://dialogflow.googleapis.com/v2beta1/projects/PROJECT_ID/knowledgeBases

Corpo JSON 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"
}

Prendi nota del valore del campo name. Questo è il nome della tua nuova knowledge base. Il segmento di percorso dopo knowledgeBases sarà il tuo nuovo ID della knowledge base. Salva questo ID per le richieste seguenti.

Java

Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 


import com.google.api.gax.rpc.ApiException;
import com.google.cloud.dialogflow.v2.KnowledgeBase;
import com.google.cloud.dialogflow.v2.KnowledgeBasesClient;
import com.google.cloud.dialogflow.v2.LocationName;
import java.io.IOException;

public class KnowledgeBaseManagement {

  public static void main(String[] args) throws ApiException, IOException {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project-id";
    String location = "my-location";

    // Set display name of the new knowledge base
    String knowledgeBaseDisplayName = "my-knowledge-base-display-name";

    // Create a knowledge base
    createKnowledgeBase(projectId, location, knowledgeBaseDisplayName);
  }

  // Create a Knowledge base
  public static void createKnowledgeBase(String projectId, String location, String displayName)
      throws ApiException, IOException {
    // Instantiates a client
    try (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
      KnowledgeBase targetKnowledgeBase =
          KnowledgeBase.newBuilder().setDisplayName(displayName).build();
      LocationName parent = LocationName.of(projectId, location);
      KnowledgeBase createdKnowledgeBase =
          knowledgeBasesClient.createKnowledgeBase(parent, targetKnowledgeBase);
      System.out.println("====================");
      System.out.format("Knowledgebase created:\n");
      System.out.format("Display Name: %s\n", createdKnowledgeBase.getDisplayName());
      System.out.format("Name: %s\n", createdKnowledgeBase.getName());
    }
  }
}

Node.js

Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 

// Imports the Dialogflow client library
const dialogflow = require('@google-cloud/dialogflow').v2beta1;

// Instantiate a DialogFlow client.
const client = new dialogflow.KnowledgeBasesClient();

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// const projectId = 'ID of GCP project associated with your Dialogflow agent';
// const displayName = `your knowledge base display name, e.g. myKnowledgeBase`;

const formattedParent = 'projects/' + projectId;
const knowledgeBase = {
  displayName: displayName,
};
const request = {
  parent: formattedParent,
  knowledgeBase: knowledgeBase,
};

const [result] = await client.createKnowledgeBase(request);
console.log(`Name: ${result.name}`);
console.log(`displayName: ${result.displayName}`);

Python

Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 

def create_knowledge_base(project_id, display_name):
    """Creates a Knowledge base.

    Args:
        project_id: The GCP project linked with the agent.
        display_name: The display name of the Knowledge base."""
    from google.cloud import dialogflow_v2beta1 as dialogflow

    client = dialogflow.KnowledgeBasesClient()
    project_path = client.common_project_path(project_id)

    knowledge_base = dialogflow.KnowledgeBase(display_name=display_name)

    response = client.create_knowledge_base(
        parent=project_path, knowledge_base=knowledge_base
    )

    print("Knowledge Base created:\n")
    print("Display Name: {}\n".format(response.display_name))
    print("Name: {}\n".format(response.name))

Aggiungere un documento alla knowledge base

La tua nuova knowledge base al momento non ha documenti, quindi devi aggiungervi un documento. Consulta la sezione Contenuti supportati di seguito per una descrizione di tutte le opzioni di contenuti supportate. Per questo esempio puoi utilizzare il documento Domande frequenti su Cloud Storage.

Gli esempi riportati di seguito mostrano come utilizzare la console di Dialogflow, l'API REST (inclusa la riga di comando) o le librerie client per creare un documento informativo. Per utilizzare l'API, chiama il metodo create nel tipo Document.

UI web

Utilizza la console di Dialogflow per creare un documento informativo:

  1. Se non stai continuando con i passaggi precedenti, vai alle impostazioni della knowledge base:
    1. Vai alla console Dialogflow ES.
    2. Select an agent
    3. Fai clic su Conoscenza nel menu della barra laterale di sinistra
    4. Fai clic sul nome della tua knowledge base
  2. Fai clic su Nuovo documento o Crea il primo.
  3. Inserisci un nome per il documento
  4. Seleziona text/html per Tipo MIME
  5. Seleziona le Domande frequenti per il Tipo di conoscenza.
  6. Seleziona URL per Origine dati.
  7. Inserisci https://cloud.google.com/storage/docs/faq nel campo URL.
  8. 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 tua knowledge base restituito dalla richiesta precedente
  • DOCUMENT_DISPLAY_NAME: nome del documento informativo desiderato

Metodo HTTP e URL: 

POST https://dialogflow.googleapis.com/v2beta1/projects/PROJECT_ID/knowledgeBases/KNOWLEDGE_BASE_ID/documents

Corpo JSON richiesta: 

{
  "displayName": "DOCUMENT_DISPLAY_NAME",
  "mimeType": "text/html",
  "knowledgeTypes": "FAQ",
  "contentUri": "https://cloud.google.com/storage/docs/faq"
}

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"
}

Il segmento di percorso dopo operations è l'ID operazione.

Java

Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 


import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.rpc.ApiException;
import com.google.cloud.dialogflow.v2.CreateDocumentRequest;
import com.google.cloud.dialogflow.v2.Document;
import com.google.cloud.dialogflow.v2.Document.KnowledgeType;
import com.google.cloud.dialogflow.v2.DocumentsClient;
import com.google.cloud.dialogflow.v2.KnowledgeOperationMetadata;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class DocumentManagement {

  public static void createDocument(
      String knowledgeBaseName,
      String displayName,
      String mimeType,
      String knowledgeType,
      String contentUri)
      throws IOException, ApiException, InterruptedException, ExecutionException, TimeoutException {
    // Instantiates a client
    try (DocumentsClient documentsClient = DocumentsClient.create()) {
      Document document =
          Document.newBuilder()
              .setDisplayName(displayName)
              .setContentUri(contentUri)
              .setMimeType(mimeType)
              .addKnowledgeTypes(KnowledgeType.valueOf(knowledgeType))
              .build();
      CreateDocumentRequest createDocumentRequest =
          CreateDocumentRequest.newBuilder()
              .setDocument(document)
              .setParent(knowledgeBaseName)
              .build();
      OperationFuture<Document, KnowledgeOperationMetadata> response =
          documentsClient.createDocumentAsync(createDocumentRequest);
      Document createdDocument = response.get(300, TimeUnit.SECONDS);
      System.out.format("Created Document:\n");
      System.out.format(" - Display Name: %s\n", createdDocument.getDisplayName());
      System.out.format(" - Document Name: %s\n", createdDocument.getName());
      System.out.format(" - MIME Type: %s\n", createdDocument.getMimeType());
      System.out.format(" - Knowledge Types:\n");
      for (KnowledgeType knowledgeTypeId : document.getKnowledgeTypesList()) {
        System.out.format("  - %s \n", knowledgeTypeId.getValueDescriptor());
      }
      System.out.format(" - Source: %s \n", document.getContentUri());
    }
  }
}

Node.js

Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 

//   // Imports the Dialogflow client library
//   const dialogflow = require('@google-cloud/dialogflow').v2beta1;

//   // Instantiate a DialogFlow Documents client.
//   const client = new dialogflow.DocumentsClient({
//     projectId: projectId,
//   });

//   /**
//    * TODO(developer): Uncomment the following lines before running the sample.
//    */
//   // const projectId = 'ID of GCP project associated with your Dialogflow agent';
//   // const knowledgeBaseFullName = `the full path of your knowledge base, e.g my-Gcloud-project/myKnowledgeBase`;
//   // const documentPath = `path of the document you'd like to add, e.g. https://dialogflow.com/docs/knowledge-connectors`;
//   // const documentName = `displayed name of your document in knowledge base, e.g. myDoc`;
//   // const knowledgeTypes = `The Knowledge type of the Document. e.g. FAQ`;
//   // const mimeType = `The mime_type of the Document. e.g. text/csv, text/html,text/plain, text/pdf etc.`;

//   const request = {
//     parent: knowledgeBaseFullName,
//     document: {
//       knowledgeTypes: [knowledgeTypes],
//       displayName: documentName,
//       contentUri: documentPath,
//       source: 'contentUri',
//       mimeType: mimeType,
//     },
//   };

//   const [operation] = await client.createDocument(request);
//   const [response] = await operation.promise();

//   console.log('Document created');
//   console.log(`Content URI...${response.contentUri}`);
//   console.log(`displayName...${response.displayName}`);
//   console.log(`mimeType...${response.mimeType}`);
//   console.log(`name...${response.name}`);
//   console.log(`source...${response.source}`);

Python

Per eseguire l'autenticazione in Dialogflow, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale. 

def create_document(
    project_id, knowledge_base_id, display_name, mime_type, knowledge_type, content_uri
):
    """Creates a Document.

    Args:
        project_id: The GCP project linked with the agent.
        knowledge_base_id: Id of the Knowledge base.
        display_name: The display name of the Document.
        mime_type: The mime_type of the Document. e.g. text/csv, text/html,
            text/plain, text/pdf etc.
        knowledge_type: The Knowledge type of the Document. e.g. FAQ,
            EXTRACTIVE_QA.
        content_uri: Uri of the document, e.g. gs://path/mydoc.csv,
            http://mypage.com/faq.html."""
    from google.cloud import dialogflow_v2beta1 as dialogflow

    client = dialogflow.DocumentsClient()
    knowledge_base_path = dialogflow.KnowledgeBasesClient.knowledge_base_path(
        project_id, knowledge_base_id
    )

    document = dialogflow.Document(
        display_name=display_name, mime_type=mime_type, content_uri=content_uri
    )

    document.knowledge_types.append(
        getattr(dialogflow.Document.KnowledgeType, knowledge_type)
    )

    response = client.create_document(parent=knowledge_base_path, document=document)
    print("Waiting for results...")
    document = response.result(timeout=120)
    print("Created Document:")
    print(" - Display Name: {}".format(document.display_name))
    print(" - Knowledge ID: {}".format(document.name))
    print(" - MIME Type: {}".format(document.mime_type))
    print(" - Knowledge Types:")
    for knowledge_type in document.knowledge_types:
        print("    - {}".format(KNOWLEDGE_TYPES[knowledge_type]))
    print(" - Source: {}\n".format(document.content_uri))

La creazione di un documento è un'operazione a lunga esecuzione, quindi potrebbe richiedere molto tempo. Puoi eseguire il polling dello stato di questa operazione per verificare se è stata completata. Una volta completata, l'operazione conterrà l'ID documento appena creato. Salva questo ID per elaborazioni future. Per ulteriori informazioni, consulta Operazioni a lunga esecuzione.

Gestisci i documenti informativi

Aggiorna i contenuti del documento informativo

Se aggiorni i contenuti a cui fa riferimento un documento informativo, quest'ultimo potrebbe non aggiornarsi automaticamente. I contenuti vengono aggiornati automaticamente solo se sono stati forniti come URL pubblico e se hai selezionato l'opzione Abilita ricaricamento automatico per il documento.

Per aggiornare manualmente Cloud Storage o i contenuti dei documenti con URL pubblico, chiama il metodo reload nel tipo Document.

Per aggiornare manualmente i contenuti non elaborati caricati, utilizza i metodi delete e create nel tipo Document per ricreare il documento.

Elenca documenti informativi

Puoi elencare tutti i documenti informativi per la tua knowledge base. Per utilizzare l'API, chiama il metodo list nel tipo Document.

Elimina i documenti informativi

Puoi eliminare i documenti informativi per la tua knowledge base. Per utilizzare l'API, chiama il metodo delete nel tipo Document. Se non disponi dell'ID, puoi elencare i documenti come descritto sopra.

Contenuti supportati

Sono supportati i seguenti tipi di documenti informativi:

  • Domande frequenti: i contenuti del documento includono coppie di domanda e risposta in formato HTML o CSV. I tipici formati HTML delle domande frequenti vengono analizzati in modo accurato, ma quelli insoliti potrebbero non essere analizzati. Il file CSV deve contenere domande nella prima colonna e risposte nella seconda, senza intestazione. Grazie a questo formato esplicito, vengono sempre analizzati in modo preciso.
  • QA estrattivo: documenti per i quali il testo non strutturato viene estratto e utilizzato per rispondere alle domande.

La tabella seguente mostra i tipi MIME supportati per Tipo di conoscenza e Origine.

Tipo di conoscenza \ Origine File caricato (Document.content) (NON consigliato) File caricato (Document.raw_content) (consigliato) File da Cloud Storage (Document.contentUri) File da URL pubblico (Document.contentUri)
Domande frequenti testo/csv testo/csv testo/csv text/html
QA estrattivo testo/normale, testo/html text/plain, text/html, application/pdf text/plain, text/html, application/pdf N/A

I contenuti del documento presentano i problemi noti, le limitazioni e le best practice riportati di seguito:

Informazioni generali:

  • I file degli URL pubblici devono essere stati sottoposti a scansione dall'indicizzatore della Ricerca Google affinché siano disponibili nell'indice di ricerca. Puoi verificarlo con Google Search Console. Tieni presente che l'indicizzatore non mantiene i tuoi contenuti aggiornati. Devi aggiornare esplicitamente il documento informativo quando i contenuti di origine cambiano.
  • 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 le domande frequenti sia gli 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, è preferibile evitare tag HTML e utilizzare testo normale, quando possibile.
  • Le risposte dell'Assistente Google hanno un limite di 640 caratteri per fumetto della chat, quindi le risposte lunghe vengono troncate durante l'integrazione con l'Assistente Google.
  • La dimensione massima del documento è 50 MB.
  • Quando utilizzi i file Cloud Storage, devi utilizzare URI pubblici o URI privati a cui ha accesso il tuo account utente o l'account di servizio.

Specifico per le domande frequenti:

  • Il file CSV deve contenere domande nella prima colonna e risposte nella seconda, senza intestazione.
  • Se possibile, utilizza CSV perché 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 essere maggiore di 2000.
  • Le domande duplicate con risposte diverse non sono supportate.
  • Puoi utilizzare qualsiasi documento di domande frequenti. L'analizzatore sintattico è in grado di gestire la maggior parte dei relativi formati.

Specifico per il QA estrattivo:

  • Il QA estrattivo è attualmente sperimentale. Si basa su tecnologie simili sperimentate e testate da Google in prodotti come Ricerca e Assistente. Inviaci il tuo feedback su come funziona per Dialogflow.
  • I contenuti con testo denso funzionano meglio. Evita i contenuti con molti paragrafi composti da una sola frase.
  • Tabelle ed elenchi non sono supportati.
  • Il numero di paragrafi di un documento non deve essere superiore a 2000.
  • Se un articolo è lungo (> 1000 parole), prova a suddividerlo in più articoli più piccoli. Se l'articolo riguarda più problemi, può essere suddiviso in articoli più brevi riguardanti i singoli problemi. Se l'articolo riguarda un solo problema, focalizza l'articolo sulla descrizione del problema e scegli una risoluzione del problema breve.
  • Idealmente, dovrebbero essere forniti solo i contenuti principali di un articolo (descrizione e risoluzione del problema). I contenuti aggiuntivi come il nome dell'autore, la cronologia delle modifiche, i link correlati e gli annunci non sono importanti.
  • Prova a includere una descrizione dei problemi per i quali un articolo può esserti utile e/o query di esempio a cui questo articolo può rispondere.

Utilizzo di Cloud Storage

Se i contenuti non sono pubblici, l'opzione 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:

Segui le istruzioni della guida rapida di Cloud Storage per creare un bucket e caricare i file.

Fornitura di 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 tipo Document, imposta il campo contentUri sull'URL del documento Cloud Storage. Il formato di questo URL è gs://bucket-name/object-name.
Indietro
Gestione degli intenti con l'API
Avanti
Aggiornamento dei dati con una FieldMask