Inteligência preditiva API

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 5 min. de leitura

    • A API Inteligência preditiva fornece endpoints que preveem um valor de campo com base em um ou mais campos de entrada e uma solução treinada.

    Você só pode usar esta API quando o plug-in Inteligência preditiva (com.glide.platform_ml) está ativado.

    Inteligência preditiva - GET /agent_intelligence/solution/{solution_name}/prediction

    Prevê um valor de campo de saída usando uma solução específica.

    Formato da URL

    URL padrão: /api/now/agent_intelligence/solution/{solution_name}/prediction

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    solution_name Nome da solução a ser usada para previsões. Por exemplo, ml_incident_categorization.

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Par de chave-valor do campo de entrada da definição da solução Par de nome-valor do campo de entrada da solução. Por exemplo, insira o nome: short_description e o valor: Unable to connect to VPN.

    Tipo de dados: cadeia de caracteres
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Elemento Descrição
    entrada Pares de nome-valor que foram especificados como entrada para a chamada.

    Tipo de dados: objeto
    saída Valores de resultado previstos com base na solução especificada.

    Tipo de dados: objeto

    "output": {
  "confidence": Number",
  "outcome": "String",
  "threshold": Number"
}
    saída.confiança Precisão estimada da previsão como uma porcentagem. Por exemplo, 53.84615375762915.

    Tipo de dados: número
    saída.resultado Valor do campo de saída de previsão. Por exemplo, uma solução de categorização de incidentes retornaria uma categoria de incidente, como consulta.

    Tipo de dados: cadeia de caracteres
    output.threshold Valor do limite configurado associado à previsão.

    Tipo de dados: número

    Amostra de solicitação cURL

    curl "https://instance.service-now.com/api/now/predictive_intelligence/solution/ml_incident_categorization/prediction?short_description=unable%20to%20connect%20to%20VPN" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    {
  "result": {
    "input": {
      "short_description": "unable to connect to VPN",
      "api": "api"
    },
    "output": {
      "outcome": "inquiry",
      "confidence": 53.84615375762915,
      "threshold": 5
    }
  }
}

    Inteligência preditiva - GET /agent_intelligence/solution/prediction

    Retorna previsões para várias soluções.

    Nota:
    Os objetos de resultado de saída são agrupados por nome de solução e sys_id no resultado do formato.<solutionname> .<sys_id> .[{<result1> },{<result2> }] .

    Para obter informações sobre personalização, consulte Objetos programáveis MLSolutionFactory.

    Formato da URL

    URL com controle de versão: /now/{api_version}/agent_intelligence/solution/prediction

    URL padrão: /now/agent_intelligence/solution/prediction

    Nota:
    As versões disponíveis são especificadas no Explorador de REST API. Para REST APIs com script, há informações adicionais sobre a versão no formulário Serviço REST com script.

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres
    Tabela 8. Parâmetros de consulta
    Parâmetro Descrição
    filtro_de_entrada Parâmetro obrigatório se input_table for usado, não use este parâmetro com o parâmetro input_maps. Filtrar para selecionar registros nos quais as previsões serão executadas. Por exemplo:
    sys_id 0ef47232db801300864adfea5e961912

    Tipo de dados: cadeia de caracteres
    mapas_de_entrada Obrigatório, a menos que o parâmetro input_table seja usado. Matriz de pares de nome-valor de entrada. Por exemplo: 
    [{"short_description":"my email is not working"}, {"short_description":"need help with password"}]

    Tipo de dados: matriz de objetos
    tabela_entrada Obrigatório, a menos que o parâmetro input_maps seja usado. Nome da tabela na qual você deseja executar previsões. Por exemplo:
    incident

    Tipo de dados: cadeia de caracteres
    opções Objeto JSON com argumentos opcionais. Por exemplo:
    {"top_n" : 5, "apply_threshold":false}
    Opções válidas:
    • top_n: número. Se fornecido, retorna os principais resultados, até o número especificado de previsões.
    • apply_threshold: booliano. Verifica o valor do limite da solução e o aplica ao conjunto de resultados. O valor do limite é o limite de solução para semelhança ou o limite de nível de classe para classificação. O valor padrão é verdadeiro.
    • custom_results_filter: cadeia de caracteres. Somente soluções de semelhança. Especifica o conjunto permitido do qual os resultados são retornados usando uma consulta codificada.

    Tipo de dados: objeto
    solution_names Obrigatório. Lista separada por vírgulas de nomes de solução para os quais você deseja executar previsões. Por exemplo:
    ml_incident_categorization,ml_incident_assignment

    Tipo de dados: cadeia de caracteres
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/json ou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    401 Não autorizado. As credenciais do usuário estão incorretas ou não foram aprovadas.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Elemento Descrição
    confiança Valor da confiança associada à previsão. Por exemplo, 53,84.

    Tipo de dados: número
    resultadosDetalhados Somente soluções de semelhança. Par de chave-valor JSON que contém detalhes sobre os índices de texto correspondentes.

    Tipo de dados: cadeia de caracteres
    previstoSysId O sys_id do valor previsto. Os resultados podem ser de qualquer tabela na qual as informações estão sendo previstas.

    Tipo de dados: cadeia de caracteres
    valorprevisto Valor que representa o resultado da previsão.

    Tipo de dados: cadeia de caracteres
    limite Valor do limite configurado associado à previsão.

    Tipo de dados: número

    Amostra de solicitação cURL

    curl "http://instance.servicenow.com/api/now/agent_intelligence/solution/prediction?input_table=incident&input_filter=sys_id%3D0ef47232db801300864adfea5e961912&solution_names=ml_incident_categorization%2Cml_incident_assignment&options=%7B%22top_n%22%20%3A%202%2C%20%22apply_threshold%22%3Afalse%7D" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
    {
  "result": {
    "ml_incident_categorization": {
      "0ef47232db801300864adfea5e961912": [
        {
          "confidence": 29.12211732875455,
          "threshold": 15,
          "predictedValue": "Email",
          "predictedSysId": ""
        },
        {
          "confidence": 19.08583525847071,
          "threshold": 14,
          "predictedValue": "Platform Performance",
          "predictedSysId": ""
        }
      ]
    },
    "ml_incident_assignment": {
      "0ef47232db801300864adfea5e961912": [
        {
          "confidence": 5.782322543467415,
          "threshold": 5,
          "predictedValue": "IT Finance CAB",
          "predictedSysId": "5f63e48fc0a8010e00eeaad81cd4dd37"
        },
        {
          "confidence": 5.303589009246953,
          "threshold": -1,
          "predictedValue": "NY DB",
          "predictedSysId": "5f74727dc0a8010e01efe33a251993f9"
        }
      ]
    }
  }
}