--- 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 --- # SimilaritySolutionVersion : global # SimilaritySolutionVersion : global {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 8 minutes de lecture L'API SimilaritySolutionVersion est un objet pouvant contenir des scripts et 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 de solutions basées sur les objets [d'API SimilaritySolution](https://servicenow-prod.fluidtopics.net/lHSGafMhhE94h90WiGm9SA#SimilaritySolutionAPI "L’API SimilaritySolution est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") dans le [magasin SimilaritySolution](https://servicenow-prod.fluidtopics.net/rzC3_nGN~xYXt_2h6u45CA#SimilaritySolutionStoreAPI "Permet de stocker et de récupérer des solutions."). 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 au cours de la formation planifiée sur la solution. Les méthodes de cette API sont accessibles à l'aide des méthodes SimilaritySolution suivantes : * [getActiveVersion()](https://servicenow-prod.fluidtopics.net/lHSGafMhhE94h90WiGm9SA#SimilaritySol-getActiveVersion "Obtient l’actif Objet SimilaritySolutionVersion.") * [getAllVersions()](https://servicenow-prod.fluidtopics.net/lHSGafMhhE94h90WiGm9SA#SimilaritySol-getAllVersions "Obtient toutes les versions de un objet SimilaritySolution .") * [getLatestVersion()](https://servicenow-prod.fluidtopics.net/lHSGafMhhE94h90WiGm9SA#SimilaritySol-getLatestVersion "Obtient la dernière version de une solution.") * [getVersion()](https://servicenow-prod.fluidtopics.net/lHSGafMhhE94h90WiGm9SA#SimilaritySol-getVersion_S "Obtient une solution par numéro de version fourni.") {#SimilaritySolutionVersionAPI__ul_ycl_fzf_tlb} ## SimilaritySolutionVersion : getProperties() {#ariaid-title2} Obtient les propriétés de l'objet de solution et le numéro de version. {#SimilarityVersion-getProperties__table_d2m_zwz_4lb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 1. Paramètres] {#SimilarityVersion-getProperties__table_d2m_zwz_4lb} {#SimilarityVersion-getProperties__table_e2m_zwz_4lb__entry__2} | Type | Description | |-|-| | Objet | Contenu du jeu de données et détails de la [version de SimilaritySolution](https://servicenow-prod.fluidtopics.net/lHSGafMhhE94h90WiGm9SA#SimilaritySolutionAPI "L’API SimilaritySolution est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") . Les résultats varient selon la configuration des propriétés de l'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" } | | \.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. | | \.codeur | Objet encodeur affecté à cette solution. Reportez-vous à [Encodeur - Encodeur (configuration d'objet)](https://servicenow-prod.fluidtopics.net/IHQ3JXNgC2Yj8ezioJC7_A#Encoder-Encoder_O "Crée un encodeur."). Type de données : Objet. | | \.isActive | Marqueur indiquant si cette version est active. Valeurs valides : * true : la version est active. * false : la version n'est pas active. {#SimilarityVersion-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. | | \.lookupDatasetProperties | Détails de [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.") Objet utilisé comme jeu de recherche. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Type de données : Objet. | | \.lookupDatasetProperties.tableName | Nom de la table pour l'ensemble de données. Par exemple, `<< tableName >> : << Incident >>`. Type de données : chaîne. | | \.lookupDatasetProperties.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. | | \.lookupDatasetProperties.fieldNames.fieldDetails | Liste des objets JavaScript qui spécifient les propriétés du champ. [ { "name": "String", "type": "String" } ] Type de données : tableau. | | \.lookupDatasetProperties.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. | | \.lookupDatasetProperties.fieldDetails.\. type | Type de champ d'apprentissage machine. Type de données : chaîne. | | \.lookupDatasetProperties.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. | | \.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. | | \.testDatasetProperties | Détails de [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.") 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 lookupDatasetfichier . { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Type de données : Objet. | | \.testDatasetProperties.tableName | Nom de la table pour l'ensemble de données. Par exemple, `<< tableName >> : << Incident >>`. Type de données : chaîne. | | \.testDatasetProperties.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. | | \.testDatasetProperties.fieldNames.fieldDetails | Liste des objets JavaScript qui spécifient les propriétés du champ. [ { "name": "String", "type": "String" } ] Type de données : tableau. | | \.testDatasetProperties.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. | | \.testDatasetProperties.fieldDetails.\. type | Type de champ d'apprentissage machine. Type de données : chaîne. | | \.testDatasetProperties.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. | | \.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 {#SimilarityVersion-getProperties__ul_pmw_523_plb}Par défaut : run_once Type de données : chaîne. | | \.updateFrequency (en anglais seulement) | 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 {#SimilarityVersion-getProperties__ul_kjm_2jh_3mb}Par défaut : do_not_update Type de données : chaîne | | \.numérodedeversion | Numéro de version du Objet SimilaritySolution. Type de données : chaîne. | [Tableau 2. Renvoie] {#SimilarityVersion-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 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(Boolean includeDetails) {#ariaid-title3} Obtient l'état d'achèvement de la formation. {#SimilarityVersion-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. {#SimilarityVersion-getStatus_B__ul_n33_ckw_plb} Valeur par défaut : false | [Tableau 3. Paramètres] {#SimilarityVersion-getStatus_B__table_xfh_vbw_plb} {#SimilarityVersion-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 [SimilaritySolution](https://servicenow-prod.fluidtopics.net/lHSGafMhhE94h90WiGm9SA#SimilaritySolutionAPI "L’API SimilaritySolution est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") . { "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 {#SimilarityVersion-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. {#SimilarityVersion-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 4. Renvoie] {#SimilarityVersion-getStatus_B__table_yfh_vbw_plb} L'exemple suivant montre un résultat correct une formation 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 une fois la formation 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() {#ariaid-title4} Obtient le numéro de version de un objet de solution. {#SimilarityVersion-getVersionNumber__table_jsz_sbw_plb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 5. Paramètres] {#SimilarityVersion-getVersionNumber__table_jsz_sbw_plb} {#SimilarityVersion-getVersionNumber__table_ksz_sbw_plb__entry__2} | Type | Description | |-|-| | Chaîne | Numéro de version. | [Tableau 6. Renvoie] {#SimilarityVersion-getVersionNumber__table_ksz_sbw_plb} 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 : prédire (entrée d'objet, options d'objet) {#ariaid-title5} Obtient les données d'entrée pour une prédiction. {#SimilarityVersion-predict_O_O__table_wwz_pbw_plb__entry__3} | Nom | Type | Description | |-|-|-| | entrée | Objet | [GlideRecord (en anglais seulement)](https://servicenow-prod.fluidtopics.net/cg986w0IhAlYk2dRuHcT4Q#c_GlideRecordAPI "L’API GlideRecord est utilisée pour les opérations de base de données.") 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. * faux : renvoie tous les résultats. {#SimilarityVersion-predict_O_O__ul_f4d_xyx_slb} Valeur par défaut : vrai | | options.top_n | Numéro | Si elle est fournie, renvoie les meilleurs résultats, jusqu'au nombre spécifié de prédictions. | [Tableau 7. Paramètres] {#SimilarityVersion-predict_O_O__table_wwz_pbw_plb} {#SimilarityVersion-predict_O_O__table_xwz_pbw_plb__entry__2} | Type | Description | |-|-| | Objet | Objet JSON contenant les résultats de prédiction triés par sys_id ou par record_number. { : [Array] } | | \.\ | Liste d'objets avec les détails de chaque résultat de prédiction. Type de données : tableau d'objets : [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ] | | \.\.\. confiance | Valeur de confiance associée à la prédiction. Par exemple, 53.84. Type de données : nombre | | \.\.\. predictedSysId | 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 | | \.\.\. valeur prédictée | Valeur représentant le résultat de prédiction. Type de données : chaîne | | \.\.\. seuil | Valeur du seuil configuré associé à la prédiction. Type de données : nombre | [Tableau 8. Renvoie] {#SimilarityVersion-predict_O_O__table_xwz_pbw_plb} L'exemple suivant montre comment afficher les résultats de prédiction pour une méthode predict() qui prend 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.SimilaritySolutionStore.get('ml_incident_categorization'); // single GlideRecord input var input = new GlideRecord("incident"); input.get(""); // 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)); { "": [ { "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.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": "" } ] }