PredictabilityEstimateVersion : global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture

    • L’API PredictabilityEstimateVersion est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.

    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 .

    Utilisez cette API lorsque vous travaillez avec des versions d’estimation de prédictibilité basées sur des objets d’API PredictabilityEstimate dans le magasin PredictabilityEstimate.

    Le système active la version la plus récente de la Estimation de la prévisibilité à la fin de la formation et n’autorise qu’une seule version à être active à la fois. Toutefois, vous pouvez activer n’importe quelle version précédemment formée que vous souhaitez utiliser pour faire des prédictions.

    Les méthodes de cette API sont accessibles à l’aide des méthodes PredictabiltyEstimate suivantes :

    PrédictibilitéEstimateVersion : getProperties()

    Obtient les propriétés de et le numéro de versionl’objet d’estimation de la prédictibilité.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun
    Tableau 2. Renvoie
    Type Description
    Objet Contenu du jeu de données et détails de la version PredictabilityEstimate . Les résultats varient selon la configuration des propriétés de l’objet.
    {
  "datasetProperties": {Object},
  "domainName": "String", 
  "inputFieldNames": [Array],
  "label": "String",
  "name": "String",
  "predictedFieldName": "String",
  "scope": "String",
  "trainingFrequency": "String",
  "versionNumber": "Number"
}
    <Object>.datasetProperties (en anglais seulement)

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

    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}

    Type de données : Objet.
    <Object>.datasetProperties.tableName Nom de la table pour 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 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 du champ. 
    [
  {
    "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 limiter 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 du 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 en tant que chaînes à prendre en compte pour l’estimation.

    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 des raisons de 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.
    <Object>.numérodedeversion Numéro de version du Objet PredictabilityEstimate.

    Type de données : chaîne.

    L’exemple suivant récupère les propriétés de la version d’objet active dans le magasin.

    // Get properties
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

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

    Sortie :

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

    PredictabilityEstimateVersion : getResults()

    Renvoie les résultats JSON contenant les champs d’entrée suggérés pour un champ de sortie.

    Tableau 3. Paramètres
    Nom Type Description
    Aucun
    Tableau 4. Renvoie
    Type Description
    Objet Résultats d’objet JSON contenant des options de champ d’entrée suggérées pour un champ de sortie.
    <Object>.<output field name> Nom du champ de sortie, par exemple, catégorie, contenant des champs d’entrée suggérés.
    {
  "<output field name>": {
    "nominalInputFields": [Array],
    "textInputFields": [Array]
  }
}

    Type de données : objet
    <Object>.<output field name>. nominalInputFields Détails du champ d’entrée nominal.
    "nominalInputFields": [
      {
        "fieldName": "String",
        "modelImprovement": "String"     
      }
    ]

    Type de données : tableau.
    <Object>.<output field name>. nominalInputFields.fieldName Nom du champ d’entrée nominal.

    Type de données : chaîne.
    <Object>.<output field name>. nominalInputFields.modelImprovement Score en tant qu’indication relative de la probabilité que ce champ améliore les résultats.

    Type de données : nombre sous forme de chaîne.
    <Object>.textInputFields Détails des champs d’entrée de texte.
    
    "textInputFields": [
      {
        "fieldName": "String",
        "density": "String"
      }
    ]

    Type de données : tableau.
    <Object>.textInputFields.fieldName Nom du champ d’entrée de texte.

    Type de données : chaîne.
    <Object>.textInputFields.density Valeur comprise entre 0 et 1,0 qui représente la fréquence à laquelle le champ n’est pas vide. Une valeur de 1,0 signifie que le champ n’est pas vide dans toutes les lignes, et une valeur de 0 indique que le champ est vide dans toutes les lignes.

    Type de données : nombre sous forme de chaîne.

    L’exemple suivant montre comment obtenir des résultats pour une version sélectionnée d’une estimation de la prévisibilité dans le magasin.

    // Get results
var estimateName = "ml_x_snc_global_global_predictability_estimate;"
var mlEstimate = sn_ml.PredictabilityEstimateStore.get(estimateName);

var results = mlEstimate.getActiveVersion().getResults();

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

    Sortie :

    {
  "category": {
    "nominalInputFields": [
      {
        "fieldName": "number",
        "modelImprovement": "0.167052396325189"
      },
      {
        "fieldName": "task_effective_number",
        "modelImprovement": "0.167052396325189"
      }
    ],
    "textInputFields": [
      {
        "fieldName": "short_description",
        "density": "1.0"
      }
    ]
  }
}

    PredictabilityEstimateVersion : getStatus(Boolean includeDetails)

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

    Tableau 5. Paramètres
    Nom Type Description
    includeDetails (en anglais seulement) Booléen Marqueur indiquant s’il faut renvoyer l’état details.
    Valeurs valides :
    • true : renvoyer des détails supplémentaires.
    • false : ne renvoyez pas de détails supplémentaires.

    Valeur par défaut : false
    Tableau 6. Renvoie
    Type Description
    Objet Objet JavaScript contenant des informations sur l’état de la formation pour un objet PredictabilityEstimate .
    {
  "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 terminal, la tâche ne quitte pas cet état. Si l’état est final, 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 : la formation est terminée.
    • false : la formation est incomplète.

    Type de données : valeur booléenne sous forme de chaîne
    <Object>.percentComplete Pourcentage de formation terminée. 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

    Plage : 0 à 100
    <Object>.Détails Objet contenant une liste de détails de formation supplémentaires.

    Type de données : objet

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

    // Get status
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlEstimate.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 résultat d’échec une fois la formation terminée.

    // Get status
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_my_estimate_definition');
var trainingStatus = mlEstimate.getLatestVersion().getStatus();

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

    Sortie :

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

    PredictabilityEstimateVersion : getVersionNumber()

    Obtient le numéro de version de Objet d’estimation de la prévisibilité.

    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    Chaîne Numéro de version.

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

    // Get version number
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

    Sortie :

    Version number: 1