Entidades personalizadas

É possível criar entidades personalizadas para dados de correspondência específicos ao seu agente. Por exemplo, defina um tipo de entidade vegetable que corresponda aos tipos de vegetais disponíveis para compra em um agente de mercearia.

Criar entidades personalizadas

Para criar uma entidade personalizada:

Console

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Tipos de entidade.
  6. Clique em Criar
  7. Insira os dados da entidade.
  8. Clique em Save.

API

Use o método create do EntityType.

Selecione um protocolo e uma versão para a referência EntityType:

Protocolo V3 V3beta1
REST Recurso EntityType Recurso EntityType
RPC Interface de EntityType Interface de EntityType
C++ EntityTypesClient Indisponível
C# EntityTypesClient Indisponível
Go EntityTypesClient Indisponível
Java EntityTypesClient EntityTypesClient
Node.js EntityTypesClient EntityTypesClient
PHP Indisponível Indisponível
Python EntityTypesClient EntityTypesClient
Ruby Indisponível Indisponível

Limitações

Considere as seguintes limitações:

  • Os nomes de exibição dos tipos de entidade personalizados são exclusivos para cada agente. Os nomes de exibição do tipo de entidade precisam começar com uma letra e podem conter o seguinte: A-Z, a-z, 0-9, _ (sublinhado), - (traço). Os valores de referência de entidade e sinônimos não têm essa limitação.

Exportar e importar entidades personalizadas

É possível exportar e importar entidades para compartilhar entre agentes.

Uma das opções de formato de exportação é o pacote JSON, que é um arquivo ZIP que contém uma hierarquia de diretórios e arquivos JSON. Confira a seguir a estrutura de diretórios:

  • entityTypes: este diretório contém os tipos de entidade.
    • <entity type name>: um ou mais desses diretórios existem e os nomes dos diretórios correspondem aos nomes de exibição do tipo de entidade.
      • entities: este diretório contém arquivos de entrada de entidade.
        • <language tag>.json: um ou mais desses arquivos existem e os nomes dos arquivos correspondem a tags de idioma. Cada arquivo contém entradas de entidade específicas do idioma.
      • <excludedPhrases>: este diretório contém arquivos de frase excluída.
        • <language tag>.json: um ou mais desses arquivos existem e os nomes dos arquivos correspondem a tags de idioma. Cada arquivo contém exclusões de frases específicas para cada idioma.
      • <entity type name>.json: esse nome de arquivo corresponde a um nome de exibição de tipo de entidade. O arquivo contém dados específicos do tipo de entidade que não são encontrados em outros arquivos.

Exemplo:

 entityTypes
 ⤷  Entity Type A
    ⤷  entities
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  excludedPhrases
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  Entity Type A.json
 ⤷  Entity Type B
    ⤷  entities
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  excludedPhrases
       ⤷  en.json
       ⤷  en-gb.json
       ⤷  en-ca.json
    ⤷  Entity Type B.json

Ao importar tipos de entidade, pode haver conflitos de mesclagem quando o nome de exibição de um tipo de entidade no agente atual corresponder ao de um tipo de entidade importado. É possível controlar o comportamento de mesclagem quando os nomes de exibição do tipo de entidade correspondem selecionando uma das seguintes opções:

  • Substituir tipos de entidade: um tipo de entidade importado substitui qualquer tipo de entidade com o mesmo nome no agente.
  • Mesclar com tipos de entidade atuais: as entradas de entidade de um tipo de entidade importado são adicionadas ao tipo de entidade atual. Se as mesmas entradas de entidade existirem, elas não serão duplicadas, e os sinônimos delas serão mesclados.
  • Renomear e importar como novos tipos de entidade: o tipo de entidade importado é renomeado anexando "_1" ao nome de exibição.
  • Ignorar os tipos de entidade: o tipo de entidade atual permanece inalterado e o tipo de entidade importado é ignorado.

Para exportar tipos de entidade:

Console

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Tipos de entidade.
  6. Selecione todos os tipos de entidade que você quer exportar.
  7. Clique em Exportar entidade selecionada.
  8. Selecione o formato e o destino.
  9. Clique em Enviar.

Para importar tipos de entidade:

Console

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Tipos de entidade.
  6. Clique em Importar.
  7. Selecione a origem e o comportamento de mesclagem.
  8. Clique em Enviar.

Importar entradas de entidade

É possível importar entradas de entidade para um tipo de entidade.

O formato de arquivo usado para importar entradas de entidade é o mesmo usado para importar tipos de entidade. No entanto, o arquivo de importação só pode conter um tipo de entidade, e todas as entradas abaixo dele serão importadas para o tipo de entidade selecionado. Se as mesmas entradas de entidade existirem, elas não serão duplicadas, e os sinônimos delas serão mesclados.

Para importar entradas de entidade de um tipo:

Console

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Tipos de entidade.
  6. Selecione uma entidade.
  7. Clique em Importar para entidade.
  8. Selecione um arquivo.
  9. Clique em Enviar.