SimilaritySolutionVersion : Global

Référence de l’API Zurich

Release

zurich

ft:locale

fr-FR

ft:publication_title

Référence de l’API Zurich

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

SimilaritySolutionVersion : Global

Rversion finale: Zurich

Mis à jour 31 juil. 2025

8 minutes de lecture

L’API SimilaritySolutionVersion est un objet pouvant contenir des scripts utilisé dans Intelligence prédictive les 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 .

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

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 lors d’une formation planifiée sur la solution.

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

SimilaritySolutionVersion : getProperties()

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

Tableau 1. Paramètres
Nom	Type	Description
Aucun

Tableau 2. Renvoie
Type	Description
Objet	Contenu de l’ensemble de données et détails de la version de la solution de similarité . Les résultats varient selon la configuration des propriétés d’objet. `{ "domainName": "String", "encoder": {Object}, "isActive": "String", "label": "String", "lookupDatasetProperties": {Object}, "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "testDatasetProperties": {Object}, "trainingFrequency": "String", "updateFrequency": "String", "versionNumber": "String" }`
<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>.codeur	Objet d’encodeur affecté à cette solution. Reportez-vous à Encodeur : encodeur (configuration objet). Type de données : objet.
<Object>.isActive	Marqueur indiquant si cette version est active. Valeurs valides : vrai : 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>.lookupDatasetProperties	Détails de DatasetDefinition() Objet utilisé comme ensemble de recherche. `{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }` Type de données : objet.
<Object>.lookupDatasetProperties.tableName	Nom de la table de l’ensemble de données. Par exemple, `« tableName » : « Incident ».` Type de données : chaîne.
<Object>.lookupDatasetProperties.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>.lookupDatasetProperties.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>.lookupDatasetProperties.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>.lookupDatasetProperties.fieldDetails.<object>. type	Type de champ d’apprentissage machine. Type de données : chaîne.
<Object>.lookupDatasetProperties.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	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 `global`. 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 paramètre de language propriété. Pour en savoir plus, consultez Créer une liste de mots vides personnalisée. Type de données : tableau.
<Object>.testDatasetProperties	Détails de DatasetDefinition() Objet utilisé pour récupérer les similitudes entre les résultats recherchés dans ce modèle et les résultats trouvés dans le lookupDataset. `{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }` Type de données : objet.
<Object>.testDatasetProperties.tableName	Nom de la table de l’ensemble de données. Par exemple, `« tableName » : « Incident ».` Type de données : chaîne.
<Object>.testDatasetProperties.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>.testDatasetProperties.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>.testDatasetProperties.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>.testDatasetProperties.fieldDetails.<object>. type	Type de champ d’apprentissage machine. Type de données : chaîne.
<Object>.testDatasetProperties.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>.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>.updateFrequency	Fréquence à laquelle le modèle de la définition de la 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 Par défaut : do_not_update Type de données : chaîne
<Object>.versionNumber	Numéro de version de Objet SimilaritySolution. 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.SimilaritySolutionStore.get('ml_incident_categorization');

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

Sortie :

*** Script: {
  "domainName": "global",
  "encoderProperties": {
    "datasetsProperties": [],
    "name": "wordCorpusA"
  },
  "isActive": "true",
  "label": "similarity",
  "lookupDatasetProperties": {
    "encodedQuery": "",
    "fieldNames": [
      "short_description"
    ],
    "tableName": "incident"
  },
  "name": "ml_x_snc_global_global_similarity",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "testDatasetProperties": {
    "fieldNames": [
      "short_description"
    ],
    "tableName": "incident"
  },
  "versionNumber": "3"
}

SimilaritySolutionVersion : getStatus(booléen includeDetails)

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

Tableau 3. Paramètres
Nom	Type	Description
includeDetails	Booléen	Marqueur indiquant s’il faut renvoyer l’état details. Valeurs valides : vrai : renvoyer des détails supplémentaires. faux : ne renvoie pas de détails supplémentaires. Valeur par défaut : false

Tableau 4. Renvoie
Type	Description
Objet	Objet JavaScript contenant des informations sur l’état de la formation pour un objet SimilaritySolution . `{ "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 terminal, la hasJobEnded propriété est définie sur `vrai`. 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 : vrai : la formation est terminée. faux : la formation est incomplète. Type de données : valeur booléenne sous forme de chaîne
<Object>.pourcentterminé	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 Plage : 0 à 100
<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 de réussite lorsque la formation est terminée.

// Get status
var mlSolution = sn_ml.SimilaritySolutionStore.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 résultat d’échec lorsque la formation est terminée.

// Get status
var solutionName = 'ml_x_snc_global_global_similarity_solution';
var mlSolution = sn_ml.SimilaritySolutionStore.get(solutionName);
var trainingStatus = JSON.parse(mlSolution.getLatestVersion().getStatus());

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

Sortie :

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

SimilaritySolutionVersion : getVersionNumber()

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

Tableau 5. Paramètres
Nom	Type	Description
Aucun

Tableau 6. 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.SimilaritySolutionStore.get('ml_incident_categorization');

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

Sortie :

Version number: 1

SimilaritySolutionVersion : predict(entrée d’objet, options d’objet)

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

Tableau 7. Paramètres
Nom	Type	Description
entrée	Objet	GlideRecord ou tableau d’objets JSON contenant des noms de champs et des valeurs sous forme de paires clé-valeur.
options	Objet	Valeurs facultatives pour le filtrage des 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 : vrai : renvoie des résultats dans lesquels la confiance est supérieure au seuil. faux : renvoie tous les résultats. Valeur par défaut : vrai
options.top_n	Numéro	Si elle est fournie, elle renvoie les meilleurs résultats, jusqu’au nombre spécifié de prédictions.

Tableau 8. Renvoie
Type	Description
Objet	Objet JSON contenant les résultats de prédiction triés par sys_id ou par record_number. `{ <identifier>: [Array] }`
<Object>.<identificateur>	Liste d’objets avec des détails pour chaque résultat de prédiction. Type de données : tableau d’objets `<identifier>: [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ]`
<Object>.<identificateur>..<object> confiance	Valeur de la fiabilité associée à la prédiction. Par exemple, 53,84. Type de données : nombre
<Object>.<identificateur>..<object> 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
<Object>.<identificateur>..<object> Valeur predictedValue	Valeur représentant le résultat de la prédiction. Type de données : chaîne
<Object>.<identificateur>..<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 comme entrée et inclut des paramètres facultatifs pour restreindre aux trois premiers résultats et exclure la valeur de seuil.

var mlSolution = sn_ml.SimilaritySolutionStore.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/now_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 sous forme de paires clé-valeur pour l’entrée et inclut des paramètres facultatifs pour restreindre aux trois premiers résultats et exclure la valeur de seuil.

var mlSolution = sn_ml.SimilaritySolutionStore.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": ""
    }
  ]
}