--- 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 --- # PredictabilityEstimate : global # PredictabilityEstimate : global {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 minutes de lecture L'API PredictabilityEstimate est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins. Cet objet fournit une estimation du degré de prévisibilité des champs d'un jeu de données et des fonctionnalités qui peuvent être utiles pour prédire ces champs. 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` . Le flux d'estimation de la prévisibilité de la configuration à la formation est le suivant : 1. Créez un jeu de données à l'aide de l'API [DatasetDefinition](https://servicenow-prod.fluidtopics.net/K6CGLMjqgee64K7U4Dl0gA#DatasetDefinitionAPI "L’API DatasetDefinition fournit des méthodes pour identifier un ensemble d’enregistrements comprenant un nom de table, des colonnes et des critères de sélection de ligne à utiliser comme entrée pour les algorithmes d’apprentissage ML. Les ensembles de données ne contiennent pas les données réelles.") . 2. Utilisez le [constructeur](https://servicenow-prod.fluidtopics.net/T60ZgSaw8wK2AIEjaALn9Q#PrdctbltE-PredictabilityEstimate_O "Crée une estimation de la prévisibilité.") pour créer un objet d'estimation de la prédictibilité. 3. Ajoutez l'objet d'estimation de la prévisibilité au magasin d'estimation de la prévisibilité à l'aide de la méthode [PredictabilityEstimateStore - add().](https://servicenow-prod.fluidtopics.net/AsuxK1XrauIaNuSM3~jSEg#PredictbltyEstStore-add_O "Ajoute une nouvelle estimation de la prévisibilité objet de solution au magasin et renvoie un nom unique.") 4. Formez l'estimation de la prévisibilité à l'aide de la méthode [submitTrainingJob().](https://servicenow-prod.fluidtopics.net/T60ZgSaw8wK2AIEjaALn9Q#PrdctbltE-submitTrainingJob "Soumet une tâche de formation.") Cela crée une version de l'objet que vous pouvez gérer à l'aide de l'API [PredictabilityEstimateVersion](https://servicenow-prod.fluidtopics.net/0uz12AjquUzhtgMg434jvQ#PredictabilityEstimateVersionAPI "L’API PredictabilityEstimateVersion est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") . 5. Obtenir les valeurs prédictives estimées à l'aide de la méthode [PredictabilityEstimateVersion -- getResults().](https://servicenow-prod.fluidtopics.net/0uz12AjquUzhtgMg434jvQ#PredictbltyEstV-getResults "Renvoie les résultats JSON contenant les champs d’entrée suggérés pour un champ de sortie.") {#PredictabilityEstimateAPI__ol_mmm_n1c_dmb} Remarque : Cette API s'exécute avec tous les privilèges. Pour restreindre l'accès des utilisateurs, incluez un mécanisme de contrôle d'accès dans le script. Pour obtenir des instructions d'utilisation, consultez [Utilisation des API ML](https://www.servicenow.com/docs/access?context=using-ml-apis&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US). ## PredictabilityEstimate : PredictabilityEstimate(configuration d'objet) {#ariaid-title2} Crée une estimation de la prévisibilité. Pour obtenir de nouvelles estimations de prédictibilité sur le même jeu de données, utilisez ce constructeur pour créer un objet PredictabilityEstimate avec un nom unique. {#PrdctbltE-PredictabilityEstimate_O__table_gm2_yt5_flb__entry__3}{#PrdctbltE-PredictabilityEstimate_O__solution-obj-domainN-default} | Nom | Type | Description | |-|-|-| | configuration | Objet | Objet JavaScript contenant les propriétés de configuration de la Estimation de la prévisibilité. { "dataset": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "minRowCount": "String", "predictedFieldName": "String", "trainingFrequency": "String" } | | config.dataset | Objet | [Nom de DatasetDefinition](https://servicenow-prod.fluidtopics.net/K6CGLMjqgee64K7U4Dl0gA#DatasetDefinitionAPI "L’API DatasetDefinition fournit des méthodes pour identifier un ensemble d’enregistrements comprenant un nom de table, des colonnes et des critères de sélection de ligne à utiliser comme entrée pour les algorithmes d’apprentissage ML. Les ensembles de données ne contiennent pas les données réelles.") . | | config.domainName | Chaîne | Facultatif. 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). Par défaut : domaine actuel, par exemple, `<< global` \>\>. | | config.inputFieldNames | Tableau | Liste des champs d'entrée candidats en tant que chaînes à prendre en compte pour l'estimation. | | config.label | Chaîne | Identifie la tâche de prédiction. | | config.minRowCount | Chaîne | Facultatif. Nombre minimum d'enregistrements requis dans l'ensemble de données pour la formation. Par défaut : 10 000 | | config.predictedFieldName | Chaîne | Identifie un champ à former pour des raisons de prévisibilité. | | config.trainingFrequency | Chaîne | Facultatif. 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 {#PrdctbltE-PredictabilityEstimate_O__ul_pmw_523_plb}Par défaut : run_once | [Tableau 1. Paramètres] {#PrdctbltE-PredictabilityEstimate_O__table_gm2_yt5_flb} L'exemple suivant montre comment créer une tâche d'estimation et l'ajouter au magasin PredictabilityEstimation. var myIncidentData = new sn_ml.DatasetDefinition({ 'tableName' : 'incident', 'encodedQuery' : 'activeANYTHING' }); var myEstimate = new sn_ml.PredictabilityEstimate({ 'label': "predictability estimate", 'dataset' : myIncidentData, 'inputFieldNames':['short_description'], 'predictedFieldName': 'category' }); var myEstimateName = sn_ml.PredictabilityEstimateStore.add(myEstimate); ## PredictabilityEstimate : cancelTrainingJob() {#ariaid-title3} Annule une tâche pour Un objet d'estimation de la prévisibilité qui a été soumis pour une formation. {#PrdctbltE-cancelTrainingJob__table_bpb_k3z_llb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 2. Paramètres] {#PrdctbltE-cancelTrainingJob__table_bpb_k3z_llb} {#PrdctbltE-cancelTrainingJob__table_cpb_k3z_llb__entry__2} | Type | Description | |-|-| | Aucun | | [Tableau 3. Renvoie] {#PrdctbltE-cancelTrainingJob__table_cpb_k3z_llb} L'exemple suivant montre comment annuler une tâche de formation existante. var myEstimate = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate'); myEstimate.cancelTrainingJob(); ## PredictabilityEstimate : getActiveVersion() {#ariaid-title4} Obtient l'actif Objet PredictabilityEstimateVersion. {#PrdctbltE-getActiveVersion__table_tvl_m3z_llb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 4. Paramètres] {#PrdctbltE-getActiveVersion__table_tvl_m3z_llb} {#PrdctbltE-getActiveVersion__table_uvl_m3z_llb__entry__2} | Type | Description | |-|-| | Objet | [Objet PredictabilityEstimateVersion](https://servicenow-prod.fluidtopics.net/0uz12AjquUzhtgMg434jvQ#PredictabilityEstimateVersionAPI "L’API PredictabilityEstimateVersion est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") actif. | [Tableau 5. Renvoie] {#PrdctbltE-getActiveVersion__table_uvl_m3z_llb} L'exemple suivant montre comment obtenir une version active Estimation de la prévisibilité à partir du magasin et renvoyer son état de formation. var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate'); gs.print(JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getStatus()), null, 2)); Sortie : { "state": "predictability_estimate_complete", "percentComplete": "100", "hasJobEnded": "true" } ## PredictabilityEstimate : getAllVersions() {#ariaid-title5} Obtient toutes les versions de une estimation de la prévisibilité. {#PrdctbltE-getAllVersions__table_tvl_m3z_llb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 6. Paramètres] {#PrdctbltE-getAllVersions__table_tvl_m3z_llb} {#PrdctbltE-getAllVersions__table_uvl_m3z_llb__entry__2} | Type | Description | |-|-| | Tableau | Versions existantes d'un objet de solution. Voir également [PredictabilityEstimateVersion (en anglais seulement)](https://servicenow-prod.fluidtopics.net/0uz12AjquUzhtgMg434jvQ#PredictabilityEstimateVersionAPI "L’API PredictabilityEstimateVersion est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") API. | [Tableau 7. Renvoie] {#PrdctbltE-getAllVersions__table_uvl_m3z_llb} L'exemple suivant montre comment obtenir tous les objets de version PredictabilityEstimate et appeler les méthodes de version d'estimation getVersionNumber() et getStatus() sur ceux-ci. var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate'); var mlEstimateVersions = mlEstimate.getAllVersions(); for (i = 0; i < mlEstimateVersions.length; i++) { gs.print("Version " + mlEstimateVersions[i].getVersionNumber() + " Status: " + mlEstimateVersions[i].getStatus() +"\n"); }; Sortie : Version 3 Status: {"state":"predictability_estimate_complete","percentComplete":"100","hasJobEnded":"true"} Version 2 Status: {"state":"predictability_estimate_complete","percentComplete":"100","hasJobEnded":"true"} Version 1 Status: {"state":"predictability_estimate_cancelled","percentComplete":"0","hasJobEnded":"true"} ## PredictabilityEstimate : getLatestVersion() {#ariaid-title6} Obtient la dernière version de une estimation de la prévisibilité. {#PrdctbltE-getLatestVersion__table_tvl_m3z_llb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 8. Paramètres] {#PrdctbltE-getLatestVersion__table_tvl_m3z_llb} {#PrdctbltE-getLatestVersion__table_uvl_m3z_llb__entry__2} | Type | Description | |-|-| | Objet | [PredictabilityEstimateVersion](https://servicenow-prod.fluidtopics.net/0uz12AjquUzhtgMg434jvQ#PredictabilityEstimateVersionAPI "L’API PredictabilityEstimateVersion est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") Objet correspondant à la dernière version de a [PredictabilityEstimate().](https://servicenow-prod.fluidtopics.net/T60ZgSaw8wK2AIEjaALn9Q#PrdctbltE-PredictabilityEstimate_O "Crée une estimation de la prévisibilité.") | [Tableau 9. Renvoie] {#PrdctbltE-getLatestVersion__table_uvl_m3z_llb} L'exemple suivant montre comment obtenir la dernière version d'une une estimation de la prévisibilité et renvoyer son état de formation. var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate'); gs.print(JSON.stringify(JSON.parse(mlEstimate.getLatestVersion().getStatus()), null, 2)); Sortie : { "state": "predictability_estimate_complete", "percentComplete": "100", "hasJobEnded": "true" } ## PredictabilityEstimate : getName() {#ariaid-title7} Obtient le nom de l'objet à utiliser pour l'interaction avec le magasin. {#PrdctbltE-getName__table_pps_43z_llb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 10. Paramètres] {#PrdctbltE-getName__table_pps_43z_llb} {#PrdctbltE-getName__table_qps_43z_llb__entry__2} | Type | Description | |-|-| | Chaîne | Nom de l'objet d'estimation. | [Tableau 11. Renvoie] {#PrdctbltE-getName__table_qps_43z_llb} L'exemple suivant montre comment mettre à jour Estimation de la prévisibilité les informations du jeu de données et imprimer le nom de l'objet. // Update estimate var myIncidentData = new sn_ml.DatasetDefinition({ 'tableName' : 'incident', 'fieldNames' : ['category', 'short_description', 'priority'], 'encodedQuery' : 'activeANYTHING' }); var myEstimate = new sn_ml.PredictabilityEstimate({ 'label': "my estimate", 'dataset' : myIncidentData, 'inputFieldNames':['short_description'], 'predictedFieldName': 'category' }); // update estimate sn_ml.PredictabilityEstimateStore.update('ml_x_snc_global_global_my_definition_4', myEstimate); // print estimate name gs.print('Estimate Name: '+myEstimate.getName()); Sortie : Estimate Name: ml_x_snc_global_global_my_definition_4 ## PredictabilityEstimate : getProperties() {#ariaid-title8} Obtient les propriétés de l'objet d'estimation de la prédictibilité. {#PrdctbltE-getProperties__table_pps_43z_llb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 12. Paramètres] {#PrdctbltE-getProperties__table_pps_43z_llb} {#PrdctbltE-getProperties__table_qps_43z_llb__entry__2} | Type | Description | |-|-| | Objet | Contenu des détails du jeu de données et de l'objet [PredictabilityEstimate()](https://servicenow-prod.fluidtopics.net/T60ZgSaw8wK2AIEjaALn9Q#PrdctbltE-PredictabilityEstimate_O "Crée une estimation de la prévisibilité.") dans [PredictabilityEstimateStore](https://servicenow-prod.fluidtopics.net/AsuxK1XrauIaNuSM3~jSEg#PredictabilityEstimateStoreAPI "Permet de stocker et de récupérer des estimations de la prévisibilité."). { "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String" } | | \.datasetProperties (en anglais seulement) | Répertorie les propriétés de l'objet [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é à l'estimation. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } | | \.datasetProperties.tableName | Nom de la table pour l'ensemble de données. Par exemple, `<< tableName >> : << Incident >>`. Type de données : chaîne. | | \.datasetProperties.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. | | \.datasetProperties.fieldNames.fieldDetails | Liste des objets JavaScript qui spécifient les propriétés du champ. [ { "name": "String", "type": "String" } ] Type de données : tableau. | | \.datasetProperties.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. | | \.datasetProperties.fieldDetails.\. type | Type de champ d'apprentissage machine. Type de données : chaîne. | | \.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](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. | | \.inputFieldNames | Liste des champs d'entrée candidats en tant que chaînes à prendre en compte pour l'estimation. 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. | | \.portée | Périmètre de l'objet. Actuellement, la seule valeur valide est `global`. 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 {#PrdctbltE-getProperties__ul_pmw_523_plb}Par défaut : run_once Type de données : chaîne. | [Tableau 13. Renvoie] {#PrdctbltE-getProperties__table_qps_43z_llb} L'exemple suivant obtient les propriétés d'un objet solution Un objet d'estimation de la prévisibilité dans le magasin. var mySolution = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate'); gs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2)); Sortie : *** Script: { "datasetProperties": { "tableName": "incident", "fieldNames": [ "category", "short_description", "priority", "assignment_group.name" ], "fieldDetails": [ { "name": "category", "type": "nominal" }, { "name": "short_description", "type": "text" } ] }, "domainName": "global", "inputFieldNames": [ "short_description" ], "label": "my estimate definition", "name": "ml_x_snc_global_global_my_definition_26", "predictedFieldName": "category", "processingLanguage": "en", "scope": "global", "stopwords": [ "Default English Stopwords" ], "trainingFrequency": "run_once" } ## PredictabilityEstimate : getVersion(version de chaîne) {#ariaid-title9} Obtient une estimation de la prévisibilité par numéro de version fourni. {#PrdctbltE-getVersion_S__table_pps_43z_llb__entry__3} | Nom | Type | Description | |-|-|-| | version | Chaîne | Numéro de version existante d'une une estimation de la prévisibilité. | [Tableau 14. Paramètres] {#PrdctbltE-getVersion_S__table_pps_43z_llb} {#PrdctbltE-getVersion_S__table_qps_43z_llb__entry__2} | Type | Description | |-|-| | Objet | Version spécifiée de l'objet [PredictabilityEstimate()](https://servicenow-prod.fluidtopics.net/T60ZgSaw8wK2AIEjaALn9Q#PrdctbltE-PredictabilityEstimate_O "Crée une estimation de la prévisibilité.") sur lequel vous pouvez appeler les méthodes [d'API PredictabilityEstimateVersion](https://servicenow-prod.fluidtopics.net/0uz12AjquUzhtgMg434jvQ#PredictabilityEstimateVersionAPI "L’API PredictabilityEstimateVersion est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") . | [Tableau 15. Renvoie] {#PrdctbltE-getVersion_S__table_qps_43z_llb} L'exemple suivant montre comment obtenir l'état de formation d'une Estimation de la prévisibilité par numéro de version. var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate'); gs.print(JSON.stringify(JSON.parse(mlEstimate.getVersion('1').getStatus()), null, 2)); Sortie : { "state": "predictability_estimate_complete", "percentComplete": "100", "hasJobEnded": "true" } ## PredictabilityEstimate : setActiveVersion(version de chaîne) {#ariaid-title10} Active une version spécifiée d'une estimation de la prévisibilité dans le magasin. {#PrdctbltE-setActiveVersion_S__table_pps_43z_llb__entry__3} | Nom | Type | Description | |-|-|-| | version | Chaîne | Nom de la version de l'objet [PredictabilityEstimate()](https://servicenow-prod.fluidtopics.net/T60ZgSaw8wK2AIEjaALn9Q#PrdctbltE-PredictabilityEstimate_O "Crée une estimation de la prévisibilité.") à activer. L'activation de cette version désactive toutes les autres versions. | [Tableau 16. Paramètres] {#PrdctbltE-setActiveVersion_S__table_pps_43z_llb} {#PrdctbltE-setActiveVersion_S__table_qps_43z_llb__entry__2} | Type | Description | |-|-| | Aucun | | [Tableau 17. Renvoie] {#PrdctbltE-setActiveVersion_S__table_qps_43z_llb} L'exemple suivant montre comment activer une estimation de la prévisibilité version de solution dans le Store. sn_ml.PredictabilityEstimate.setActiveVersion("ml_x_snc_global_global_my_estimate_definition"); ## PredictabilityEstimate : submitTrainingJob() {#ariaid-title11} Soumet une tâche de formation. Remarque : Avant d'exécuter cette méthode, vous devez d'abord ajouter une estimation de prédictibilité au magasin à l'aide de la méthode [PredictabilityEstimateStore - add().](https://servicenow-prod.fluidtopics.net/AsuxK1XrauIaNuSM3~jSEg#PredictbltyEstStore-add_O "Ajoute une nouvelle estimation de la prévisibilité objet de solution au magasin et renvoie un nom unique.") {#PrdctbltE-submitTrainingJob__table_xmd_33z_llb__entry__3} | Nom | Type | Description | |-|-|-| | Aucun | | | [Tableau 18. Paramètres] {#PrdctbltE-submitTrainingJob__table_xmd_33z_llb} {#PrdctbltE-submitTrainingJob__table_ymd_33z_llb__entry__2} | Type | Description | |-|-| | Objet | [PredictabilityEstimateVersion](https://servicenow-prod.fluidtopics.net/0uz12AjquUzhtgMg434jvQ#PredictabilityEstimateVersionAPI "L’API PredictabilityEstimateVersion est un objet pouvant contenir des scripts et pouvant être utilisé dans les Intelligence prédictive magasins.") Objet correspondant à l'objet d'entraînement [PredictabilityEstimate](https://servicenow-prod.fluidtopics.net/T60ZgSaw8wK2AIEjaALn9Q#PrdctbltE-PredictabilityEstimate_O "Crée une estimation de la prévisibilité.") . | [Tableau 19. Renvoie] {#PrdctbltE-submitTrainingJob__table_ymd_33z_llb} L'exemple suivant montre comment créer un jeu de données, l'appliquer à une estimation de la prévisibilité, ajoutez-la à un magasin et soumettre la tâche de formation. // Create a dataset var myData = new sn_ml.DatasetDefinition({ 'tableName' : 'incident', 'fieldNames' : ['assignment_group', 'short_description', 'description'], 'encodedQuery' : 'activeANYTHING' }); // Create an estimate var myEstimate = new sn_ml.PredictabilityEstimate({ 'label': "my estimate definition", 'dataset' : myData, 'predictedFieldName' : 'assignment_group', 'inputFieldNames':['short_description'] }); // Add the estimate to the store to later be able to retrieve it. var my_unique_name = sn_ml.PredictabilityEstimateStore.add(myEstimate); // Train the estimate - this is a long running job var myEstimateVersion = myEstimate.submitTrainingJob();