API Intelligence prédictive

L’API Intelligence prédictive fournit des points de terminaison qui prédisent une valeur de champ en fonction d’un ou de plusieurs champs d’entrée et d’une solution formée.

Vous ne pouvez utiliser cette API que lorsque le module d’extension Intelligence prédictive (com.glide.platform_ml) est activé.

Intelligence prédictive - GET /agent_intelligence/solution/{solution_name}/prediction

Prédit une valeur de champ de sortie à l’aide d’une solution spécifique.

Format d'URL

URL par défaut : /api/now/agent_intelligence/solution/{solution_name}/prediction

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès

Nom	Description
solution_name	Nom de la solution à utiliser pour les prédictions. Par exemple, ml_incident_categorization. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Paire clé-valeur du champ d’entrée de définition de la solution	Paire nom-valeur du champ d’entrée de la solution. Par exemple, entrez le nom : short_description et la valeur : Impossible de se connecter au VPN. Type de données : chaîne

Tableau 3. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 5. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
entrée	Paires nom-valeur qui ont été spécifiées comme entrée de l’appel. Type de données : objet
sortie	Valeurs des résultats prévus en fonction de la solution spécifiée. Type de données : objet "output": { "confidence": Number", "outcome": "String", "threshold": Number" }
sortie.confiance	Précision estimée de la prédiction, en pourcentage. Par exemple, 53.84615375762915. Type de données : nombre
Sortie.Résultat	Valeur du champ de sortie de prédiction. Par exemple, une solution de catégorisation des incidents renvoie une catégorie d’incident telle que la question. Type de données : chaîne
sortie.seuil	Valeur du seuil configuré associé à la prédiction. Type de données : nombre

Exemple de demande 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
    }
  }
}

Intelligence prédictive - GET /agent_intelligence/solution/prédiction

Renvoie des prédictions pour plusieurs solutions.

Remarque :

Les objets de résultat sont regroupés par nom de solution et par sys_id au format result.<solutionname>.<sys_id>.[ { <result1> },{ <result2>}].

Pour plus d’informations sur la personnalisation, consultez Objets pouvant contenir des scripts MLSolutionFactory.

Format d'URL

URL versionnée : /now/{api_version}/agent_intelligence/solution/prediction

URL par défaut : /now/agent_intelligence/solution/prediction

Remarque :

Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 8. Paramètres de requête

Paramètre	Description
input_filter	Le paramètre requis si input_table est utilisé, ne pas utiliser ce paramètre avec input_maps le paramètre. Filtrez pour sélectionner les enregistrements sur lesquels exécuter des prédictions. Par exemple : sys_id 0ef47232db801300864adfea5e961912 Type de données : chaîne
input_maps	Requis sauf si le paramètre est utilisé input_table . Tableau des paires nom-valeur d’entrée. Par exemple : [{"short_description":"my email is not working"}, {"short_description":"need help with password"}] Type de données : tableau d’objets
input_table	Requis sauf si le paramètre est utilisé input_maps . Nom de la table sur laquelle vous souhaitez exécuter des prédictions. Par exemple : incident Type de données : chaîne
options	Objet JSON avec arguments facultatifs. Par exemple : {"top_n" : 5, "apply_threshold":false} Options valides : top_n : Numéro. Si elle est fournie, elle renvoie les meilleurs résultats, jusqu’au nombre spécifié de prédictions. apply_threshold : Booléen. Vérifie la valeur de seuil de la solution et l’applique à l’ensemble de résultats. La valeur de seuil est le seuil de solution pour la similarité ou le seuil de niveau de classe pour la classification. La valeur par défaut est vrai. custom_results_filter : Chaîne. Solutions de similarité uniquement. Spécifie l’ensemble autorisé à partir duquel les résultats sont renvoyés à l’aide d’une requête codée. Type de données : objet
solution_names	Requis. Liste de noms de solutions séparés par des virgules pour lesquels vous souhaitez exécuter des prédictions. Par exemple : ml_incident_categorization,ml_incident_assignment Type de données : chaîne

Tableau 9. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Aucun

En-têtes

Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 10. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

Tableau 11. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

Paramètres du corps de la réponse (JSON ou XML)

Élément	Description
fiabilité	Valeur de la fiabilité associée à la prédiction. Par exemple, 53,84. Type de données : nombre
predictedSysId	La sys_id de la valeur prévue. Les résultats peuvent provenir de n’importe quelle table sur laquelle des informations sont prévues. Type de données : chaîne
Valeur predictedValue	Valeur représentant le résultat de la prédiction. Type de données : chaîne
seuil	Valeur du seuil configuré associé à la prédiction. Type de données : nombre

Exemple de demande 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"
        }
      ]
    }
  }
}