--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # PredictabilityEstimateVersion : Global # PredictabilityEstimateVersion : Global {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer Die PredictabilityEstimateVersion- API ist ein skriptfähiges Objekt, das in den Filialen Predictive Intelligence verwendet wird. Diese(s) Die API erfordert das Plugin Predictive Intelligence (com.glide.platform_ml) und wird im Namespace `sn_ml` bereitgestellt. Verwenden Sie diese API, wenn Sie mit Versionen der Vorhersagbarkeitsschätzung basierend auf [PredictabilityEstimate-API](https://servicenow-prod.fluidtopics.net/hyu6Okm2OXR3U5nHR6fVSQ#PredictabilityEstimateAPI "Die PredictabilityEstimate- API ist ein skriptfähiges Objekt, das in den Filialen Predictive Intelligence verwendet wird. Dieses Objekt schätzt, wie vorhersehbar die Felder eines Datensatzes sein können und welche Funktionen für die Vorhersage dieser Felder nützlich sein können.") -Objekten im [PredictabilityEstimate-Store arbeiten](https://servicenow-prod.fluidtopics.net/b34_om4fIzBS9DfHrR9vXQ#PredictabilityEstimateStoreAPI "Ermöglicht das Speichern und Abrufen von Schätzungen der Vorhersagbarkeit"). Das System aktiviert die neueste Version der Schätzung der Vorhersagbarkeit , wenn das Training abgeschlossen wird. Es kann jeweils nur eine Version aktiv sein. Sie können jedoch jede zuvor trainierte Version aktivieren, die Sie verwenden möchten, um Vorhersagen zu treffen. Auf die Methoden in dieser API kann mit den folgenden PredictabilityEstimate- Methoden zugegriffen werden: * [abrufenAktiveVersion()](https://servicenow-prod.fluidtopics.net/hyu6Okm2OXR3U5nHR6fVSQ#PrdctbltE-getActiveVersion "Ruft das aktive ab PredictabilityEstimateVersion- Objekt") * [abrufenAlleVersionen()](https://servicenow-prod.fluidtopics.net/hyu6Okm2OXR3U5nHR6fVSQ#PrdctbltE-getAllVersions "Ruft alle Versionen von ab eine Schätzung der Vorhersagbarkeit") * [abrufenAktuelleVersion()](https://servicenow-prod.fluidtopics.net/hyu6Okm2OXR3U5nHR6fVSQ#PrdctbltE-getLatestVersion "Ruft die aktuelle Version von ab eine Schätzung der Vorhersagbarkeit") * [getVersion ()](https://servicenow-prod.fluidtopics.net/hyu6Okm2OXR3U5nHR6fVSQ#PrdctbltE-getVersion_S "Ruft eine Schätzung der Vorhersagbarkeit ab anhand der angegebenen Versionsnummer.") {#PredictabilityEstimateVersionAPI__ul_ycl_fzf_tlb} ## PredictabilityEstimateVersion -- getProperties() {#ariaid-title2} Ruft die Eigenschaften des Objekts der Vorhersagbarkeitsschätzung ab und Versionsnummer. {#PredictbltyEstV-getProperties__table_d2m_zwz_4lb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 1. Parameter] {#PredictbltyEstV-getProperties__table_d2m_zwz_4lb} {#PredictbltyEstV-getProperties__table_e2m_zwz_4lb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | Inhalt der Details zu Datensatz und [PredictabilityEstimate-](https://servicenow-prod.fluidtopics.net/hyu6Okm2OXR3U5nHR6fVSQ#PrdctbltE-PredictabilityEstimate_O "Erstellt eine Vorhersagbarkeitsschätzung.") Version. Die Ergebnisse variieren je nach Einrichtung der Objekteigenschaften. { "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String", "versionNumber": "Number" } | | \.datasetProperties | Listet die Eigenschaften des [DatasetDefinition()-](https://servicenow-prod.fluidtopics.net/BXzFaC72fsNUF0~2iVZkiA#DDef-DatasetDefinition_O "Erstellt eine Instanz der DatasetDefinition -Klasse, sodass Sie einen Datensatz anhand des Tabellennamens, der Felder und der Abfrage definieren können.") Objekts auf, das der Vorhersagbarkeitsschätzung zugeordnet ist. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Objekt. | | \.datensatzEigenschaften.tabellenname | Name der Tabelle für den Datensatz. Beispiel: `„tableName" : „Incident"`. Datentyp: Zeichenfolge. | | \.datasetProperties.fieldNames | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„fieldNames" : ["short_description", "priority"]`. Datentyp: Array. | | \.datasetProperties.fieldNames.fieldDetails | Liste von JavaScript-Objekten, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. | | \.datasetProperties.fieldNames.fieldDetails.\.name | Name des Felds, das die Art der Informationen definiert, auf die dieser Datensatz beschränkt werden soll Datentyp: Zeichenfolge. | | \.datasetProperties.fieldDetails.\.type | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. | | \.datasetProperties.fieldDetails.encodedQuery | Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe [Codierte Abfragezeichenfolgen](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). Datentyp: Zeichenfolge. | | \.Domänenname | Domänenname, der diesem Datensatz zugeordnet ist. Siehe [Domain Separation und Predictive Intelligence](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US). Datentyp: Zeichenfolge. | | \.eingabeFeldNamen | Liste der Kandidateneingabefelder als Zeichenfolgen, die für die Schätzung berücksichtigt werden sollen. Datentyp: Zeichenfolge. | | \.istAktiv | Kennzeichnung, die angibt, ob diese Version aktiv ist. Gültige Werte: * wahr: Version ist aktiv. * „falsch": Version ist nicht aktiv. {#PredictbltyEstV-getProperties__ul_i5m_lp1_dmb} Datentyp: Zeichenfolge | | \.label | Gibt die Vorhersageaufgabe an. { "label": "my first prediction" } Datentyp: Zeichenfolge. | | \.name | Vom System zugewiesener Name Datentyp: Zeichenfolge. | | \.predictedFieldName | Gibt ein Feld an, das für die Vorhersagbarkeit trainiert werden soll. Datentyp: Zeichenfolge. | | \.scope | Objektbereich. Derzeit ist `global`der einzige gültige Wert. Datentyp: Zeichenfolge | | \.trainingFrequency | Die Häufigkeit, mit der das Modell neu trainiert werden soll. Mögliche Werte: * jeden_30_Tage * jeden_60_Tage * jeden_90_Tage * jeden_120_Tage * jeden_180_Tage * run_once {#PredictbltyEstV-getProperties__ul_pmw_523_plb}Standard: run_once Datentyp: Zeichenfolge. | | \.versionsnummer | Versionsnummer von PredictabilityEstimate- Objekt. Datentyp: Zeichenfolge. | [Tabelle : 2. Ergebnisse] {#PredictbltyEstV-getProperties__table_e2m_zwz_4lb} Im folgenden Beispiel werden Eigenschaften der aktiven Objektversion im Store abgerufen. // Get properties var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization'); gs.print(JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getProperties()), null, 2)); Ausgabe: "datasetProperties": { "encodedQuery": "activeANYTHING^EQ", "fieldNames": [ "short_description", "category" ], "tableName": "incident" }, "domainName": "global", "inputFieldNames": [ "short_description" ], "isActive": "true", "label": "Incident Categorization_Trainer", "name": "ml_incident_categorization", "predictedFieldName": "category", "processingLanguage": "en", "stopwords": [ "Default English Stopwords" ], "versionNumber": "1" } ## PredictabilityEstimateVersion -- getResults() {#ariaid-title3} Gibt JSON-Ergebnisse zurück, die vorgeschlagene Eingabefelder für ein Ausgabefeld enthalten. {#PredictbltyEstV-getResults__table_ytt_1xz_qlb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 3. Parameter] {#PredictbltyEstV-getResults__table_ytt_1xz_qlb} {#PredictbltyEstV-getResults__table_ztt_1xz_qlb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | JSON-Objektergebnisse, die vorgeschlagene Eingabefeldoptionen für ein Ausgabefeld enthalten. | | \.\ | Name des Ausgabefelds, z. B. „kategorie", das vorgeschlagene Eingabefelder enthält. { "": { "nominalInputFields": [Array], "textInputFields": [Array] } } Datentyp: Objekt | | \.\.nominalInputFields | Details des Nominal-Eingabefelds. "nominalInputFields": [ { "fieldName": "String", "modelImprovement": "String" } ] Datentyp: Array. | | \.\.nominalInputFields.fieldName | Nominaler Eingabefeldname. Datentyp: Zeichenfolge. | | \.\.nominalInputFields.modelImprovement | Punktzahl als relative Angabe, wie wahrscheinlich es ist, dass dieses Feld die Ergebnisse verbessert. Datentyp: Zahl als Zeichenfolge. | | \.textInputFields | Details des Texteingabefelds. "textInputFields": [ { "fieldName": "String", "density": "String" } ] Datentyp: Array. | | \.textEingabeFelder.Feldname | Name des Texteingabefelds. Datentyp: Zeichenfolge. | | \.textInputFields.density | Wert zwischen 0 und 1,0, der die Häufigkeit darstellt, mit der das Feld nicht leer ist. Ein Wert von 1,0 bedeutet, dass das Feld nicht in allen Zeilen leer ist, und ein Wert von 0 gibt an, dass das Feld in allen Zeilen leer ist. Datentyp: Zahl als Zeichenfolge. | [Tabelle : 4. Ergebnisse] {#PredictbltyEstV-getResults__table_ztt_1xz_qlb} Das folgende Beispiel zeigt, wie Sie Ergebnisse für eine ausgewählte Version einer Vorhersagbarkeitsschätzung im Store abrufen. // Get results var estimateName = "ml_x_snc_global_global_predictability_estimate;" var mlEstimate = sn_ml.PredictabilityEstimateStore.get(estimateName); var results = mlEstimate.getActiveVersion().getResults(); gs.print(JSON.stringify(JSON.parse(results), null, 2)); Ausgabe: { "category": { "nominalInputFields": [ { "fieldName": "number", "modelImprovement": "0.167052396325189" }, { "fieldName": "task_effective_number", "modelImprovement": "0.167052396325189" } ], "textInputFields": [ { "fieldName": "short_description", "density": "1.0" } ] } } ## PredictabilityEstimateVersion -- getStatus(Boolean IncludesDetails) {#ariaid-title4} Ruft den Status des Schulungsabschlusses ab. {#PredictbltyEstV-getStatus_B__table_xfh_vbw_plb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | IncludeDetails | Boolean | Kennzeichnung, die angibt, ob der Status detailszurückgegeben werden soll. Gültige Werte: * „wahr": Zusätzliche Details zurückgeben. * „falsch": Es werden keine zusätzlichen Details zurückgegeben. {#PredictbltyEstV-getStatus_B__ul_n33_ckw_plb} Standardwert: False | [Tabelle : 5. Parameter] {#PredictbltyEstV-getStatus_B__table_xfh_vbw_plb} {#PredictbltyEstV-getStatus_B__table_yfh_vbw_plb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | JavaScript-Objekt, das Informationen zum Schulungsstatus für enthält ein [PredictabilityEstimate-](https://servicenow-prod.fluidtopics.net/hyu6Okm2OXR3U5nHR6fVSQ#PredictabilityEstimateAPI "Die PredictabilityEstimate- API ist ein skriptfähiges Objekt, das in den Filialen Predictive Intelligence verwendet wird. Dieses Objekt schätzt, wie vorhersehbar die Felder eines Datensatzes sein können und welche Funktionen für die Vorhersage dieser Felder nützlich sein können.") Objekt. { "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {Object} } | | \.state | Abschlussstatus des Trainings. Wenn der Trainingsauftrag einen Terminalstatus erreicht, verlässt er diesen Zustand nicht. Bei einem Status im Terminal-Bereich wird die Eigenschaft hasJobEnded auf `true`festgelegt. Mögliche Werte: * fetching_files_for_training * präparieren_daten * Erneut versuchen * solution_cancelled (Terminal) * solution_complete (Terminal) * solution_error (Terminal) * solution_incomplete * „training_request_received" * „training_request_timed_out " (Terminal) * „training_solution" * „uploading_solution" * warten_für_Training {#PredictbltyEstV-getStatus_B__ul_a5q_gh4_vlb} Datentyp: Zeichenfolge | | \.hatAuftragBeendet | Kennzeichnung, die angibt, ob das Training abgeschlossen ist. Gültige Werte: * „wahr": Das Training ist abgeschlossen. * „falsch": Das Training ist unvollständig. {#PredictbltyEstV-getStatus_B__ul_icy_zjx_rlb} Datentyp: Boolescher Wert als Zeichenfolge | | \.percentComplete | Schulungsfortschritt abgeschlossen. Wenn der Prozentsatz der Fertigstellung kleiner als 100 ist, befindet sich der Auftrag möglicherweise in einem Terminalstatus. Zum Beispiel, wenn das Training abläuft. Datentyp: Zahl als Zeichenfolge Bereich: 0 bis 100 | | \.details | Objekt mit einer Liste zusätzlicher Schulungsdetails. Datentyp: Objekt | [Tabelle : 6. Ergebnisse] {#PredictbltyEstV-getStatus_B__table_yfh_vbw_plb} Das folgende Beispiel zeigt ein erfolgreiches Ergebnis mit abgeschlossenem Training. // Get status var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization'); gs.print(JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getStatus(true), null, 2))); Ausgabe: { "state":"solution_complete", "percentComplete":"100", "hasJobEnded":"true", "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true); } Das folgende Beispiel zeigt ein nicht erfolgreiches Ergebnis mit abgeschlossenem Training. // Get status var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_my_estimate_definition'); var trainingStatus = mlEstimate.getLatestVersion().getStatus(); gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2)); Ausgabe: { "state": "solution_complete", "percentComplete": "100", "hasJobEnded": "true" } ## PredictabilityEstimateVersion -- getVersionNumber() {#ariaid-title5} Ruft die Versionsnummer von ab ein Objekt für die Vorhersagbarkeitsschätzung. {#PredictbltyEstV-getVersionNumber__table_jsz_sbw_plb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 7. Parameter] {#PredictbltyEstV-getVersionNumber__table_jsz_sbw_plb} {#PredictbltyEstV-getVersionNumber__table_ksz_sbw_plb__entry__2} | Typ | Beschreibung | |-|-| | Zeichenfolge | Versionsnummer. | [Tabelle : 8. Ergebnisse] {#PredictbltyEstV-getVersionNumber__table_ksz_sbw_plb} Das folgende Beispiel zeigt, wie Sie eine Versionsnummer abrufen. // Get version number var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate'); gs.print("Version number: "+JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getVersionNumber()), null, 2)); Ausgabe: Version number: 1