ClusteringSolutionVersion : global

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 20 minutes de lecture
  • L’API ClusteringSolutionVersion est un objet pouvant contenir des scripts utilisé dans les Intelligence prédictive magasins.

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

    Cette API est utilisée pour travailler avec les versions de solutions basées sur les objets d’API ClusteringSolution dans le magasin ClusteringSolution.

    Le système crée une version de solution chaque fois que vous formez une définition de solution. La plupart des versions sont créées pendant la formation planifiée sur la solution.

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

    ClusteringSolutionVersion : cancelUpdateJob()

    Annule une tâche de mise à jour sur un formateur.

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

    L’exemple suivant montre comment annuler une tâche d’entraînement active qui a été soumise à l’aide de la méthode submitTrainingJob().

    var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");
    var mlSolutionVersion = myCluster.getActiveVersion();
    
    mlSolutionVersion.cancelUpdateJob();

    ClusteringSolutionVersion : deleteClusterAssignments (options de l’objet)

    Supprime les affectations de grappe des lignes par position dans la séquence de table ou GlideDateTime.

    Tableau 3. Paramètres
    Nom Type Description
    options Objet Objet définissant une option pour la suppression des affectations de grappes.
    Remarque :
    Une seule option de suppression est valide.
    options.updatedUntil Chaîne Supprime les lignes des grappes dont les valeurs updated_since apparaissent avant cette valeur. Le format doit être fourni en tant que GlideDateTime.
    { "updatedUntil" : "String" }
    options.sequenceUntil Chaîne Supprime des lignes pour les grappes avec insert_sequence valeurs se produisant avant cette valeur dans la table Détails de la grappe ML [ml_cluster_detail]. La valeur du point de départ de la position de la séquence est 1.
    { "sequenceUntil" : Number }
    Tableau 4. Renvoie
    Type Description
    Numéro Nombre de lignes supprimées de la table Détails de la grappe ML [ml_cluster_detail].

    L’exemple suivant montre comment supprimer des lignes pour des clusters dont updated_since’heure est antérieure à « 2020-06-28 02 :50 :53 ».

    var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");
    
    var mlSolutionVersion = mlSolution.getActiveVersion();
    
    var options = {};
    options.updatedUntil = '2020-06-28 02:50:53';
    
    var results = mlSolutionVersion.deleteClusterAssignments(options);
    
    gs.print("Number of deleted rows: "+results);

    Sortie :

    Number of deleted rows: 6417

    L’exemple suivant montre comment supprimer des lignes pour des grappes avec des updated_since positionnées séquentiellement avant 1 000.

    var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");
    
    var mlSolutionVersion = mlSolution.getActiveVersion();
    
    var options = {};
    options.sequenceUntil = 1000;
    
    var results = mlSolutionVersion.deleteClusterAssignments(options);
    
    gs.print("Number of deleted rows: "+results);

    Sortie :

    Number of deleted rows: 999

    ClusteringSolutionVersion : getClusterAssignments(options de l’objet)

    Obtient des affectations pour une solution de mise en grappe.

    Tableau 5. Paramètres
    Nom Type Description
    options Objet Valeurs à utiliser pour affiner les résultats renvoyés par groupe, niveau, heures de mise à jour du système et numéro de ligne de table au sein d’une solution de mise en grappe. Au moins un argument doit être spécifié.
    {
         "cluster_id": "String",
         "group_by": "String",
         "limit": Number,
         "sequenceSince": Number,
         "sequenceUntil": Number,
         "topNPerCluster": Number,
         "updatedSince": "String",
         "updatedUntil": "String"
    }
    options.cluster_id Chaîne Facultatif. ID de grappe d’une solution formée dans la table Récapitulatif de la grappe [ml_cluster_summary].
    options.group_by Chaîne Facultatif. Identifie le champ de segmentation pour lequel récupérer les appartenances à des grappes, par exemple assignment_group.

    Ce champ fournit le même regroupement que les options fournies dans la case à cocher Utiliser le groupe par du formulaire Définition de regroupement . Les informations fournies varient en fonction de la table sélectionnée dans le champ Table . Pour plus d’informations, consultez Créer et former une solution de mise en grappe .

    options.limite Numéro Facultatif. Nombre maximal d’affectations de grappes à récupérer.
    options.sequenceSince Numéro Position de départ dans une séquence de tableaux. Renvoie des informations pour les grappes avec insert_sequence activées et positionnées après cette valeur dans la table Détails de la grappe ML [ml_cluster_detail]. La valeur du point de départ de la position de la séquence est 1.
    options.sequenceUntil Numéro Renvoie les affectations pour les grappes avec insert_sequence valeurs se produisant avant cette valeur dans la table Détails de la grappe ML [ml_cluster_detail]. La valeur du point de départ de la position de la séquence est 1.
    options.topNPerCluster Numéro Nombre des meilleurs résultats à recevoir pour chaque grappe.
    options.updatedDepuis Chaîne Facultatif. Date et heure. Renvoie des informations pour les grappes avec sys_updated_on après la valeur fournie dans GlideDateTime.
    options.updatedUntil Chaîne Facultatif. Date et heure. Renvoie des informations pour les grappes dont le sys_updated_on précède la valeur fournie dans GlideDateTime.
    Tableau 6. Renvoie
    Type Description
    Tableau Liste des objets contenant des informations de grappe par ordre croissant de cluster_id.
    [
        {
           "cluster_id": "String",
           "group_by": "String",
           "rec_display_id": "String",
           "rec_sys_id": "String"
         }
    ]
    <object>.cluster_id Numéro de grappe unique au sein d’une solution de grappes.
    <object>.group_by si groupé, nom du champ de segmentation associé à cette grappe.
    <object>.rec_display_id Type et numéro d’enregistrement.
    <object>.rec_sys_id Enregistrer sys_id.

    L’exemple suivant montre comment utiliser l’objet pour filtrer les options résultats de mise en grappe.

    var mlSolution = sn_ml.ClusteringSolutionStore.get("solution_name");
    
    var mlSolutionVersion = mlSolution.getActiveVersion();
    
    var options = {};
    options.clusterId = 56;
    options.topNPerCluster = 10;
    options.updatedUntil = '2020-01-17 23:16:14'; 
    options.updatedSince = '2020-01-17 23:16:13'; 
    options.sequenceUntil = 1000; 
    options.sequenceSince = 1100; 
    options.limit = 100;
    
    var results = mlSolutionVersion.getClusterAssignments(options)
    
    gs.print(results);

    Sortie :

    [{"cluster_id":"1","rec_display_id":"Incident": "INC0014483","rec_sys_id":"04e33e7adb401300864adfea5e961900","group_by":"network"},
     {"cluster_id":"1","rec_display_id":"Incident": "INC0011133","rec_sys_id":"5bd23af2db401300864adfea5e96194d","group_by":"network"}]

    ClusteringSolutionVersion : getClusterInfo (options de l’objet)

    Obtient des informations pour une solution de mise en grappe spécifiée dans le magasin. La mesure de pureté fournit des informations sous forme de pourcentage pour les champs de regroupement sur lesquels la pureté est basée.

    Tableau 7. Paramètres
    Nom Type Description
    options Objet Facultatif. Objet contenant des propriétés qui permettent de filtrer les résultats au sein d’une solution de mise en grappe.
    {
      "clusterId": "String",     
      "groupBy": "String",
      "limit": "String",
      "recSysId": "String",
      "sequenceSince": Number,
      "sequenceUntil": Number,
      "updatedSince": "String",
      "updatedUntil": "String"
    }

    Par défaut : renvoie les appartenances à des grappes pour toutes les grappes.

    options.clusterId Chaîne Facultatif. ID de grappe d’une solution formée dans la table Récapitulatif de la grappe [ml_cluster_summary].
    options.groupBy Chaîne Facultatif. Identifie le champ de segmentation pour lequel récupérer les appartenances à des grappes, par exemple assignment_group.

    Ce champ fournit le même regroupement que les options fournies dans la case à cocher Utiliser le groupe par du formulaire Définition de regroupement . Les informations fournies varient en fonction de la table sélectionnée dans le champ Table . Pour plus d’informations, consultez Créer et former une solution de mise en grappe .

    options.limite Numéro Facultatif. Nombre maximal d’affectations de grappes à récupérer.
    options.recSysId Chaîne Facultatif. Sys_id d’un enregistrement par lequel trouver des informations sur la grappe.
    options.sequenceSince Numéro Position de départ dans une séquence de tableaux. Renvoie des informations pour les grappes avec insert_sequence activées et positionnées après cette valeur dans la table Détails de la grappe ML [ml_cluster_detail]. La valeur du point de départ de la position de la séquence est 1.
    options.sequenceUntil Numéro Facultatif. Position de fin dans une séquence de table. Renvoie les affectations pour les grappes avec insert_sequence valeurs se produisant avant cette valeur dans la table Détails de la grappe ML [ml_cluster_detail]. La valeur du point de départ de la position de la séquence est 1.
    options.updatedDepuis Chaîne Facultatif. Date et heure. Renvoie des informations pour les grappes avec sys_updated_on après la valeur fournie dans Format GlideDateTime.
    options.updatedUntil Chaîne Facultatif. Date et heure. Renvoie des informations pour les grappes dont le sys_updated_on précède la valeur fournie dans GlideDateTime.
    Tableau 8. Renvoie
    Type Description
    Tableau Liste des objets contenant des informations sur la grappe.
    [
      {   
        "cluster_concept": "String",
        "cluster_id": "String",
        "cluster_quality": "String",
        "cluster_size": "String",
        "group_by": "String",
        "insert_sequence": "String",
        "purity": "String",
        "sys_updated_on": "String"
      }
    ]
    <object>.cluster_concept Ensemble de mots qui décrivent la grappe par ordre décroissant de fréquence.

    Type de données : chaîne

    <object>.cluster_id Numéro de grappe unique au sein d’une solution de grappes.
    <object>.cluster_quality Nombre compris entre 0 et 100. Des valeurs plus élevées indiquent une densité d’agrégats plus élevée.

    Type de données : chaîne

    <object>.cluster_size Nombre d’enregistrements dans une grappe.

    Type de données : chaîne

    <object>.group_by si groupé, nom du champ de segmentation associé à cette grappe.

    Type de données : chaîne

    <object>.insert_sequence Numéro de position séquentiel de la grappe dans la table Récapitulatif de la grappe [ml_cluster_summary].

    Type de données : chaîne

    <object>.Pureté Valeur en pourcentage représentant la pureté de la qualité de la grappe.
    <object>.sys_updated_on Valeur GlideDateTime du système représentant la date et l’heure de dernière mise à jour de cette grappe.

    Type de données : chaîne

    L’exemple suivant montre comment définir le paramètre d’objet options et imprimer les résultats de la grappe filtrée.

    var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");
    
    var mlSolutionVersion = mlSolution.getActiveVersion();
    
    var options = {};
    options.updatedSince = '2020-05-28 02:09:53'; 
    options.updatedUntil = '2020-05-28 03:15:00';
    options.sequenceSince = 1;
    options.limit = 10;
    
    var results = mlSolutionVersion.getClusterInfo(options);
    
    gs.print(JSON.stringify(JSON.parse(results), null, 2));

    Sortie :

    [
      {
        "cluster_id": "1",
        "cluster_quality": "100",
        "cluster_size": "17",
        "purity": "",
        "insert_sequence": "8",
        "group_by": "VPN   Customer",
        "sys_updated_on": "2020-05-28 02:09:53",
        "cluster_concept": "vpn instance connection ldap user log unable usability tunnel"
      },
      {
        "cluster_id": "1",
        "cluster_quality": "100",
        "cluster_size": "10",
        "purity": "",
        "insert_sequence": "24",
        "group_by": "Live Feed",
        "sys_updated_on": "2020-05-28 02:09:53",
        "cluster_concept": "feed live user note work disable group default usability sort"
      },
      {
        "cluster_id": "1",
        "cluster_quality": "100",
        "cluster_size": "18",
        "purity": "",
        "insert_sequence": "40",
        "group_by": "Integrations",
        "sys_updated_on": "2020-05-28 02:09:53",
        "cluster_concept": "integrate usability certificate error"
      },
    ...
    ]

    ClusteringSolutionVersion : getProperties()

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

    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    Objet Contenu du jeu de données et détails de la version de ClusteringSolution . Les résultats varient selon la configuration des propriétés de l’objet.
    {
      "algorithmConfig": {Object},
      "datasetProperties": {Object},
      "domainName": "String",
      "encoder": {Object},
      "groupByFieldName": "String", 
      "inputFieldNames": [Array],
      "isActive": "Boolean",
      "label": "String",
      "minRecordsPerCluster" : Number,
      "name": "String",  "processingLanguage": "String",
      "scope": "String",
      "stopwords": [Array],
      "trainingFrequency": "String",
      "updateFrequency": "String",
      "versionNumber": "Number"
    }
    <Object>.algorithmConfig Objet JavaScript contenant les propriétés de configuration de l’algorithme. Les résultats relatifs à la propriété varient selon la valeur définie dans la algorithm propriété.
    'algorithmConfig' : {
      "algorithm": "String",  
      // See algorithmConfig.algorithm setting description for property settings based on algorithm
    }

    Type de données : objet.

    <Object>.algorithmConfig.algorithm Méthode de codage de votre solution.
    Propriétés pour dbscan:
    'algorithmConfig': {
      "algorithm": "dbscan",
      "distanceMetric": "String",
      "epsilon": Number,
      "minimumNeighbours": Number
    }
    Propriétés pour kmeans:
    'algorithmConfig': {
      "algorithm": "kmeans",
      "targetCoverage": Number
    }

    Type de données : chaîne.

    <Object>.algorithmConfig.distanceMetric Algorithme DBSCAN uniquement. Mesure de distance à analyser pour rechercher des objets de données similaires.

    Type de données : chaîne.

    <Object>.algorithmConfig.epsilon Algorithme DBSCAN uniquement. Valeur décimale comprise entre 0 et 1 représentant la taille du rayon de recherche du quartier.

    Type de données : nombre.

    <Object>.algorithmConfig.minimumNeighbours Algorithme DBSCAN uniquement. Nombre minimum de voisins requis dans un point pour faire partie d’une grappe. En effet levenshteinDistance , la valeur doit être 1 afin qu’aucun point ne soit exclu du jeu de données.

    Type de données : nombre.

    <Object>.algorithmConfig.targetCoverage K-signifie uniquement l’algorithme. Champ de centile pour filtrer les enregistrements qui sont moins similaires les uns aux autres.

    Type de données : nombre.

    <Object>.datasetProperties

    Répertorie les propriétés de l’objet DatatsetDefinition 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 » : [&quot;short_description », « priority&quot;].

    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.

    Propriétés objet.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 en une ou plusieurs grappes.

    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>.minRecordsPerCluster Nombre minimum d’enregistrements à autoriser dans n’importe quelle grappe.

    Type de données : nombre.

    <Object>.Nom Nom affecté par le système.

    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>.updateFrequency (en anglais seulement) Fréquence à laquelle le modèle de la définition de solution doit être reconstruit.
    Valeurs possibles :
    • do_not_update
    • every_1_day
    • every_1_hour
    • every_6_hours
    • every_12_hours
    • every_1_minute
    • every_15_minutes
    • every_30_minutes
    Valeur par défaut : do_not_update

    Type de données : chaîne

    <Object>.versionNumber Numéro de version du Objet ClusteringSolution.

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

    // Get properties
    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');
    
    gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));

    Sortie :

    *** Script: {
      "algorithmConfig": {
        "algorithm": "kmeans",
        "targetCoverage": "90"
      },
      "datasetProperties": {
        "tableName": "incident",
        "fieldNames": [
          "category",
          "short_description",
          "state",
          "description"
        ],
        "encodedQuery": "activeANYTHING"
      },
      "domainName": "global",
      "encoderProperties": {
        "datasetsProperties": [
          {
            "tableName": "incident",
            "fieldNames": [
              "assignment_group",
              "short_description",
              "description"
            ],
            "encodedQuery": "activeANYTHING"
          }
        ],
        "domainName": "global",
        "isActive": "true",
        "label": "my encoder definition",
        "name": "ml_x_snc_global_global_my_encoder_definition",
        "processingLanguage": "en",
        "stopwords": [
          "Default English Stopwords"
        ],
        "versionNumber": "1"
      },
      "groupByFieldName": "category",
      "inputFieldNames": [
        "short_description"
      ],
      "isActive": "true",
      "label": "clustering solution",
      "minRecordsPerCluster": 2,
      "name": "ml_x_snc_global_global_clustering_solution",
      "processingLanguage": "en",
      "stopwords": [
        "Default English Stopwords"
      ],
      "updateFrequency": "do_not_update",
      "versionNumber": "1"
    }

    ClusteringSolutionVersion : getStatus(Boolean includeDetails)

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

    Tableau 11. 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 12. Renvoie
    Type Description
    Objet Objet JavaScript contenant des informations sur l’état de la formation pour un objet ClusteringSolution .
    {
      "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.ClusteringSolutionStore.get('ml_x_snc_global_global_cluster_solution');
    
    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_cluster_solution';
    var mlSolution = sn_ml.ClusteringSolutionStore.get(solutionName);
    var trainingStatus = mlSolution.getLatestVersion().getStatus();
    
    gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));

    Sortie :

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

    ClusteringSolutionVersion : getTopNPurityInfo (options de l’objet)

    Obtient les meilleurs résultats de pureté pour une solution de clustering. La mesure de pureté fournit des informations sous forme de pourcentage pour les champs de regroupement sur lesquels la pureté est basée.

    Tableau 13. Paramètres
    Nom Type Description
    options Objet Options qui déterminent le nombre et le format des résultats de pureté des grappes supérieures.
    {
      "clusterIds": [Array],
      "groupBy": [Array],
      "purityFields": [Array],
      "topN": Number,
      "topNFields": Number
    }
    options.clusterIds Tableau Facultatif. Liste des ID de grappe fournis sous forme de chaînes. Un ID de grappe est fourni dans la table Récapitulatif de la grappe [ml_cluster_summary]. Si elle est fournie, cette méthode renvoie des informations de grappe de pureté pour chaque grappe spécifiée.

    Par défaut : cette méthode renvoie des informations de pureté pour toutes les grappes.

    options.groupBy Tableau Facultatif. Liste des chaînes de champs group_by de votre table pour aider le système à identifier la classe la plus fréquente dans la grappe. Si fournie, elle renvoie les informations de pureté pour les solutions de grappe utilisant group_by champs. La table Récapitulatif des grappes [ml_cluster_summary] répertorie les grappes et toutes les valeurs Grouper par.

    Ce champ s’applique uniquement aux grappes qui utilisent Grouper par dans la définition de regroupement. Les champs éligibles sont répertoriés dans le champ Table . Pour plus d’informations sur la fonctionnalité Regrouper par, reportez-vous à Créer et former une solution de mise en grappe.

    options.purityFields Tableau Facultatif. Liste des chaînes de champ de pureté. Si elle est fournie, cette méthode ne renvoie que des informations pour ces champs de pureté. Vous pouvez afficher les valeurs de pureté d’une grappe dans les listes de la table Récapitulatif de la grappe [ml_cluster_summary].
    Remarque :
    Si les deux purity_fields et top_n_fields sont fournis, cette méthode renvoie top_n_fields d’abord, puis sélectionne les champs de purity_fields.

    Par défaut : renvoie les informations de pureté pour tous les champs de pureté enregistrés pour la grappe.

    options.topN Numéro Facultatif. Limite le nombre de prédictions pour revenir aux valeurs les plus élevées pour chaque champ de pureté.

    Valeur maximale : 10

    Par défaut : renvoie toutes les informations de pureté pour chaque champ de pureté.

    options.topNFields Numéro Facultatif. Limite le nombre de champs de pureté renvoyés aux champs avec la pureté la plus élevée pour chaque grappe.

    Valeur maximale : 10

    Par défaut : renvoie tous les champs de la grappe.

    Tableau 14. Renvoie
    Type Description
    Chaîne Chaîne au format JSON contenant une liste de grappes avec des champs de pureté et des détails.
    Remarque :
    Les résultats varient en fonction des paramètres définis dans le paramètre d’entrée options .

    Les informations suivantes illustrent la façon dont les résultats de pureté des grappes sont triés et catégorisés. Reportez-vous à l’exemple pour connaître la sortie réelle.

    {
      "<clusterID>":[
        // List sorted by purity per field
        { "<fieldName>":[
          // List sorted by purity per field value
          {"<field_val1_1>":"<purity>"},
            // Additional field values
        ]},
        // Additional fields
      ],	  
      // Additional clusters
    }
    Chaîne.&lt;ID de grappe> Liste des grappes classées par ordre décroissant selon la valeur de pureté par grappe.

    Type de données : tableau

    String.&lt;clusterID>.&lt;field> Liste d’objets représentant des champs de pureté classés par ordre décroissant selon la valeur de pureté par champ. La options.top_n_fields propriété du paramètre d’objet d’entrée détermine le nombre de champs renvoyés.
    "<field>":[{"<field_val>":"<purity>"}]}

    Type de données : tableau

    Chaîne.&lt;ID de grappe>.&lt;field>.&lt;valeurs> Liste des objets contenant la valeur et la pureté du champ. Par exemple, {&quot;priority » :[{&quot;5 » :&quot;100&quot;}]} est un champ prioritaire avec un score de 5 et une valeur de pureté de 100 pour cent. Liste des résultats par ordre décroissant selon le pourcentage de pureté. La options.top_n propriété du paramètre d’objet d’entrée détermine le nombre de résultats renvoyés.

    Type de données : tableau

    L’exemple suivant montre comment obtenir les deux meilleurs résultats de pureté pour le champ catégorie dans des solutions de grappe spécifiques.

    var solution = new GlideRecord('ml_solution');
    solution.addQuery('sys_id', '<clustering_solution_sys_id>');
    solution.addQuery('active', 'true');
    solution.query();
    
    while (solution.next()) {
    
      var options = {};
      options.clusterIds = ['1', '3', '5'];
      options.purityFields = ['category'];
      options.topN = '2';
      options.topNFields = '2';
    
      var clustering = new sn_ml.ClusteringSolutionVersion(solution);
      var results = clustering.getTopNPurityInfo(options);
    
      gs.info(results);
    }

    La sortie affiche des aperçus de pureté en fonction des paramètres fournis dans le paramètre options.

    {"1":[{"category":[{"network":"99.96"},{"inquiry":"0.04"}]}],"3":[{"category":[{"Systems Engineering":"100"}]}],
    "5":[{"category":[{"Security":"100"}]}]}

    ClusteringSolutionVersion : getUpdateStatus()

    Obtient l’état de la tâche de mise à jour de la solution de mise en grappe la plus récente.

    Tableau 15. Paramètres
    Nom Type Description
    Aucun
    Tableau 16. Renvoie
    Type Description
    Chaîne État de la mise à jour de la solution de mise en grappe.
    États:
    • Erreur de configuration ou de réseau
    • Erreur lors de la mise à jour de la solution
    • Extraction des fichiers pour la mise à jour
    • Préparation des données
    • Non autorisé
    • Mise à jour terminée
    • La mise à jour est annulée
    • Demande de mise à jour reçue
    • Demande de mise à jour expirée
    • Mise à jour de la solution
    • Chargement
    • En attente

    L’exemple suivant montre comment obtenir l’état de mise à jour d’une solution de mise en grappe.

    var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");
    
    gs.print(JSON.stringify(myCluster.getActiveVersion().getUpdateStatus()));

    Sortie :

    "Update Complete"

    ClusteringSolutionVersion : getVersionNumber()

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

    Tableau 17. Paramètres
    Nom Type Description
    Aucun
    Tableau 18. 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.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');
    
    gs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));

    Sortie :

    Version number: 1

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

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

    Tableau 19. 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 20. Renvoie
    Type Description
    Objet Objet JSON contenant les résultats de prédiction triés par sys_id ou record_number.
    {
        <identifier>: [Array]
    }
    <Object>.&lt;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>.&lt;identifier>.<object>. Confiance Valeur de confiance associée à la prédiction. Par exemple, 53,84.

    Type de données : nombre

    <Object>.&lt;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>.&lt;identifier>.<object>. valeur prédictive Valeur représentant le résultat de prédiction.

    Type de données : chaîne

    <Object>.&lt;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.ClusteringSolutionStore.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));
    {
      "<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.ClusteringSolutionStore.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));
    {
      "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": ""
        }
      ]
    }

    ClusteringSolutionVersion : submitUpdateJob (options de l’objet)

    Soumet des tâches de mise à jour de mise en grappe avec des options permettant de restreindre les résultats à une table spécifique et de filtrer les enregistrements correspondants.

    Tableau 21. Paramètres
    Nom Type Description
    options Objet Objet JavaScript contenant des options sur lesquelles baser la mise à jour d’une solution de mise en grappe.
    {
            "filter" : "String",
            "table" : "String"
        }
    options.filtre Chaîne Chaîne de requête codée au format Glide standard. Reportez-vous à la section Chaînes de requêtes codées. Permet d’exécuter une tâche de mise à jour en fonction du filtre fourni.
    table.options Chaîne Nom de la table sur laquelle exécuter une tâche de mise à jour.
    Tableau 22. Renvoie
    Type Description
    Néant

    L’exemple suivant montre comment soumettre une tâche de mise à jour.

    var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");
    
    var options = {"filter" : "precision", "table" : "incident"};
    
    myCluster.getActiveVersion().submitUpdateJob(options);