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


---

# Ähnliche Lösungsversion -- Global

# Ähnliche Lösungsversion -- Global {#ariaid-title1}

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

Die Ähnliche Lösungsversion 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.

Diese API wird für die Arbeit mit Lösungsversionen basierend auf verwendet [Ähnliche Lösungs-API](https://servicenow-prod.fluidtopics.net/IG9IOSG~2LSq75jU9xPEcw#SimilaritySolutionAPI "Die Gleichzeitigkeitslösung API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.")Objekte in [Ähnlicher Lösungsspeicher](https://servicenow-prod.fluidtopics.net/MXlBNmENOIB3aVM1SUfCoQ#SimilaritySolutionStoreAPI "Aktiviert das Speichern und Abrufen Lösungen.").

Das System erstellt jedes Mal eine Lösungsversion, wenn Sie eine Lösungsdefinition trainieren. Die meisten Versionen werden während des geplanten Lösungstrainings erstellt.  
Methoden in dieser API sind über Folgendes zugänglich Gleichzeitigkeitslösung Methoden:

* [GetActiveVersion()](https://servicenow-prod.fluidtopics.net/IG9IOSG~2LSq75jU9xPEcw#SimilaritySol-getActiveVersion "Ruft die aktiven ab Ähnliche Lösungsversion Objekt.")
* [GetAllVersions()](https://servicenow-prod.fluidtopics.net/IG9IOSG~2LSq75jU9xPEcw#SimilaritySol-getAllVersions "Ruft alle Versionen von abA Gleichzeitigkeitslösung Objekt.")
* [GetLatestVersion()](https://servicenow-prod.fluidtopics.net/IG9IOSG~2LSq75jU9xPEcw#SimilaritySol-getLatestVersion "Ruft die neueste Version von ab Eine Lösung.")
* [Getversion()](https://servicenow-prod.fluidtopics.net/IG9IOSG~2LSq75jU9xPEcw#SimilaritySol-getVersion_S "Ruft eine Lösung ab Nach angegebener Versionsnummer.")
{#SimilaritySolutionVersionAPI__ul_ycl_fzf_tlb}

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

Ruft Lösungsobjekteigenschaften ab Und Versionsnummer.
{#SimilarityVersion-getProperties__table_d2m_zwz_4lb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

{#SimilarityVersion-getProperties__table_d2m_zwz_4lb} {#SimilarityVersion-getProperties__table_e2m_zwz_4lb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Inhalt des Datensatzes und [Gleichzeitigkeitslösung](https://servicenow-prod.fluidtopics.net/IG9IOSG~2LSq75jU9xPEcw#SimilaritySolutionAPI "Die Gleichzeitigkeitslösung API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.")Versionsdetails. Die Ergebnisse variieren je nach Setup der Objekteigenschaft. { "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" } |
| \<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\>.Encoder | Encoderobjekt, das dieser Lösung zugewiesen ist.Siehe [Encoder -- Encoder (Objektkonfiguration)](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-Encoder_O "Erstellt einen Encoder."). Datentyp: Objekt. |
| \<Object\>.Isaktiv | Kennzeichnung, die angibt, ob diese Version aktiv ist. Gültige Werte: * Wahr: Version ist aktiv. * Falsch: Version ist nicht aktiv. {#SimilarityVersion-getProperties__ul_i5m_lp1_dmb} Datentyp: Zeichenfolge |
| \<Object\>.Bezeichnung | Gibt die Vorhersageaufgabe an. { "label": "my first prediction" } Datentyp: Zeichenfolge. |
| \<Object\>.LookupDatasetProperties | Details von [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 als Suchsatz verwendet wird. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Objekt. |
| \<Object\>.LookupDatasetProperties.tableName | Name der Tabelle für den Datensatz. Beispiel: `„Tabellenname": „Incident" `. Datentyp: Zeichenfolge. |
| \<Object\>.LookupDatasetProperties.fieldnames | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„Feldnamen": ["short_description", "Priorität"] `. Datentyp: Array. |
| \<Object\>.LookupDatasetProperties.fieldnames.fieldDetails | Liste der JavaScript-Objekte, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. |
| \<Object\>.LookupDatasetProperties.fieldnames.fieldDetails. \<object\>.Name | Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll. Datentyp: Zeichenfolge. |
| \<Object\>.LookupDatasetProperties.fieldDetails. \<object\>.Typ | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. |
| \<Object\>.LookupDatasetProperties.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\>.Name | Vom System zugewiesener Name. Datentyp: Zeichenfolge. |
| \<Object\>.PredictedFieldName | Gibt ein Feld an, das auf Vorhersehbarkeit trainiert werden soll. Datentyp: Zeichenfolge. |
| \<Object\>.ProcessingLanguage | Sprache wird im zweistelligen ISO 639-1-Sprachcodeformat verarbeitet. Datentyp: Zeichenfolge. |
| \<Object\>.Umfang | Objektbereich. Derzeit ist der einzige gültige Wert `Global `. Datentyp: Zeichenfolge |
| \<Object\>.Stoppwörter | Optional. Voreingestellte Liste von Zeichenfolgen, die das System automatisch basierend auf generiert languageEigenschaftseinstellung. Weitere Informationen finden Sie unter [Erstellen Sie eine anwenderdefinierte Stoppwortliste](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US). Datentyp: Array. |
| \<Object\>.TestDatasetProperties | Details von [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 zum Abrufen von Ähnlichkeiten zwischen Ergebnissen, die in diesem Modell gesucht werden, und Ergebnissen verwendet wird, die in gefunden wurden lookupDataset. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Objekt. |
| \<Object\>.TestDatasetProperties.tableName | Name der Tabelle für den Datensatz. Beispiel: `„Tabellenname": „Incident" `. Datentyp: Zeichenfolge. |
| \<Object\>.TestDatasetProperties.fieldnames | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„Feldnamen": ["short_description", "Priorität"] `. Datentyp: Array. |
| \<Object\>.TestDatasetProperties.fieldnames.fieldDetails | Liste der JavaScript-Objekte, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. |
| \<Object\>.TestDatasetProperties.fieldnames.fieldDetails. \<object\>.Name | Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll. Datentyp: Zeichenfolge. |
| \<Object\>.TestDatasetProperties.fieldDetails. \<object\>.Typ | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. |
| \<Object\>.TestDatasetProperties.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\>.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 {#SimilarityVersion-getProperties__ul_pmw_523_plb}Standard: Run_once Datentyp: Zeichenfolge. |
| \<Object\>.UpdateFrequency | Die Häufigkeit, mit der das Modell für die Lösungsdefinition neu erstellt werden muss. Mögliche Werte: * Do_Not_Update * Every_1_day * Every_1_Hour * Every_6_hours * Every_12_hours * Jede_1_Minute * Alle_15_Minuten * Alle_30_Minuten {#SimilarityVersion-getProperties__ul_kjm_2jh_3mb}Standard: Do_not_Update Datentyp: Zeichenfolge |
| \<Object\>.VersionNumber | Versionsnummer von Gleichzeitigkeitslösung Objekt. Datentyp: Zeichenfolge. |
[Tabelle : 2. Rückgaben]

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

    // Get properties
    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');

    gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));

Ausgabe:

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

Ruft den Abschlussstatus des Trainings ab.
{#SimilarityVersion-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. {#SimilarityVersion-getStatus_B__ul_n33_ckw_plb} Standard: Falsch |
[Tabelle : 3. Parameter]

{#SimilarityVersion-getStatus_B__table_xfh_vbw_plb} {#SimilarityVersion-getStatus_B__table_yfh_vbw_plb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | JavaScript-Objekt, das Informationen zum Schulungsstatus für enthältA [Gleichzeitigkeitslösung](https://servicenow-prod.fluidtopics.net/IG9IOSG~2LSq75jU9xPEcw#SimilaritySolutionAPI "Die Gleichzeitigkeitslösung API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.")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 {#SimilarityVersion-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. {#SimilarityVersion-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 : 4. Rückgaben]

{#SimilarityVersion-getStatus_B__table_yfh_vbw_plb}  
Das folgende Beispiel zeigt ein erfolgreiches Ergebnis mit abgeschlossenem Training.

    // Get status
    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');

    gs.print(JSON.stringify(JSON.parse(mlSolution.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 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));

Ausgabe:

    {
     "state":"solution_error",
     "percentComplete":"100",
     "hasJobEnded":"true"
    }

## SimilaritySolutionVersion -- getVersionNumber() {#ariaid-title4}

Ruft die Versionsnummer von ab Ein Lösungsobjekt.
{#SimilarityVersion-getVersionNumber__table_jsz_sbw_plb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 5. Parameter]

{#SimilarityVersion-getVersionNumber__table_jsz_sbw_plb} {#SimilarityVersion-getVersionNumber__table_ksz_sbw_plb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Versionsnummer. |
[Tabelle : 6. Rückgaben]

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

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

Ausgabe:

    Version number: 1

## SimilaritySolutionVersion -- Predict (Objekteingabe, Objektoptionen) {#ariaid-title5}

Ruft die Eingabedaten für eine Vorhersage ab.
{#SimilarityVersion-predict_O_O__table_wwz_pbw_plb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Eingabe | Objekt | [GlideRecord](https://servicenow-prod.fluidtopics.net/PhVphXpfpHtoByvicO1vjw#c_GlideRecordAPI "Die GlideRecord API wird für Datenbankvorgänge verwendet.") Oder Array von JSON-Objekten, die Feldnamen und -Werte als Schlüssel-Wert-Paare enthalten. |
| Optionen | Objekt | Optionale Werte zum Filtern von Vorhersageergebnissen. { "apply_threshold": Boolean, "top_n": Number } |
| Options.apply_threshold | Boolean | Kennzeichnung, die angibt, ob der Schwellenwert für die Lösung überprüft und auf den Ergebnissatz angewendet werden soll. Gültige Werte: * Wahr: Gibt Ergebnisse zurück, bei denen die Konfidenz größer als der Schwellenwert ist. * Falsch: Gibt alle Ergebnisse zurück. {#SimilarityVersion-predict_O_O__ul_f4d_xyx_slb} Standard: Wahr |
| Options.Top_n | Nummer | Wenn angegeben, werden die Top-Ergebnisse bis zur angegebenen Anzahl von Vorhersagen zurückgegeben. |
[Tabelle : 7. Parameter]

{#SimilarityVersion-predict_O_O__table_wwz_pbw_plb} {#SimilarityVersion-predict_O_O__table_xwz_pbw_plb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | JSON-Objekt, das die Vorhersageergebnisse enthält, sortiert nach sys_ID oder Record_number. { <identifier>: [Array] } |
| \<Object\>.\<identifier\> | Liste von Objekten mit Details für jedes Vorhersageergebnis. Datentyp: Array von Objekten <identifier>: [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ] |
| \<Object\>.\<identifier\>. \<object\>.Konfidenz | Wert der Konfidenz, die der Vorhersage zugeordnet ist. Beispiel: 53.84. Datentyp: Zahl |
| \<Object\>.\<identifier\>. \<object\>.PredictedSysId | Die sys_ID des vorhergesagten Werts. Ergebnisse können aus jeder Tabelle stammen, für die Informationen vorhergesagt werden. Datentyp: Zeichenfolge |
| \<Object\>.\<identifier\>. \<object\>.PredictedValue | Wert, der das Vorhersageergebnis darstellt. Datentyp: Zeichenfolge |
| \<Object\>.\<identifier\>. \<object\>.Schwellenwert | Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist. Datentyp: Zahl |
[Tabelle : 8. Rückgaben]

{#SimilarityVersion-predict_O_O__table_xwz_pbw_plb}  
Das folgende Beispiel zeigt, wie Vorhersageergebnisse für angezeigt werden Vorhersagen() Methode, die einen GlideRecord nach sys_ID für die Eingabe verwendet und optionale Parameter enthält, um auf die drei wichtigsten Ergebnisse zu beschränken und den Schwellenwert auszuschließen.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');

    // single GlideRecord input
    var input = new GlideRecord("incident");
    input.get("<sys_id>");

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

    {
            "<sys_id/now_GR>": [
        {
          "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": ""
        }
      ]
    }

Das folgende Beispiel zeigt, wie Vorhersageergebnisse für angezeigt werden Vorhersagen() Methode, die ein Array von Feldnamen als Schlüssel-Wert-Paare für die Eingabe verwendet und optionale Parameter enthält, um auf die drei wichtigsten Ergebnisse zu beschränken und den Schwellenwert auszuschließen.

    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": ""
        }
      ]
    }


