ClassificationSolutionVersion : globale

ClassificationSolutionVersion : getPredictionPerformance(options de l’objet)

Calcule la précision et la couverture de la solution.

Pour utiliser cette méthode, vous devez d’abord créer des paramètres à l’aide de la méthode setPredictionSettings().

Tableau 1. Paramètres
Nom	Type	Description
options	Objet	Sélectionne une mesure à récupérer dans une plage de dates. Pour plus d’informations, consultez Configuration des mesures cibles. `{ "metricName" : "String", "fromDate" : "String", "toDate" : "String" }`
options.metricName		Nom de la mesure. Valeurs valides : precision coverage
options.fromDate		Facultatif. Date de début à partir de laquelle récupérer les mesures au format date/heure système.
options.àDate		Facultatif. Date de fin à partir de laquelle récupérer les mesures au format date/heure système.

Tableau 2. Renvoie
Type	Description
Objet	Objet JavaScript analysable contenant les résultats de la mesure d’entrée. `{ "metricName" : "String", "metricValue" : "String", "numberOfPredictionsConsidered" : "String" }`
Object.metricName	Nom de la mesure sélectionnée comme entrée. Type de données : chaîne
Object.metricValue	Valeur de la mesure sélectionnée. Type de données : chaîne
Object.numberOfRecordsConsidered	Nombre d’enregistrements dans la table Résultats de Predictor [ml_predictor_results] pris en compte pour les calculs. Type de données : chaîne

L’exemple suivant montre comment obtenir une valeur de précision à partir de la version active d’une solution.

// Get precision value
var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getPredictionPerformance({"metricName": "precision"})), null, 2));

Sortie :

{
  "metricName": "precision",
  "metricValue": "70.10",
  "numberOfPredictionsConsidered": "10"
}

ClassificationSolutionVersion : getPredictionSettings()

Obtient la précision estimée, la couverture estimée, les valeurs de rappel estimées à partir de la table des solutions ML [ml_solution] et les enregistrements de la table de confiance de classe [ml_class].

Tableau 3. Paramètres
Nom	Type	Description
Aucun

Tableau 4. Renvoie
Type	Description
Objet	Renvoie les paramètres de prédiction pour chaque classe. Les données incluent les valeurs de précision, de couverture, de rappel et de distribution de toutes les classes incluses dans le modèle formé à partir de la table Solutions ML [ml_solution]. Pour plus d’informations, consultez Composants de modèle prédictif. `{ "<class name>": {Object} }`
<Object>.<nom de classe>	Tableau d’objets fournissant des données statistiques d’entraînement provenant de la table Confiance de classe [ml_class]. Pour plus d’informations, consultez Configuration des mesures cibles. `{ "precision": "String", "coverage": "String", "recall": "String" }`
<Object>.<nom de classe>.precision	Mesure estimée de précision de la solution pour cette classe. Type de données : chaîne (valeur numérique)
<Object>.<nom de classe>.coverage	Mesure de couverture de solution estimée pour cette classe. Type de données : chaîne (valeur numérique)
<Object>.<nom de classe>.recall	Mesure de rappel de solution estimée pour cette classe. Type de données : chaîne (valeur numérique)

L’exemple suivant montre comment obtenir les paramètres de prédiction d’une version de solution active.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getPredictionSettings()), null, 2));

Sortie :

{
  "solutionSettings": {
    "precision": "61.69",
    "coverage": "66.75",
    "recall": "57.54"
  },
  "classSettings": {
    "Approvals": {
      "precision": "100",
      "coverage": "0",
      "recall": "0"
    },
    "Authentication": {
      "precision": "38.71",
      "coverage": "98.44",
      "recall": "56.25"
    },
    "Automation": {
      "precision": "100",
      "coverage": "0",
      "recall": "0"
    }, ...

ClassificationSolutionVersion : getProperties()

Obtient les propriétés de l’objet de solution et le numéro de version.

Tableau 5. Paramètres
Nom	Type	Description
Aucun

Tableau 6. Renvoie
Type	Description
Objet	Contenu du jeu de données et détails de la version de ClassificationSolution . Les résultats varient selon la configuration des propriétés de l’objet. `{ "algorithmConfig": { "algorithm": "String", "targetClassRecall": "String" }, "datasetProperties": {Object}, "domainName": "String", "encoder": {Object}, "groupByFieldName": "String", "inputFieldNames": [Array], "isActive": "Boolean", "label": "String", "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "stopwords": [Array], "trainingFrequency": "String", "versionNumber": "Number" }`
<Object>.algorithmConfig	Méthode de codage de la solution. Type de données : objet.
<Object>.algorithmConfig.algorithm	Nom de l’algorithme de codage pour la formation de cette solution. Valeurs possibles : xgboost: Encodage XGBoost pour optimiser l’entraînement. logisticRegression: Méthode utilisant le modèle de régression logistique pour des cibles catégorielles telles que nominales ou ordinales. Type de données : chaîne.
<Object>.algorithmConfig.targetClassRecall	Paramètre de rappel de classe pour orienter l’entraînement d’une solution afin de biaiser une classe spécifique. La valeur de rappel est un nombre compris entre 0 et 100 représentant un pourcentage. Type de données : chaîne
<Object>.datasetProperties	Répertorie les propriétés de l’objet DatasetDefinition() associé à la solution. `{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }` Type de données : objet.
<Object>.datasetProperties.tableName	Nom de la table pour le jeu de données. Par exemple, `« tableName » : « Incident »`. Type de données : chaîne.
<Object>.datasetProperties.fieldNames	Liste de noms de champs de la table spécifiée en tant que chaînes. Par exemple, `« fieldNames » : ["short_description », « priority"]`. Type de données : tableau.
<Object>.datasetProperties.fieldNames.fieldDetails	Liste des objets JavaScript qui spécifient les propriétés des champs. `[ { "name": "String", "type": "String" } ]` Type de données : tableau.
<Object>.datasetProperties.fieldNames.fieldDetails.<object>. Nom	Nom du champ définissant le type d’informations auquel restreindre cet ensemble de données. Type de données : chaîne.
<Object>.datasetProperties.fieldDetails.<object>. Type	Type de champ d’apprentissage machine. Type de données : chaîne.
<Object>.datasetProperties.fieldDetails.encodedQuery	Chaîne de requête codée au format Glide standard. Reportez-vous à la section Chaînes de requêtes codées. Type de données : chaîne.
<Object>.Domainname	Nom de domaine associé à cet ensemble de données. Reportez-vous aux sections Domain separation et Intelligence prédictive. Type de données : chaîne.
<Object>.Encodeur	Objet codeur affecté à cette solution. Reportez-vous à Encodeur - Encodeur (configuration d’objet). Type de données : objet.
<Object>.groupByFieldName	Nom de champ par lequel le système regroupe les enregistrements afin de créer des solutions de classification. Type de données : chaîne
<Object>.inputFieldNames	Liste des noms des champs d’entrée sous forme de chaînes. Le modèle utilise ces champs utilisés pour effectuer des prédictions. Type de données : chaîne.
<Object>.Isactive	Marqueur indiquant si cette version est active. Valeurs valides : true : la version est active. false : la version n’est pas active. Type de données : chaîne
<Object>.Étiquette	Identifie la tâche de prédiction. `{ "label": "my first prediction" }` Type de données : chaîne.
<Object>.Nom	Nom affecté par le système. Type de données : chaîne.
<Object>.predictedFieldName	Identifie un champ à former pour la prévisibilité. Type de données : chaîne.
<Object>.processingLanguage	Langue de traitement au format de code de langue ISO 639-1 à deux lettres. Type de données : chaîne.
<Object>.Portée	Périmètre de l’objet. Actuellement, la seule valeur valide est `globale`. Type de données : chaîne
<Object>.mots vides	Facultatif. Liste prédéfinie de chaînes que le système génère automatiquement en fonction du language paramètre de propriété. Pour plus d’informations, consultez Créer une liste de mots vides personnalisés. Type de données : tableau.
<Object>.trainingFrequency	Fréquence de reformation du modèle. Valeurs possibles : every_30_days every_60_days every_90_days every_120_days every_180_days run_once Valeur par défaut : run_once Type de données : chaîne.
<Object>.versionNumber	Numéro de version du Objet ClassificationSolution. Type de données : chaîne.

L’exemple suivant obtient les propriétés de la version de l’objet actif dans le magasin.

// Get properties
var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));

Sortie :

*** Script: {
  "datasetProperties": {
    "encodedQuery": "activeANYTHING^EQ",
    "fieldNames": [
      "short_description",
      "category"
    ],
    "tableName": "incident"
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "isActive": "true",
  "label": "Incident Categorization_Trainer",
  "name": "ml_incident_categorization",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

ClassificationSolutionVersion : getStatus(Boolean includeDetails)

Obtient l’état d’achèvement de la formation.

Tableau 7. Paramètres
Nom	Type	Description
includeDetails (en anglais seulement)	Booléen	Marqueur indiquant si l’état detailsdoit être renvoyé. Valeurs valides : true : renvoie des détails supplémentaires. false : ne renvoie pas de détails supplémentaires. Valeur par défaut : false

Tableau 8. Renvoie
Type	Description
Objet	Objet JavaScript contenant des informations sur l’état de la formation pour un objet ClassificationSolution . `{ "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {Object} }`
<Object>.état	État d’achèvement de la formation. Si la tâche de formation atteint un état final, la tâche ne quitte pas cet état. Si l’état est Terminal, la hasJobEnded propriété est définie sur `true`. Valeurs possibles : `fetching_files_for_training` `preparing_data` `retry` `solution_cancelled` (terminal) `solution_complete` (terminal) `solution_error` (terminal) `solution_incomplete` `training_request_received` `training_request_timed_out` (terminal) `training_solution` `uploading_solution` `waiting_for_training` Type de données : chaîne
<Object>.hasJobEnded	Marqueur indiquant si la formation est terminée. Valeurs valides : true : l’entraînement est terminé. false : la formation est incomplète. Type de données : valeur booléenne sous forme de chaîne
<Object>.percentComplete	Nombre compris entre zéro et 100 représentant le pourcentage d’achèvement de la formation. Si le pourcentage d’achèvement est inférieur à 100, la tâche peut être dans un état terminal. Par exemple, si la formation expire. Type de données : nombre sous forme de chaîne
<Object>.Détails	Objet contenant une liste de détails supplémentaires sur la formation. Type de données : objet

L’exemple suivant montre un résultat correct avec la formation terminée.

// Get status
var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));

Sortie :

{
 "state":"solution_complete",
 "percentComplete":"100",
 "hasJobEnded":"true",
 "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);
}

L’exemple suivant montre un échec alors que la formation est terminée.

// Get status
var solutionName = 'ml_x_snc_global_global_classification_solution';
var mlSolution = sn_ml.ClassificationSolutionStore.get(solutionName);
var trainingStatus = mlSolution.getLatestVersion().getStatus();

gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));

Sortie :

{
 "state":"solution_error",
 "percentComplete":"100",
 "hasJobEnded":"true"
}

ClassificationSolutionVersion : getTrainingStatistics()

Obtient toutes les statistiques de formation pour une solution donnée.

Tableau 9. Paramètres
Nom	Type	Description
Aucun

Tableau 10. Renvoie
Type	Description
Objet	Objet JavaScript avec des statistiques pour chaque classe incluse dans la formation et des valeurs pour chaque classe qui a été exclue de la formation. Pour plus d’informations, consultez Composants de modèle prédictif. `{ "includedClasses": {Object}, "excludedClasses": {Object} }`
<Object>.includedClasses	Objet contenant les valeurs de précision, de couverture, de rappel et de distribution de chaque classe dans le modèle formé. `"includedClasses": { "<class name>": { "distribution": "String", "statistics": [Array] },` Type de données : objet.
<Object>.includedClasses.<nom de classe>.distribution	Valeur de la distribution de probabilité de résultat pour cette classe. Type de données : chaîne
<Object>.includedClasses.<nom de classe>.statistics	Liste des objets fournissant des données statistiques d’entraînement. Pour plus d’informations, consultez Configuration des mesures cibles. `[ { "precision": "String", "coverage": "String", "recall": "String", "selected": "String" } ]` Type de données : tableau
<Object>.includedClasses.<nom de classe>.statistics.precision	Mesure estimée de précision de la solution pour cette classe. Type de données : chaîne (valeur numérique)
<Object>.includedClasses.<nom de classe>.statistics.coverage	Mesure de couverture de solution estimée pour cette classe. Type de données : chaîne (valeur numérique)
<Object>.includedClasses.<nom de classe>.statistics.recall	Mesure de rappel de solution estimée pour cette classe. Type de données : chaîne (valeur numérique)
<Object>.includedClasses.<nom de classe>.statistics.selected	Marqueur indiquant si cette classe contient des enregistrements inclus dans la formation à la solution. Valeurs valides : true : cette classe contient des enregistrements sélectionnés pour la formation de la solution. false : cette classe est exclue de la formation. Valeur par défaut : false Type de données : chaîne (valeur booléenne)
<Object>.excludedClasses	Répartition et nombre de lignes de toutes les classes exclues de la formation. `"excludedClasses": { "<class name>": { "distribution": "0.11", "rowCount": "9" }` Type de données : objet.
<Object>.excludedClasses.<nom de classe>.distribution	Valeur de la distribution de probabilité de résultat pour cette classe. Type de données : chaîne
<Object>.excludedClasses.<nom de classe>.rowCount	Nombre de lignes exclues de la formation. Type de données : chaîne (valeur numérique)

L’exemple suivant montre comment obtenir des statistiques d’entraînement à partir de la solution active.

// Get training stats
var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getTrainingStatistics()), null, 2));

Sortie :

{
  "includedClasses": {
    "Approvals": {
      "distribution": "0.43",
      "statistics": [
        {
          "precision": "100",
          "coverage": "0",
          "recall": "0",
          "selected": "true"
        }
      ]
    }, 
    "Authentication": {
      "distribution": "4.3",
      "statistics": [
        {
          "precision": "39.33",
          "coverage": "95.31",
          "recall": "54.69",
          "selected": "false"
        },
        {
          "precision": "100",
          "coverage": "0",
          "recall": "0",
          "selected": "false"
        },
     ...
    }
    ...
  "excludedClasses": {
    "ACE": {
      "distribution": "0.11",
      "rowCount": "9"
    },
    "AHA": {
      "distribution": "0.01",
      "rowCount": "1"
    }, 
    ...
}

ClassificationSolutionVersion : getVersionNumber()

Obtient le numéro de version de un objet de solution.

Tableau 11. Paramètres
Nom	Type	Description
Aucun

Tableau 12. Renvoie
Type	Description
Chaîne	Numéro de version.

L’exemple suivant montre comment obtenir un numéro de version.

// Get version number
var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

gs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));

Sortie :

Version number: 1

ClassificationSolutionVersion : predict(entrée d’objet, options de l’objet)

Obtient les données d’entrée pour une prédiction.

Tableau 13. Paramètres
Nom	Type	Description
entrée	Objet	Enregistrement Glide ou tableau d’objets JSON contenant des noms de champs et des valeurs sous forme de paires clé-valeur.
options	Objet	Valeurs facultatives pour filtrer les résultats de prédiction. `{ "apply_threshold": Boolean, "top_n": Number }`
options.apply_threshold	Booléen	Marqueur indiquant s’il faut vérifier la valeur de seuil de la solution et l’appliquer à l’ensemble de résultats. Valeurs valides : true : renvoie des résultats dans lesquels la confiance est supérieure au seuil. false : renvoie tous les résultats. Valeur par défaut : vrai
options.top_n	Numéro	Si fourni, renvoie les meilleurs résultats, jusqu’au nombre spécifié de prédictions.

Tableau 14. Renvoie
Type	Description
Objet	Objet JSON contenant les résultats de prédiction triés par sys_id ou record_number. `{ <identifier>: [Array] }`
<Object>.<identifier>	Liste d’objets avec des détails pour chaque résultat de prédiction. `<identifier>: [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ]` Type de données : tableau
<Object>.<identifier>.<object>. Confiance	Valeur de confiance associée à la prédiction. Par exemple, 53,84. Type de données : nombre
<Object>.<identifier>.<object>. predictedSysId	sys_id de la valeur prédite. Les résultats peuvent provenir de n’importe quelle table sur laquelle les informations sont prévues. Type de données : chaîne
<Object>.<identifier>.<object>. valeur prédictive	Valeur représentant le résultat de prédiction. Type de données : chaîne
<Object>.<identifier>.<object>. Seuil	Valeur du seuil configuré associé à la prédiction. Type de données : nombre

L’exemple suivant montre comment afficher les résultats de prédiction pour une méthode predict() qui utilise un GlideRecord par sys_id pour l’entrée et inclut des paramètres facultatifs pour se limiter aux trois premiers résultats et exclure la valeur de seuil.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

// single GlideRecord input
var input = new GlideRecord("incident");
input.get("<sys_id>");

// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;

var results = mlSolution.getVersion(1).predict(input, options);
// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));

Sortie :

{
  "<sys_id/gr>": [
    {
      "confidence": 62.10782320780268,
      "threshold": 20.36,
      "predictedValue": "Clone Issues",
      "predictedSysId": ""
    },
    {
      "confidence": 6.945237375770391,
      "threshold": 16.63,
      "predictedValue": "Instance Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 5.321061076300759,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    }
  ]
}

L’exemple suivant montre comment afficher les résultats de prédiction pour une méthode predict() qui prend un tableau de noms de champs comme paires clé-valeur pour l’entrée et inclut des paramètres facultatifs pour se limiter aux trois premiers résultats et exclure la valeur de seuil.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_incident_categorization');

// key-value pairs input
var input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];

// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;
var results = mlSolution.predict(input, options);

// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));

Sortie :

{
  "1": [
    {
      "confidence": 37.5023032262591,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 24.439964862166583,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 11.736320486031047,
      "threshold": 100,
      "predictedValue": "Security",
      "predictedSysId": ""
    }
  ],
  "2": [
    {
      "confidence": 99,
      "threshold": 17.77,
      "predictedValue": "Email",
      "predictedSysId": ""
    },
    {
      "confidence": 3.182137005157543,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 2.8773826570713514,
      "threshold": -1,
      "predictedValue": "Email (I/f)",
      "predictedSysId": ""
    }
  ]
}

ClassificationSolutionVersion : setPredictionSettings (options de l’objet)

Définit les valeurs de précision, de couverture ou de rappel au niveau de la solution ou de la classe.

Tableau 15. Paramètres
Nom	Type	Description
options	Objet	Valeurs de configuration de mesures. Pour plus d’informations sur ces fonctionnalités, reportez-vous à la section Configuration des mesures cibles. `{ "metricName" : "String", "metricValue" : "String", "className" : "String" }`
options.metricName	Chaîne	Nom de la mesure à définir. Valeurs valides : precision coverage recall
options.metricValue	Chaîne	Valeur numérique à affecter à la mesure.
options.className	Chaîne	Facultatif. Nom de la classe à laquelle restreindre les résultats. Utilisez la méthode getTrainingStatistics() pour récupérer une liste complète des classes d’une solution.

Tableau 16. Renvoie
Type	Description
Néant

L’exemple suivant montre comment définir une mesure de précision sur 89,5 pour une classe nommée Problèmes de clone.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');
var input = {"metricName" : "precision", "metricValue" : "89.5", "className" : "Clone Issues"};

mlSolution.getActiveVersion().setTrainingStatistics(input);