---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# VorhersageabilitätEstimateVersion -- Global

# VorhersageabilitätEstimateVersion -- Global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Die VorhersageabilitätEstimateVersion API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.

Diese(s) API erfordert Predictive IntelligencePlugin (com.glide.platform_ml) und wird in bereitgestellt `sn_ml `Namespace.

Verwenden Sie diese API, wenn Sie mit Versionen der Vorhersagbarkeitsschätzung basierend auf arbeiten [VorhersagefähigkeitsEstimate-API](https://servicenow-prod.fluidtopics.net/amBVbFONwX1yUwKDr0yCeQ#PredictabilityEstimateAPI "Die VorhersageabilitätEstimate API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert. Dieses Objekt bietet eine Schätzung, wie vorhersehbare Felder eines Datensatzes sein können und welche Funktionen für die Vorhersage dieser Felder nützlich sein können.")Objekte in [VorhersageabilitätEstimate Store](https://servicenow-prod.fluidtopics.net/fv~8AjelqYc5lbw~FwtZww#PredictabilityEstimateStoreAPI "Aktiviert das Speichern und Abrufen Schätzungen der Vorhersagbarkeit.").

Das System aktiviert die neueste Version von Vorhersagbarkeitsschätzung Wenn das Training abgeschlossen ist und nur eine Version gleichzeitig aktiv sein kann. Sie können jedoch jede zuvor trainierte Version aktivieren, die Sie für Vorhersagen verwenden möchten.  
Methoden in dieser API sind über Folgendes zugänglich VorhersagetabiltyEstimate Methoden:

* [GetActiveVersion()](https://servicenow-prod.fluidtopics.net/amBVbFONwX1yUwKDr0yCeQ#PrdctbltE-getActiveVersion "Ruft die aktiven ab VorhersageabilitätEstimateVersion Objekt.")
* [GetAllVersions()](https://servicenow-prod.fluidtopics.net/amBVbFONwX1yUwKDr0yCeQ#PrdctbltE-getAllVersions "Ruft alle Versionen von ab Eine Vorhersagbarkeitsschätzung.")
* [GetLatestVersion()](https://servicenow-prod.fluidtopics.net/amBVbFONwX1yUwKDr0yCeQ#PrdctbltE-getLatestVersion "Ruft die neueste Version von ab Eine Vorhersagbarkeitsschätzung.")
* [Getversion()](https://servicenow-prod.fluidtopics.net/amBVbFONwX1yUwKDr0yCeQ#PrdctbltE-getVersion_S "Ruft eine Vorhersagbarkeitsschätzung ab Nach angegebener Versionsnummer.")
{#PredictabilityEstimateVersionAPI__ul_ycl_fzf_tlb}

## PredictabilityEstimateVersion -- getProperties() {#ariaid-title2}

Ruft Objekteigenschaften 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 des Datensatzes und [VorhersageabilitätEstimate](https://servicenow-prod.fluidtopics.net/amBVbFONwX1yUwKDr0yCeQ#PrdctbltE-PredictabilityEstimate_O "Erstellt eine Vorhersagbarkeitsschätzung.")Versionsdetails. Die Ergebnisse variieren je nach Setup der Objekteigenschaft. { "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String", "versionNumber": "Number" } |
| \<Object\>.DatasetProperties | Listet die Eigenschaften von auf [Datendefinition()](https://servicenow-prod.fluidtopics.net/P8pkp_FhlIJCSLrp2tVuyA#DDef-DatasetDefinition_O "Erstellt eine Instanz von Datendefinition Klasse, mit der Sie einen Datensatz nach Tabellenname, Feldern und Abfrage definieren können.")Objekt, das der Vorhersagbarkeitsschätzung zugeordnet ist. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Objekt. |
| \<Object\>.DatasetProperties.tableName | Name der Tabelle für den Datensatz. Beispiel: `„Tabellenname": „Incident" `. Datentyp: Zeichenfolge. |
| \<Object\>.DatasetProperties.Feldnamen | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„Feldnamen": ["short_description", "Priorität"] `. Datentyp: Array. |
| \<Object\>.DatasetProperties.fieldnames.fieldDetails | Liste der JavaScript-Objekte, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. |
| \<Object\>.DatasetProperties.fieldnames.fieldDetails. \<object\>.Name | Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll. Datentyp: Zeichenfolge. |
| \<Object\>.DatasetProperties.fieldDetails. \<object\>.Typ | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. |
| \<Object\>.DatasetProperties.fieldDetails.encodedQuery | Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe [Codierte Abfragezeichenfolgen](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). Datentyp: Zeichenfolge. |
| \<Object\>.Domänenname | Domänenname, der diesem Datensatz zugeordnet ist. Siehe [Domänentrennung und Predictive Intelligence](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US). Datentyp: Zeichenfolge. |
| \<Object\>.InputFieldNames | Liste der Kandidateneingabefelder als Zeichenfolgen, die bei der Schätzung berücksichtigt werden sollen. Datentyp: Zeichenfolge. |
| \<Object\>.Isaktiv | 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 |
| \<Object\>.Bezeichnung | Gibt die Vorhersageaufgabe an. { "label": "my first prediction" } Datentyp: Zeichenfolge. |
| \<Object\>.Name | Vom System zugewiesener Name. Datentyp: Zeichenfolge. |
| \<Object\>.PredictedFieldName | Gibt ein Feld an, das auf Vorhersehbarkeit trainiert werden soll. Datentyp: Zeichenfolge. |
| \<Object\>.Umfang | Objektbereich. Derzeit ist der einzige gültige Wert `Global `. Datentyp: Zeichenfolge |
| \<Object\>.TrainingHäufigkeit | Die Häufigkeit zum erneuten Trainieren des Modells. Mögliche Werte: * Every_30_days * Every_60_days * Every_90_days * Every_120_days * Every_180_days * Run_once {#PredictbltyEstV-getProperties__ul_pmw_523_plb}Standard: Run_once Datentyp: Zeichenfolge. |
| \<Object\>.VersionNumber | Versionsnummer von VorhersageabilitätEstimate Objekt. Datentyp: Zeichenfolge. |
[Tabelle : 2. Rückgaben]

{#PredictbltyEstV-getProperties__table_e2m_zwz_4lb}  
Das folgende Beispiel ruft Eigenschaften der aktiven Objektversion im Store ab.

    // 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 mit vorgeschlagenen Eingabefeldoptionen für ein Ausgabefeld. |
| \<Object\>.\<output field name\> | Ausgabefeldname, z. B. Kategorie , Enthält vorgeschlagene Eingabefelder. { "<output field name>": { "nominalInputFields": [Array], "textInputFields": [Array] } } Datentyp: Objekt |
| \<Object\>. \<output field name\>.NominalInputFields | Nominale Eingabefelddetails. "nominalInputFields": [ { "fieldName": "String", "modelImprovement": "String" } ] Datentyp: Array. |
| \<Object\>. \<output field name\>.NominalInputFields.fieldName | Nominaler Eingabefeldname. Datentyp: Zeichenfolge. |
| \<Object\>. \<output field name\>.NominalInputFelder.ModellVerbesserung | Punktzahl als relativer Hinweis darauf, wie wahrscheinlich es ist, dass dieses Feld die Ergebnisse verbessert. Datentyp: Zahl als Zeichenfolge. |
| \<Object\>.TextInputFields | Texteingabefelddetails. "textInputFields": [ { "fieldName": "String", "density": "String" } ] Datentyp: Array. |
| \<Object\>.TextInputFields.fieldName | Name des Texteingabefelds. Datentyp: Zeichenfolge. |
| \<Object\>.textInputFields.density | Wert zwischen 0 und 1,0, der die Häufigkeit darstellt, dass 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. Rückgaben]

{#PredictbltyEstV-getResults__table_ztt_1xz_qlb}  
Das folgende Beispiel zeigt, wie Ergebnisse für eine ausgewählte Version einer Vorhersagbarkeitsschätzung im Store abgerufen werden.

    // 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(boolescher IncludeDetails) {#ariaid-title4}

Ruft den Abschlussstatus des Trainings ab.
{#PredictbltyEstV-getStatus_B__table_xfh_vbw_plb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| IncludeDetails | Boolean | Kennzeichnung, die angibt, ob der Status zurückgegeben werden soll details. Gültige Werte: * Wahr: Gibt zusätzliche Details zurück. * Falsch: Geben Sie keine zusätzlichen Details zurück. {#PredictbltyEstV-getStatus_B__ul_n33_ckw_plb} Standard: Falsch |
[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ältA [VorhersageabilitätEstimate](https://servicenow-prod.fluidtopics.net/amBVbFONwX1yUwKDr0yCeQ#PredictabilityEstimateAPI "Die VorhersageabilitätEstimate API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert. Dieses Objekt bietet eine Schätzung, wie vorhersehbare 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} } |
| \<Object\>.Status | Abschlussstatus des Trainings. Wenn der Schulungsauftrag einen Terminalstatus erreicht, verlässt der Auftrag diesen Status nicht. Wenn der Status „Terminal" ist, wird hasJobEndedEigenschaft ist auf festgelegt `Wahr `. Mögliche Werte: * fetching_files_for_training * Preparing_Data * Erneut versuchen * Solution_CANCEL (Terminal) * Solution_Complete (Terminal) * Solution_error (Terminal) * Lösung_unvollständig * Training_Request_Received * training_request_timed_out (Terminal) * Training_Solution * Uploading_Solution * Warten_auf_Training {#PredictbltyEstV-getStatus_B__ul_a5q_gh4_vlb} Datentyp: Zeichenfolge |
| \<Object\>.HasJobEnded | Kennzeichnung, die angibt, ob das Training abgeschlossen ist. Gültige Werte: * Wahr: Training ist abgeschlossen. * Falsch: Training ist unvollständig. {#PredictbltyEstV-getStatus_B__ul_icy_zjx_rlb} Datentyp: Boolescher Wert als Zeichenfolge |
| \<Object\>.Prozent abgeschlossen | Abschluss des Trainings in Prozent. Wenn der Fertigstellungsprozentsatz kleiner als 100 ist, befindet sich der Auftrag möglicherweise in einem Terminalstatus. Beispiel: Wenn beim Training eine Zeitüberschreitung auftritt. Datentyp: Zahl als Zeichenfolge Bereich: 0 bis 100 |
| \<Object\>.Details | Objekt, das eine Liste zusätzlicher Schulungsdetails enthält. Datentyp: Objekt |
[Tabelle : 6. Rückgaben]

{#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 Schätzungsobjekt für Vorhersagbarkeit.
{#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. Rückgaben]

{#PredictbltyEstV-getVersionNumber__table_ksz_sbw_plb}  
Das folgende Beispiel zeigt, wie eine Versionsnummer abgerufen wird.

    // 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


