Recupera análise de conversa

GET /nlu/v1/agents/{agent_id}/conversation_analysis

Retorna a configuração de análise de conversa de um agente {agent_id}.

Exemplo de Resposta

{
  "schema_version": "1.0",
  "pipeline": "pt-br/conversation-1.0",
  "intents": [
    {
      "name": "Depositar",
      "description": "Depositar",
      "sentence_examples": [
        {
          "text": "quero colocar dinheiro na minha conta"
        },
        {
          "text": "vou fazer um depósito"
        },
        {
          "text": "tenho um depósito para fazer"
        },
        {
          "text": "depositar dinheiro na minha conta"
        },
        {
          "text": "gostaria de depositar R$10,00 em minha conta corrente"
        }
      ]
    },
    {
      "name": "Sacar",
      "description": "Sacar",
      "sentence_examples": [
        {
          "text": "quero tirar dinheiro da minha conta"
        },
        {
          "text": "vou fazer um saque"
        },
        {
          "text": "tenho um saque para fazer"
        },
        {
          "text": "sacar dinheiro da minha conta"
        },
        {
          "text": "gostaria de sacar R$10,00 em minha conta corrente"
        }
      ]
    },
    {
      "name": "Pagar",
      "description": "Pagar",
      "sentence_examples": [
        {
          "text": "tenho uma conta para pagar"
        },
        {
          "text": "quero pagar uma fatura"
        },
        {
          "text": "quero fazer um pagamento"
        },
        {
          "text": "realizar um pagamento"
        },
        {
          "text": "tenho uma conta de R$100,00 para pagar"
        }
      ]
    }
  ],
  "system_entities": [
    "sys.currency", "sys.number"
  ],
  "custom_entities": [
    {
      "name": "PHONE_NUMBER",
      "synonym_values": [
        {
          "value": "casa",
          "synonyms": [
            "telefone de casa",
            "minha casa"
          ]
        }
      ],
      "regex_values": [
        {
          "value": "\\1\\2",
          "regex": "(\\d{2})\\-(\\d{9})"
        }
      ]
    },
    {
      "name": "CEP",
      "regex_values": [
        {
          "value": "@text",
          "regex": "(\\d{5})-(\\d{3})"
        }
      ]
    },
    {
      "name": "produtos",
      "synonym_values": [
        {
          "value": "Tv",
          "synonyms": [
            "TV",
            "televisão"
          ]
        }
      ]
    }
  ]
}

Parameters

• agent_id – ID do agente

Status Codes

• 200 OK – Sucesso

• 404 Not Found – Agente não encontrado

• 500 Internal Server Error – Erro interno

Response JSON Object

• schema_version (string) – Versão utilizada.

• pipeline (string) – Tipo de pipeline utilizada.

• intents (List[Intent]) – Lista de intenções cadastradas.

• unknown_intent (Dict[UnknownIntent]) – Configurações para intenções desconhecidas.

• system_entities (List[string]) – Lista de entidades de sistema cadastradas.

• custom_entities (List[CustomEntity]) – Lista de entidades customizadas cadastradas.

DETALHES DA RESPOSTA

Intent Object

Response JSON Object

• name (string) – Nome da intenção.

• description (string) – Descrição da intenção.

• sentence_examples (List[Sentence]) – Lista de sentenças de exemplo.

Unknown Intent Object

Response JSON Object

• enabled (boolean) – Habilita o recurso de detecção de intenção desconhecida.

• autodetect_enabled (boolean) – Habilita a detecção automática de intenção desconhecida.

• auto_unkclass_enabled (boolean) – Habilita a geração automática de frases fora do domínio.

• score_threshold (float) – Pontuação mínima para que a predição da intenção seja válida.

• sentence_examples (List[Sentence]) – Lista com sentenças de exemplo para intenção desconhecida.

Sentence Object

Response JSON Object

• text (string) – Sentença de exemplo.

Custom Entity Object

Response JSON Object

• name (string) – Nome da entidade.

• synonym_values (List[Synonym]) – Lista de valores e sinônimos.

• regex_values (List[Regex]) – Lista de valores e regex.

Synonym Object

Response JSON Object

• value (string) – Valor da expressão.

• synonyms (List[string]) – Lista de sinônimos do valor.

Regex Object

Response JSON Object

• value (string) – Valor da expressão.

• regex (string) – Regex a ser utilizada para encontrar a expressão.