EncoderVersion : global

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 6 minutes de lecture

    • L’API EncoderVersion fournit un objet pouvant contenir des scripts 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 .

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

    Le système active la version la plus récente de la codeur à 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 effectuer des prédictions.

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

    EncoderVersion : getProperties()

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

    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 l’encodeur . Les résultats varient selon la configuration des propriétés d’objet.
    {
  "algorithmConfig" : {Object},
  "datasetsProperties": [Array],
  "domainName": "String",
  "isActive": "String",
  "label": "String",
  "name": "String",
  "predictedFieldName": "String",
  "processingLanguage": "String",
  "scope": "String",
  "stopwords": [Array],
  "trainingFrequency": "String",
  "versionNumber": "Number"
}
    <Object>.config algorithme Facultatif. Objet JavaScript contenant des propriétés de configuration d’algorithme. 
    'algorithmConfig' : {
  "algorithm": "String"
}

    Type de données : objet.
    <Object>.algorithmConfig.algorithme Nom de l’algorithme pour la formation de cet encodeur.
    Valeurs possibles :
    • paravec: Intégration de mot de vecteur de paragraphe.
    • tf-idf: texte basé sur la fréquence des termes – fréquence de document inversée (TF-IDF).

    Type de données : chaîne.
    <Object>.datasetsProperties

    Liste des propriétés DatasetDefinition() associées à l’encodeur.

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

    Type de données : tableau.
    <Object>.datasetsProperties.tableName Nom de la table de l’ensemble de données. Par exemple, « tableName » : « Incident ».

    Type de données : chaîne.
    <Object>.datasetsProperties.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>.datasetsProperties.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>.datasetsProperties.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>.datasetsProperties.fieldDetails.<object>. type Type de champ d’apprentissage machine.

    Type de données : chaîne.
    <Object>.datasetsProperties.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>.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>.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>.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>.versionNumber Numéro de version de Objet de l’encodeur.

    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 mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization');

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

    Sortie :

    *** Script: {
  "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"
}

    EncoderVersion : getSentenceVectors(entrée de tableau)

    Renvoie des vecteurs pour chaque phrase d’entrée.

    Tableau 3. Paramètres
    Nom Type Description
    entrée Tableau Tableau de chaînes sous forme de phrases à partir desquelles recevoir des vecteurs.
    Tableau 4. Renvoie
    Type Description
    Chaîne Tableau de vecteurs de phrases.

    L’exemple suivant montre comment retourner un vecteur pour une seule phrase.

    var myEncoderName = 'GloVe';

var myEncoder = sn_ml.EncoderStore.get(myEncoderName);

var input = ["I like to code."];

var vectors = myEncoder.getActiveVersion().getSentenceVectors(input);

gs.print(vectors);

    Sortie :

    *** Script: [-0.16243751347064972,0.30614474415779114,0.08489049971103668,
-0.48100000619888306,-0.170997753739357,0.08779674768447876,-0.07848624140024185,-0.15123701095581055,
-0.07843250036239624,-1.9505999088287354,0.3007825016975403,-0.07804800570011139,-0.04779449850320816,
0.04803549498319626,0.09848674386739731,0.2427891194820404,-0.41138750314712524,0.10880374908447266,
 … ,
0.21227750182151794,0.18478751182556152,-0.3113832473754883,-0.16560424864292145,0.09052124619483948]

    EncoderVersion : getSimilarWords(entrée de tableau, options d’objet)

    Renvoie des mots similaires à chaque mot entré dans l’ordre de classement décroissant de similarité.

    Tableau 5. Paramètres
    Nom Type Description
    entrée Tableau Tableau de mots pour lesquels trouver des mots similaires.
    options Objet Carte pour affiner les résultats. 
    { "topN":"String" }
    options.topN Chaîne Si elle est fournie, renvoie les meilleurs résultats jusqu’au nombre spécifié de mots. Par exemple, utilisez « 10 » pour renvoyer les 10 mots les plus similaires.
    Tableau 6. Renvoie
    Type Description
    Tableau Liste des éléments contenant des mots similaires pour le mot d’entrée à la position correspondante. Ces mots similaires sont représentés par un tableau de paires au format [mot, score de similarité].

    L’exemple suivant montre comment obtenir des mots similaires à l’aide de l’encodeur GloVe .

    var myEncoderName = 'GloVe';
var myEncoder = sn_ml.EncoderStore.get(myEncoderName);
var input =  ["apple"];
var options = {"topN":"5"};
gs.print(myEncoder.getActiveVersion().getSimilarWords(input, options));

    Sortie :

    *** Script: [[["iphone",0.5987],["macintosh",0.5836],["ipod",0.5761],["microsoft",0.5664],["ipad",0.5628]]]

    EncoderVersion : getStatus(booléen includeDetails)

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

    Tableau 7. 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 8. Renvoie
    Type Description
    Objet Objet JavaScript contenant des informations sur l’état de la formation pour un objet Encoder .
    {
  "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 mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization');

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

    Sortie :

    {
 "state":"solution_complete",
 "percentComplete":"100",
 "hasJobEnded":"true",
 "details":{"stepLabel":"Encoder 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 encoderName = 'ml_x_snc_global_global_encoder';
var mlEncoder = sn_ml.EncoderStore.get(encoderName);
var trainingStatus = mlEncoder.getLatestVersion().getStatus();

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

    Sortie :

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

    EncoderVersion : getVersionNumber()

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

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

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

    // Get version number
var mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization');

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

    Sortie :

    Version number: 1

    EncoderVersion : getWordVectors(entrée de tableau)

    Renvoie des vecteurs pour chaque mot entré.

    Tableau 11. Paramètres
    Nom Type Description
    entrée Tableau Liste de chaînes en tant que mots à partir desquels recevoir des vecteurs.
    Tableau 12. Renvoie
    Type Description
    Tableau Liste de vecteurs pour chaque mot fourni.

    L’exemple suivant montre comment obtenir un vecteur à partir du mot hello.

    var myEncoderName = 'GloVe';
var myEncoder = sn_ml.EncoderStore.get(myEncoderName);
var input =  ["hello"];

gs.print(myEncoder.getActiveVersion().getWordVectors(input));

    Sortie :

    *** Script: [[-0.337119996547699,-0.2169100046157837,-0.006636499892920256,
-0.41624999046325684,-1.2554999589920044,-0.0284659992903471,-0.7219499945640564,
-0.5288699865341187,0.0072085000574588776,0.3199700117111206,0.02942500077188015,
-0.013236000202596188,0.4351100027561188,0.2571600079536438,0.3899500072002411,
 … ,
0.3384299874305725,0.4055800139904022,0.18073000013828278,0.6424999833106995]]