PredictabilityEstimate : global

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 7 minutes de lecture

    • L’API PredictabilityEstimate est un objet pouvant contenir des scripts utilisé dans les Intelligence prédictive magasins. Cet objet fournit une estimation de la prévisibilité des champs d’un jeu de données et des fonctionnalités qui peuvent être utiles pour prédire ces champs.

    Ce L’API nécessite le module d’extension Intelligence prédictive (com.glide.platform_ml) et est fournie dans l’espace de noms sn_ml .

    Le flux de configuration à formation de l’estimation de la prévisibilité est le suivant :
    1. Créez un jeu de données à l’aide de l’API DatasetDefinition .
    2. Utilisez le constructeur pour créer un objet d’estimation de prévisibilité.
    3. Ajoutez l’objet d’estimation de prévisibilité au magasin d’estimation de prévisibilité à l’aide de la méthode PredictabilityEstimateStore - add( ).
    4. Entraînez l’estimation de la prévisibilité à l’aide de la méthode submitTrainingJob( ). Cela crée une version de l’objet que vous pouvez gérer à l’aide de l’API PredictabilityEstimateVersion .
    5. Obtenez les valeurs prédictives estimées à l’aide de la méthode PredictabilityEstimateVersion – getResults().
    Remarque :
    Cette API s’exécute avec des privilèges complets avant la Washington DC version du correctif 7. Après cette version, accordez l’accès à l’aide des ACL. Pour en savoir plus, consultez Query ACLs.

    Pour connaître des directives d’utilisation, reportez-vous à la section Utilisation des API ML.

    PredictabilityEstimate : PredictabilityEstimate(Configuration de l’objet)

    Crée une estimation de prévisibilité.

    Pour obtenir de nouvelles estimations de prévisibilité sur le même jeu de données, utilisez ce constructeur pour créer un nouvel objet PredictabilityEstimate avec un nom unique.

    Tableau 1. Paramètres
    Nom Type Description
    configuration Objet Objet JavaScript contenant les propriétés de configuration de Estimation de la prévisibilité.
    {
  "dataset": {Object},
  "domainName": "String",
  "inputFieldNames": [Array],
  "label": "String",
  "minRowCount": "String",
  "predictedFieldName": "String",
  "trainingFrequency": "String"
}
    config.ensemble de données Objet Nom DatasetDefinition .
    nom.domaine config Chaîne Facultatif. Nom de domaine associé à cet ensemble de données. Voir Séparation de domaine et Intelligence prédictive.

    Par défaut : domaine actuel, par exemple, « global ».
    config.inputFieldNames Tableau Liste des champs d’entrée candidats sous forme de chaînes à prendre en compte pour l’estimation.
    config.étiquette Chaîne Identifie la tâche de prédiction.
    config.minRowCount Chaîne Facultatif. Nombre minimum d’enregistrements requis dans l’ensemble de données pour la formation.

    Par défaut : 10000
    config.predictedFieldName Chaîne Identifie un champ à former pour la prévisibilité.
    config.trainingFrequency Chaîne Facultatif. 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
    Par défaut : run_once

    L’exemple suivant montre comment créer une tâche d’estimation et l’ajouter au magasin PredictabilityEstimate.

    var myIncidentData = new sn_ml.DatasetDefinition({
  'tableName' : 'incident',
  'encodedQuery' : 'activeANYTHING'
});

var myEstimate = new sn_ml.PredictabilityEstimate({
  'label': "predictability estimate",
  'dataset' : myIncidentData,
  'inputFieldNames':['short_description'], 
  'predictedFieldName': 'category'
});

var myEstimateName = sn_ml.PredictabilityEstimateStore.add(myEstimate);

    PredictabilityEstimate : cancelTrainingJob()

    Annule une tâche pour Objet d’estimation de la prévisibilité qui a été soumis à la formation.

    Tableau 2. Paramètres
    Nom Type Description
    Aucun
    Tableau 3. Renvoie
    Type Description
    Néant

    L’exemple suivant montre comment annuler une tâche de formation existante.

    var myEstimate = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

myEstimate.cancelTrainingJob();

    PredictabilityEstimate : getActiveVersion()

    Obtient l’actif Objet PredictabilityEstimateVersion.

    Tableau 4. Paramètres
    Nom Type Description
    Aucun
    Tableau 5. Renvoie
    Type Description
    Objet Objet PredictabilityEstimateVersion actif.

    L’exemple suivant montre comment obtenir une version active Estimation de la prévisibilité à partir du magasin et renvoyer son état de formation.

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

    Sortie :

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

    PredictabilityEstimate : getAllVersions()

    Obtient toutes les versions de une estimation de prévisibilité.

    Tableau 6. Paramètres
    Nom Type Description
    Aucun
    Tableau 7. Renvoie
    Type Description
    Tableau Versions existantes d’un objet de solution. Voir aussi PredictabilityEstimateVersion API.

    L’exemple suivant montre comment obtenir tous les objets de version PredictabilityEstimate et y appeler les méthodes de version d’estimation getVersionNumber() et getStatus().

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

var mlEstimateVersions = mlEstimate.getAllVersions();

for (i = 0; i < mlEstimateVersions.length; i++) {
gs.print("Version " + mlEstimateVersions[i].getVersionNumber() + " Status: " + mlEstimateVersions[i].getStatus() +"\n");
};

    Sortie :

    Version 3 Status: {"state":"predictability_estimate_complete","percentComplete":"100","hasJobEnded":"true"}

Version 2 Status: {"state":"predictability_estimate_complete","percentComplete":"100","hasJobEnded":"true"}

Version 1 Status: {"state":"predictability_estimate_cancelled","percentComplete":"0","hasJobEnded":"true"}

    PredictabilityEstimate : getLatestVersion()

    Obtient la dernière version de une estimation de prévisibilité.

    Tableau 8. Paramètres
    Nom Type Description
    Aucun
    Tableau 9. Renvoie
    Type Description
    Objet PredictabilityEstimateVersion Objet correspondant à la dernière version de a PredictabilityEstimate().

    L’exemple suivant montre comment obtenir la dernière version d’une Une estimation de prévisibilité et renvoyer son état de formation.

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

gs.print(JSON.stringify(JSON.parse(mlEstimate.getLatestVersion().getStatus()), null, 2));

    Sortie :

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

    PredictabilityEstimate : getName()

    Obtient le nom de l’objet à utiliser pour l’interaction avec le magasin.

    Tableau 10. Paramètres
    Nom Type Description
    Aucun
    Tableau 11. Renvoie
    Type Description
    Chaîne Nom de l’objet d’estimation.

    L’exemple suivant montre comment mettre à jour Estimation de la prévisibilité informations d’un jeu de données et imprimer le nom de l’objet.

    // Update estimate
var myIncidentData = new sn_ml.DatasetDefinition({
   'tableName' : 'incident',
   'fieldNames' : ['category', 'short_description', 'priority'],
   'encodedQuery' : 'activeANYTHING'
});

var myEstimate = new sn_ml.PredictabilityEstimate({
   'label': "my estimate",
   'dataset' : myIncidentData,
   'inputFieldNames':['short_description'],
   'predictedFieldName': 'category'
});

// update estimate
sn_ml.PredictabilityEstimateStore.update('ml_x_snc_global_global_my_definition_4', myEstimate);

// print estimate name
gs.print('Estimate Name: '+myEstimate.getName());

    Sortie :

    Estimate Name: ml_x_snc_global_global_my_definition_4

    PredictabilityEstimate : getProperties()

    Obtient les propriétés de l’objet d’estimation de prévisibilité.

    Tableau 12. Paramètres
    Nom Type Description
    Aucun
    Tableau 13. Renvoie
    Type Description
    Objet Contenu du jeu de données et détails de l’objet PredictabilityEstimate() dans PredictabilityEstimateStore.
    {
  "datasetProperties": {Object},
  "domainName": "String",
  "inputFieldNames": [Array],
  "label": "String",
  "name": "String",
  "predictedFieldName": "String",
  "scope": "String",
  "trainingFrequency": "String"
}
    <Object>.datasetProperties

    Répertorie les propriétés de l’objet DatasetDefinition() associé à l’estimation.

    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}
    <Object>.datasetProperties.tableName Nom de la table de l’ensemble de données. Par exemple, « tableName » : « Incident ».

    Type de données : chaîne.
    <Object>.datasetProperties.fieldNames Liste des noms de champs de la table spécifiée sous forme de 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. Voir Chaînes de requête codées.

    Type de données : chaîne.
    <Object>nom .domainName Nom de domaine associé à cet ensemble de données. Voir Séparation de domaine et Intelligence prédictive.

    Type de données : chaîne.
    <Object>.inputFieldNames Liste des champs d’entrée candidats sous forme de chaînes à prendre en compte pour l’estimation.

    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>.portée Périmètre de l’objet. Actuellement, la seule valeur valide est global.

    Type de données : chaîne
    <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
    Par défaut : run_once

    Type de données : chaîne.

    L’exemple suivant obtient les propriétés d’un objet de Objet d’estimation de la prévisibilité dans le magasin.

    var mySolution = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

gs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));
    Sortie :
    *** Script: {
  "datasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "category",
      "short_description",
      "priority",
      "assignment_group.name"
    ],
    "fieldDetails": [
      {
        "name": "category",
        "type": "nominal"
      },
      {
        "name": "short_description",
        "type": "text"
      }
    ]
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "label": "my estimate definition",
  "name": "ml_x_snc_global_global_my_definition_26",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "trainingFrequency": "run_once"
}

    PredictabilityEstimate : getVersion(version de chaîne)

    Obtient une estimation de la prévisibilité Par numéro de version fourni.

    Tableau 14. Paramètres
    Nom Type Description
    version Chaîne Numéro de version existante d’une une estimation de prévisibilité.
    Tableau 15. Renvoie
    Type Description
    Objet Version spécifiée de l’objet PredictabilityEstimate() sur lequel vous pouvez appeler les méthodes d’API PredictabilityEstimateVersion .

    L’exemple suivant montre comment obtenir l’état de formation d’une Estimation de la prévisibilité par numéro de version.

    var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

gs.print(JSON.stringify(JSON.parse(mlEstimate.getVersion('1').getStatus()), null, 2));

    Sortie :

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

    PredictabilityEstimate : setActiveVersion(version de chaîne)

    Active une version spécifiée d’une estimation de prévisibilité dans le magasin.

    Tableau 16. Paramètres
    Nom Type Description
    version Chaîne Nom de la version de l’objet PredictabilityEstimate() à activer.

    L’activation de cette version désactive toute autre version.
    Tableau 17. Renvoie
    Type Description
    Néant

    L’exemple suivant montre comment activer Une estimation de la prévisibilité version de solution dans le magasin.

    sn_ml.PredictabilityEstimate.setActiveVersion("ml_x_snc_global_global_my_estimate_definition");

    PredictabilityEstimate : submitTrainingJob()

    Soumettez une tâche de formation.

    Remarque :
    Avant d’exécuter cette méthode, vous devez d’abord ajouter une estimation de prévisibilité au magasin à l’aide de la méthode PredictabilityEstimateStore - add( ).
    Tableau 18. Paramètres
    Nom Type Description
    Aucun
    Tableau 19. Renvoie
    Type Description
    Objet PredictabilityEstimateVersion Objet correspondant au cours de PredictabilityEstimate formation.

    L’exemple suivant montre comment créer un jeu de données, l’appliquer à Une estimation de prévisibilité, ajoutez-la à un magasin et soumettre la tâche de formation.

    // Create a dataset 
var myData = new sn_ml.DatasetDefinition({

  'tableName' : 'incident',
  'fieldNames' : ['assignment_group', 'short_description', 'description'],
  'encodedQuery' : 'activeANYTHING'

});

// Create an estimate 
var myEstimate = new sn_ml.PredictabilityEstimate({

  'label': "my estimate definition",
  'dataset' : myData,
  'predictedFieldName' : 'assignment_group',
  'inputFieldNames':['short_description']

});

// Add the estimate to the store to later be able to retrieve it.
var my_unique_name = sn_ml.PredictabilityEstimateStore.add(myEstimate);

// Train the estimate - this is a long running job 
var myEstimateVersion = myEstimate.submitTrainingJob();