Entidades do sistema NLU

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 5 min. de leitura

    • Use entidades NLU definidas globalmente para identificar informações do sistema que Virtual Agent podem extrair da conversa. Você pode definir entidades como variáveis de entrada "sem nó" para um tópico. Essas variáveis podem ser preenchidas com base nas previsões do provedor de serviços NLU ou fornecidas fora do escopo do tópico.

    As entidades do sistema são habilitadas em modelos de NLU por padrão. Você pode exibi-las na guia Entidades do modelo em Workbench de NLU.

    Entidade do sistema GLOBAL.DATE

    O subtipo DAY retorna uma cadeia de caracteres de data que é precisa para uma data específica.

    Tabela 1. Subtipo GLOBAL.DATE = uso de DAY
    Uso Exemplo
    Formato AAAA-MM-DD
    Expressão regular \\d\\d\\d\\d-\\d\\d-\\d\\d
    Exemplo de entrada O Sr. Smith saiu na sexta-feira, 4 de fevereiro de 2019.
    Valor normalizado 2019-02-04
    Exemplo de código 
    {
"name": "DATE", 
"value": "...",
"score": 1.0, 
"normalization": "2019-02-04"
}

    O subtipo WEEK retorna uma cadeia de caracteres de data de uma semana específica do ano.

    Tabela 2. Subtipo GLOBAL.DATE = uso de WEEK
    Uso Exemplo
    Formato AAAA'S'SS
    Expressão regular \\d\\d\\d\\d\\dW\\d\\d
    Exemplo de entrada O Sr. Smith saiu na terceira semana de 1999.
    Valor normalizado 1999S3
    Exemplo de código 
    {
"name": "entity:GLOBAL.DATE", 
"value": "...",
"score": 1.0, 
"normalization": {"type": "GLOBAL.DATE", "subType": "WEEK", "value":"1999W3"}
}

    O subtipo MONTH retorna uma cadeia de caracteres de data de um mês específico do ano.

    Tabela 3. Subtipo GLOBAL.DATE = uso de MONTH
    Uso Exemplo
    Formato AAAA'M'MM
    Expressão regular \\d\\d\\d\\dM\\d\\d
    Exemplo de entrada O Sr. Smith saiu em fevereiro de 1999.
    Valor normalizado 1999M02
    Exemplo de código 
    {
"name": "entity:GLOBAL.DATE",
"value": "...",
"score": 1.0, 
"normalization": {"type": "GLOBAL.DATE", "subType": "MONTH", "value": "1999M02"}
}

    O subtipo YEAR retorna uma cadeia de caracteres de um ano específico.

    Tabela 4. Subtipo GLOBAL.DATE = uso de YEAR
    Uso Exemplo
    Formato AAAA
    Expressão regular \\d\\d\\d\\d
    Exemplo de entrada O Sr. Smith saiu em 1999.
    Valor normalizado 1999
    Exemplo de código 
    {
"name": "entity:GLOBAL.DATE",
"value": "...",
"score": 1.0,
"normalization": {"type": "GLOBAL.DATE", "subType": "YEAR", "value": "1999"}
}

    O subtipo SEASON retorna uma cadeia de caracteres de data de uma estação específica do ano.

    Tabela 5. Subtipo GLOBAL.DATE = uso de SEASON
    Uso Exemplo
    Formato Um dos seguintes:
    • Inverno: AAAAWI
    • Primavera: AAAASP
    • Verão: AAAASU
    • Outono: AAAAFA
    Expressão regular Um dos seguintes:
    • Inverno: \\d\\d\\d\\dWI
    • Primavera: \\d\\d\\d\\dSP
    • Verão: \\d\\d\\d\\dSU
    • Outono: \\d\\d\\d\\dFA
    Exemplo de entrada O Sr. Smith saiu no outono de 1999.
    Valor normalizado 1999FA
    Exemplo de código 
    {
"name": "entity:GLOBAL.DATE",
"value": "...",
"score": 1.0,
"normalization": {"type": "GLOBAL.DATE", "subType": "SEASON", "value": "1999FA"}
}

    Entidade do sistema GLOBAL.TIME

    O Subtipo TIME retorna uma cadeia de caracteres de hora com precisão de hora e minuto.

    Tabela 6. Subtipo GLOBAL.TIME = uso de TIME
    Uso Exemplo
    Formato 'T'HH:mm
    Expressão regular T\\d\\d:\\d\\d
    Exemplo de entrada O Sr. Smith saiu às dez para as três.
    Valor normalizado T02:50
    Exemplo de código 
    {
"name": "entity:GLOBAL.TIME", 
"value": "...",
"score": 1.0, 
"normalization": {"type": "GLOBAL.TIME","subType": "TIME", "value": "T02:50"}
}

    O subtipo PARTSOFDAY retorna uma cadeia de caracteres de hora que especifica partes do dia.

    Tabela 7. Subtipo GLOBAL.TIME = uso de PARTSOFDAY
    Uso Exemplo
    Formato Um dos seguintes:
    • Manhã: TMO
    • Tarde: TAF
    • Fim de tarde: TEV
    • Noite: TNI
    Expressão regular Um dos seguintes:
    • Manhã: TMO
    • Tarde: TAF
    • Fim de tarde: TEV
    • Noite: TNI
    Exemplo de entrada O Sr. Smith saiu pela manhã.
    Valor normalizado TMO
    Exemplo de código 
    {
"name": "entity:GLOBAL.TIME", 
"value": "...",
"score": 1.0, 
"normalization": {"type": "GLOBAL.TIME", "subType": "PARTSOFDAY", "value": "TMO"}
}

    Entidade do sistema GLOBAL.DATE_TIME

    O subtipo DATE_TIME retorna uma cadeia de caracteres de data com precisão de uma cadeia de caracteres de data e hora específica com preciso de hora e minuto.

    Tabela 8. Subtipo GLOBAL.DATE_TIME = uso de DATETIME
    Uso Exemplo
    Formato AAAA-MM-DD'T'HH:mm
    Expressão regular \\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d
    Exemplo de entrada O Sr. Smith sai em 31 de outubro às 17:00.
    Valor normalizado 2022-10-31T17:00
    Exemplo de código 
    {
"name": "DATE_TIME",
"value": "October 31st at 5:00 p.m",
"normalization": "2022-10-31T17:00","confidence": "1"
}

    Entidade do sistema GLOBAL.DURATION

    Essa entidade retorna uma cadeia de caracteres de duração que especifica a duração da atividade.

    Tabela 9. Uso de GLOBAL.DURATION
    Uso Exemplo
    Formato Um dos seguintes:
    • Segundo: 's'ss
    • Minuto: 'm'mm
    • Hora: 'h'hh
    • Dia: 'D'DD
    • Semana: 'S'SS
    • Mês: 'M'MM
    • Ano: 'A'AA
    Expressão regular Um dos seguintes:
    • Segundo: s\\d\\d
    • Minuto: m\\d\\d
    • Hora: h\\d\\d
    • Dia: D\\d\\d
    • Semana: S\\d\\d
    • Mês: M\\d\\d
    • Ano: A\\d\\d
    Exemplo de entrada O Sr. Smith permaneceu em Boston por 48 horas.
    Valor normalizado h48
    Exemplo de código 
    {
"name": "entity:GLOBAL.DURATION",
"value": "...", 
"score": 1.0,
"normalization": {"type": "GLOBAL.DURATION", "value": "h48"}
}

    Entidade do sistema GLOBAL.LOCATION

    Esta entidade retorna uma cadeia de caracteres de local.

    Tabela 10. Uso de GLOBAL.LOCATION
    Uso Exemplo
    Formato Valor da cadeia de caracteres. Exemplo: Santa Clara
    Expressão regular Não aplicável.
    Exemplo de entrada O Sr. Smith trabalha em Santa Clara.
    Valor normalizado Santa Clara
    Exemplo de código 
    {
"name": "entity:GLOBAL.LOCATION",
"value": "...", 
"score": 1.0,
"normalization": {"type": "GLOBAL.LOCATION", "value":"Santa Clara"}
}

    Entidade do sistema GLOBAL.PERSON

    Esta entidade retorna uma cadeia de caracteres de nome.

    Uso Exemplo
    Formato Valor da cadeia de caracteres. Exemplo: Joe Smith
    Expressão regular Não aplicável.
    Exemplo de entrada Joe Smith trabalha em Santa Clara.
    Valor normalizado Joe Smith
    Exemplo de código 
    {
"name": "entity:GLOBAL.PERSON", 
"value": "...",
"score": 1.0, 
"normalization": {"type": "GLOBAL.PERSON", "value":"Joe Smith"}
}

    Entidade do sistema GLOBAL.MONEY

    Esta entidade retorna uma cadeia de caracteres de moeda.

    Tabela 11. Uso de GLOBAL.MONEY
    Uso Exemplo
    Formato Valor da cadeia de caracteres. Exemplo: US$ 2.000
    Expressão regular Não aplicável.
    Exemplo de entrada Mostre-me laptops por menos de USD 2.000.
    Valor normalizado USD 2.000
    Nota:
    O valor normalizado usa o código de país ISO 3166 de três letras da moeda de origem.
    Exemplo de código 
    {
"name": "entity:GLOBAL.MONEY", 
"value": "...",
"score": 1.0, 
"normalization": {"type": "GLOBAL.MONEY", "value":"2000", “currency”:”USD”}
}

    Entidade do sistema GLOBAL.NUMBER

    Esta entidade retorna um número.

    Uso Exemplo
    Formato Valor da cadeia de caracteres. Exemplo: 5.0
    Expressão regular Não aplicável.
    Exemplo de entrada Quero ver as últimas 5 transações da minha conta.
    Valor normalizado 5.0
    Exemplo de código 
    {
"name": "entity:GLOBAL.NUMBER",
  "value": "...",
  "score": 1.0,
  "normalization": {"numericValue":"5", “normalizedValue”: “5”}
}

    GLOBAL.SOFTWARE

    Retorna uma cadeia de caracteres de software.

    Uso Exemplo
    Formato Valor da cadeia de caracteres. Exemplo: Java
    Expressão regular Não aplicável.
    Exemplo de entrada Como instalo o Java?
    Valor normalizado Java
    Exemplo de código 
    {
  "name": "entity:GLOBAL.SOFTWARE",
  "value": "Java",
  "score": 0.99930537,
  "normalization": {"type":"entity:GLOBAL.SOFTWARE",
                     "subType":"SOFTWARE",
                     "value":"Java"}
}

    GLOBAL.HARDWARE

    Retorna uma cadeia de caracteres de hardware.

    Uso Exemplo
    Formato Valor da cadeia de caracteres. Exemplo: impressora
    Expressão regular Não aplicável.
    Exemplo de entrada Como compro uma impressora?
    Valor normalizado impressora
    Exemplo de código 
    {
  "name": "entity:GLOBAL.HARDWARE",
  "value": "printer",
  "score": 1.0,
  "normalization": {"type":"entity:GLOBAL.HARDWARE",
                     "subType":"HARDWARE",
                     "value":"printer"}
}

    Exemplo de resultado de previsão de NLU usando a entidade do sistema Software

    {"status":"success",
   "response":{
      "utterance":"How do I install Java?",
      "intents":[
         {
            "intentName":"test intent",
            "nluModelName":"ml_x_snc_global_global_268a97a9dbd23c107906265d1396191a",
            "score":0.90401393,
            "intents":[
               
            ],
            "entities":[
               {
                  "name":"entity:GLOBAL.SOFTWARE",
                  "value":"Java",
                  "score":0.99930537,
                  "normalization":{
                     "type":"entity:GLOBAL.SOFTWARE",
                     "subType":"SOFTWARE",
                     "value":"Java"
                  },
                  "startingPosition":-1
               }
            ]
         }
      ],
      "properties":{
         "all:ml_x_snc_global_global_268a97a9dbd23c107906265d1396191a":"0.55",
         "entity:all":"0.01",
         "inference.sspace.time":"4",
         "inference.time":"33",
         "intent:all":"0.01",
         "nluPlatformLanguage":"en",
         "nluPlatformVersion":"rome.0"
      }
   }
}

    Exemplo de resultado de previsão de NLU usando a entidade do sistema DATE

    {
    "utterance": "We should meet next Sunday at Starbucks.",
    "intents": [
        {
            "intentName": "intent:Desire.Desire",
            "score": 0.83452,
            "entities": []
        },
        {
            "intentName": "intent:Meeting.MeetRequest",
            "score": 0.8919042,
            "entities": [
                {
                    "entityName": "entity:Meeting.MeetRequest.Where",
                    "value": "Starbucks",
                    "score": 1
                },
     {
                    "entityName": "entity:GLOBAL.DATE",
                    "value": "Sunday",
                    "normalization": { "type": "DATE",
                        "subType": "DAY",
                        "value": "1999-10-01"
                     },
                    "score": 0.87
                }
            ]
        }
    ]
}