--- sourceDocument: Référence de l’API Xanadu sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference Release : - xanadu ft:locale : - fr-FR ft:publication_title : - Référence de l’API Xanadu ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # EncoderVersion : global # EncoderVersion : global {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 minutes de lecture L'API EncoderVersion fournit 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 d'encodeur basées sur les objets [d'API Encoder](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#EncoderAPI "L’API Encoder fournit un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins. Cet objet convertit les données d’entrée en vecteurs de nombres, en fonction d’objectifs et de configurations spécifiques à l’encodeur. Les encodeurs peuvent être utilisés indépendamment pour exécuter des codages ou peuvent être configurés dans le cadre de solutions pour coder des colonnes de texte.") dans le [magasin Encoder](https://servicenow-prod.fluidtopics.net/vAgXwdElB7yPk~hNm6abLA#EncoderStoreAPI "L’API EncoderStore fournit des méthodes pour stocker et récupérer les encodeurs."). 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 faire des prédictions. Les méthodes de cette API sont accessibles à l'aide des méthodes Encoder suivantes : * [getActiveVersion()](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#Encoder-getActiveVersion "Obtient l’actif Objet EncoderVersion.") * [getAllVersions()](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#Encoder-getAllVersions "Obtient toutes les versions de un encodeur.") * [getLatestVersion()](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#Encoder-getLatestVersion "Obtient la dernière version de un encodeur.") * [getVersion()](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#Encoder-getVersion_S "Obtient un encodeur par numéro de version fourni.") {#EncoderVersionAPI__ul_ycl_fzf_tlb} ## EncoderVersion : getProperties() {#ariaid-title2} Obtient les propriétés de et le numéro de versionl'objet codeur. {#EncoderV-getProperties__table_d2m_zwz_4lb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 1. Paramètres] {#EncoderV-getProperties__table_d2m_zwz_4lb} {#EncoderV-getProperties__table_e2m_zwz_4lb__entry__2} | Type | Description | |-|-| | Objet | Contenu du jeu de données et détails de [l'encodeur](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#Encoder-Encoder_O "Crée un encodeur.") . Les résultats varient selon la configuration des propriétés de l'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" } | | \.algorithmConfig | Facultatif. Objet JavaScript contenant les propriétés de configuration de l'algorithme. 'algorithmConfig' : { "algorithm": "String" } Type de données : Objet. | | \.algorithmConfig.algorithm | Nom de l'algorithme pour l'entraînement de cet encodeur. Valeurs possibles : * paravec: Intégration de mots vectoriels de paragraphe. * tf-idf: texte basé sur la fréquence de terme : fréquence de document inverse (TF-IDF). {#EncoderV-getProperties__ul_encoder_alg_vals} Type de données : chaîne. | | \.datasetsProperties | Liste des propriétés [DatasetDefinition()](https://servicenow-prod.fluidtopics.net/K6CGLMjqgee64K7U4Dl0gA#DDef-DatasetDefinition_O "Crée une instance de la classe DatasetDefinition , vous permettant de définir un jeu de données par nom de table, champs et requête.") associées à l'encodeur. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Type de données : tableau. | | \.datasetsProperties.tableName | Nom de la table pour l'ensemble de données. Par exemple, `<< tableName >> : << Incident >>`. Type de données : chaîne. | | \.datasetsProperties.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. | | \.datasetsProperties.fieldNames.fieldDetails | Liste des objets JavaScript qui spécifient les propriétés du champ. [ { "name": "String", "type": "String" } ] Type de données : tableau. | | \.datasetsProperties.fieldNames.fieldDetails.\. nom | Nom du champ définissant le type d'informations auquel limiter cet ensemble de données. Type de données : chaîne. | | \.datasetsProperties.fieldDetails.\. type | Type de champ d'apprentissage machine. Type de données : chaîne. | | \.datasetsProperties.fieldDetails.encodedQuery | Chaîne de requête codée au format Glide standard. [Reportez-vous à la section Chaînes de requêtes codées](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). Type de données : chaîne. | | \.domainName | Nom du domaine associé à cet ensemble de données. Voir [Séparation de domaine et Intelligence prédictive](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US). Type de données : chaîne. | | \.isActive | Marqueur indiquant si cette version est active. Valeurs valides : * true : la version est active. * false : la version n'est pas active. {#EncoderV-getProperties__ul_i5m_lp1_dmb} Type de données : chaîne | | \.étiquette | Identifie la tâche de prédiction. { "label": "my first prediction" } Type de données : chaîne. | | \.nom | Nom affecté par le système. Type de données : chaîne. | | \.predictedFieldName | Identifie un champ à former pour des raisons de prévisibilité. Type de données : chaîne. | | \.processingLanguage | Traitement du langage au format de code de langue ISO 639-1 à deux lettres. Type de données : chaîne. | | \.portée | Périmètre de l'objet. Actuellement, la seule valeur valide est `global`. Type de données : chaîne | | \.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, reportez-vous à [la section Créer une liste de mots vides personnalisés](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US). Type de données : tableau. | | \.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 {#EncoderV-getProperties__ul_pmw_523_plb}Par défaut : run_once Type de données : chaîne. | | \.numérodedeversion | Numéro de version du Objet codeur. Type de données : chaîne. | [Tableau 2. Renvoie] {#EncoderV-getProperties__table_e2m_zwz_4lb} L'exemple suivant récupère les propriétés de la version d'objet active 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) {#ariaid-title3} Renvoie des vecteurs pour chaque phrase d'entrée. {#EncoderV-getSentenceVectors_A__table_rtq_hdb_rlb__entry__3} | Nom | Type | Description | |-|-|-| | entrée | Tableau | Tableau de chaînes de caractères en tant que phrases à partir desquelles recevoir des vecteurs. | [Tableau 3. Paramètres] {#EncoderV-getSentenceVectors_A__table_rtq_hdb_rlb} {#EncoderV-getSentenceVectors_A__table_stq_hdb_rlb__entry__2} | Type | Description | |-|-| | Chaîne | Tableau de vecteurs de phrases. | [Tableau 4. Renvoie] {#EncoderV-getSentenceVectors_A__table_stq_hdb_rlb} 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) {#ariaid-title4} Renvoie des mots similaires à chaque mot d'entrée dans l'ordre décroissant de similarité. {#EncoderV-getSimilarWords_A_O__table_mxj_kdb_rlb__entry__3} | Nom | Type | Description | |-|-|-| | entrée | Tableau | Tableau de mots pour lesquels rechercher des mots similaires. | | options | Objet | Carte pour affiner les résultats. { "topN":"String" } | | options.topN | Chaîne | Si fourni, 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 5. Paramètres] {#EncoderV-getSimilarWords_A_O__table_mxj_kdb_rlb} {#EncoderV-getSimilarWords_A_O__table_nxj_kdb_rlb__entry__2} | Type | Description | |-|-| | Tableau | Liste des éléments contenant les mots similaires pour le mot d'entrée dans la position correspondante. Ces mots similaires sont représentés par un tableau de paires au format `[mot, score de similarité].` | [Tableau 6. Renvoie] {#EncoderV-getSimilarWords_A_O__table_nxj_kdb_rlb} 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(Boolean includeDetails) {#ariaid-title5} Obtient l'état d'achèvement de la formation. {#EncoderV-getStatus_B__table_xfh_vbw_plb__entry__3} | 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. {#EncoderV-getStatus_B__ul_n33_ckw_plb} Valeur par défaut : false | [Tableau 7. Paramètres] {#EncoderV-getStatus_B__table_xfh_vbw_plb} {#EncoderV-getStatus_B__table_yfh_vbw_plb__entry__2} | Type | Description | |-|-| | Objet | Objet JavaScript contenant des informations sur l'état de la formation pour un objet [Encoder](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#EncoderAPI "L’API Encoder fournit un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins. Cet objet convertit les données d’entrée en vecteurs de nombres, en fonction d’objectifs et de configurations spécifiques à l’encodeur. Les encodeurs peuvent être utilisés indépendamment pour exécuter des codages ou peuvent être configurés dans le cadre de solutions pour coder des colonnes de texte.") . { "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {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 {#EncoderV-getStatus_B__ul_a5q_gh4_vlb} Type de données : chaîne | | \.hasJobEnded | Marqueur indiquant si la formation est terminée. Valeurs valides : * true : la formation est terminée. * false : la formation est incomplète. {#EncoderV-getStatus_B__ul_icy_zjx_rlb} Type de données : valeur booléenne sous forme de chaîne | | \.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 | | \.Détails | Objet contenant une liste de détails de formation supplémentaires. Type de données : objet | [Tableau 8. Renvoie] {#EncoderV-getStatus_B__table_yfh_vbw_plb} L'exemple suivant montre un résultat correct une formation 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 une fois la formation 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() {#ariaid-title6} Obtient le numéro de version de un objet de solution. {#EncoderV-getVersionNumber__table_jsz_sbw_plb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 9. Paramètres] {#EncoderV-getVersionNumber__table_jsz_sbw_plb} {#EncoderV-getVersionNumber__table_ksz_sbw_plb__entry__2} | Type | Description | |-|-| | Chaîne | Numéro de version. | [Tableau 10. Renvoie] {#EncoderV-getVersionNumber__table_ksz_sbw_plb} 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) {#ariaid-title7} Renvoie des vecteurs pour chaque mot d'entrée. {#EncoderV-getWordVectors_A__table_jtt_mdb_rlb__entry__3} | Nom | Type | Description | |-|-|-| | entrée | Tableau | Liste de chaînes en tant que mots à partir desquels recevoir des vecteurs. | [Tableau 11. Paramètres] {#EncoderV-getWordVectors_A__table_jtt_mdb_rlb} {#EncoderV-getWordVectors_A__table_ktt_mdb_rlb__entry__2} | Type | Description | |-|-| | Tableau | Liste de vecteurs pour chaque mot fourni. | [Tableau 12. Renvoie] {#EncoderV-getWordVectors_A__table_ktt_mdb_rlb} L'exemple suivant montre comment obtenir un vecteur à partir du mot bonjour. 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]]