---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Inteligência preditiva API

# Inteligência preditiva API {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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 {#ariaid-title2}

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

### Formato da URL {#agent_intel-GET-sol-sol_name-pred__section_f2c_vr1_dmb}

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

### Parâmetros de solicitação compatíveis

{#agent_intel-GET-sol-sol_name-pred__entry__2}

| Nome | Descrição |
|-|-|
| solution_name | Nome da solução a ser usada para previsões. Por exemplo, <kbd class="ph userinput">ml_incident_categorization</kbd>. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#agent_intel-GET-sol-sol_name-pred__entry__6}

| 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: <kbd class="ph userinput">short_description</kbd> e o valor: <kbd class="ph userinput">Unable to connect to VPN</kbd>. Tipo de dados: cadeia de caracteres |
[Tabela 2. Parâmetros de consulta]

{#agent_intel-GET-sol-sol_name-pred__entry__10}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#agent_intel-GET-sol-sol_name-pred__entry__14}{#agent_intel-GET-sol-sol_name-pred__accept-RESTAPI}

| 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 4. Cabeçalhos da solicitação]

{#agent_intel-GET-sol-sol_name-pred__entry__18}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#agent_intel-GET-sol-sol_name-pred__entry__22}{#agent_intel-GET-sol-sol_name-pred__entry-200-status-code}{#agent_intel-GET-sol-sol_name-pred__entry-401-status-code}{#agent_intel-GET-sol-sol_name-pred__entry-500-status-code}

| Código de 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. |
[Tabela 6. Códigos de status]

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

{#agent_intel-GET-sol-sol_name-pred__entry__30}

| 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 {#ariaid-title3}

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](https://www.servicenow.com/docs/access?context=using-ml-apis-mlsolutionfactory&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US).

### Formato da URL {#agent_intel-GET-solution-predition__section_rrf_w51_dmb}

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

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

### Parâmetros de solicitação compatíveis

{#agent_intel-GET-solution-predition__entry__2}{#agent_intel-GET-solution-predition__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]

{#agent_intel-GET-solution-predition__entry__6}

| 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.{#agent_intel-GET-solution-predition__solution-prediction-topn} * 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.{#agent_intel-GET-solution-predition__solution-prediction-thresh} * 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.{#agent_intel-GET-solution-predition__solution-prediction-custom} {#agent_intel-GET-solution-predition__ul_unc_4bs_ckb} 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 8. Parâmetros de consulta]

{#agent_intel-GET-solution-predition__entry__18}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#agent_intel-GET-solution-predition__entry__22}{#agent_intel-GET-solution-predition__accept-RESTAPI}

| 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 10. Cabeçalhos da solicitação]

{#agent_intel-GET-solution-predition__entry__26}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Cabeçalhos de resposta]

### 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](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#agent_intel-GET-solution-predition__entry__30}{#agent_intel-GET-solution-predition__entry-200-status-code}{#agent_intel-GET-solution-predition__entry-401-status-code}{#agent_intel-GET-solution-predition__entry-404-status-code}{#agent_intel-GET-solution-predition__entry-500-status-code}

| Código de 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. |
[Tabela 12. Códigos de status]

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

{#agent_intel-GET-solution-predition__entry__40}

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