--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://www.servicenow.com/docs/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 --- # ÄhnlichkeitslösungVersion : Global # ÄhnlichkeitslösungVersion : Global {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 Minuten Lesedauer Die Ähnlichkeitslösungs- 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. Diese API wird zum Arbeiten mit Lösungsversionen verwendet, die auf [Ähnlichkeitslösungs-API](https://www.servicenow.com/docs/ySKVPcJtUL3Mo0Ghk45f_A#SimilaritySolutionAPI "Die Ähnlichkeitslösungs- API ist ein skriptfähiges Objekt, das in den Filialen Predictive Intelligence verwendet wird.") -Objekten im [Ähnlichkeitslösungsspeicher](https://www.servicenow.com/docs/jdTY~8E_WwSjaB2zahReiA#SimilaritySolutionStoreAPI "Ermöglicht das Speichern und Abrufen von Lösungen.")basieren. Das System erstellt bei jedem Training einer Lösungsdefinition eine Lösungsversion. Die meisten Versionen werden während des geplanten Lösungstrainings erstellt. Auf Methoden in dieser API kann mit den folgenden Ähnlichkeitslösungsmethoden zugegriffen werden: * [abrufenAktiveVersion()](https://www.servicenow.com/docs/ySKVPcJtUL3Mo0Ghk45f_A#SimilaritySol-getActiveVersion "Ruft das aktive ab Ähnlichkeitslösungsversion- Objekt.") * [abrufenAlleVersionen()](https://www.servicenow.com/docs/ySKVPcJtUL3Mo0Ghk45f_A#SimilaritySol-getAllVersions "Ruft alle Versionen von ab ein Ähnlichkeitslösungsobjekt.") * [abrufenAktuelleVersion()](https://www.servicenow.com/docs/ySKVPcJtUL3Mo0Ghk45f_A#SimilaritySol-getLatestVersion "Ruft die aktuelle Version von ab eine Lösung.") * [getVersion ()](https://www.servicenow.com/docs/ySKVPcJtUL3Mo0Ghk45f_A#SimilaritySol-getVersion_S "Ruft eine Lösung ab anhand der angegebenen Versionsnummer.") {#SimilaritySolutionVersionAPI__ul_ycl_fzf_tlb} ## ÄhnlichkeitslösungVersion -- 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 der Details zu Datensatz und [Ähnlichkeitslösungsversion](https://www.servicenow.com/docs/ySKVPcJtUL3Mo0Ghk45f_A#SimilaritySolutionAPI "Die Ähnlichkeitslösungs- API ist ein skriptfähiges Objekt, das in den Filialen Predictive Intelligence verwendet wird."). Die Ergebnisse variieren je nach Einrichtung der Objekteigenschaften. { "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" } | | \.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. | | \.Encoder | Encoder-Objekt, das dieser Lösung zugewiesen ist. Siehe [Encoder: Encoder (Objektkonfiguration)](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#Encoder-Encoder_O "Erstellt einen Encoder."). Datentyp: Objekt. | | \.istAktiv | 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 | | \.label | Gibt die Vorhersageaufgabe an. { "label": "my first prediction" } Datentyp: Zeichenfolge. | | \.lookupDatasetProperties | Details der [Datensatzdefinition ()](https://www.servicenow.com/docs/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.") Objekt, das als Suchsatz verwendet wird. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Objekt. | | \.lookupDatasetProperties.tableName | Name der Tabelle für den Datensatz. Beispiel: `„tableName" : „Incident"`. Datentyp: Zeichenfolge. | | \.lookupDatasetProperties.fieldNames | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„fieldNames" : ["short_description", "priority"]`. Datentyp: Array. | | \.lookupDatasetProperties.fieldNames.fieldDetails | Liste von JavaScript-Objekten, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. | | \.lookupDatasetProperties.fieldNames.fieldDetails.\.name | Name des Felds, das die Art der Informationen definiert, auf die dieser Datensatz beschränkt werden soll Datentyp: Zeichenfolge. | | \.lookupDatasetProperties.fieldDetails.\.type | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. | | \.lookupDatasetProperties.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. | | \.name | Vom System zugewiesener Name Datentyp: Zeichenfolge. | | \.predictedFieldName | Gibt ein Feld an, das für die Vorhersagbarkeit trainiert werden soll. Datentyp: Zeichenfolge. | | \.processingLanguage | Verarbeitungssprache im zweibuchstabigen ISO 639-1-Sprachcodeformat. Datentyp: Zeichenfolge. | | \.scope | Objektbereich. Derzeit ist `global`der einzige gültige Wert. Datentyp: Zeichenfolge | | \.Stoppwörter | Optional. Voreingestellte Liste von Zeichenfolgen, die das System basierend auf der Einstellung der Eigenschaft language automatisch generiert. Einzelheiten hierzu finden [Sie unter Anwenderdefinierte Stoppwortliste erstellen](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US). Datentyp: Array. | | \.testDatasetProperties | Details der [Datensatzdefinition ()](https://www.servicenow.com/docs/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.") Objekt zum Abrufen von Ähnlichkeiten zwischen den in diesem Modell gesuchten Ergebnissen und den in lookupDatasetgefundenen Ergebnissen. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Objekt. | | \.testDatasetProperties.tableName | Name der Tabelle für den Datensatz. Beispiel: `„tableName" : „Incident"`. Datentyp: Zeichenfolge. | | \.testDatasetProperties.fieldNames | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„fieldNames" : ["short_description", "priority"]`. Datentyp: Array. | | \.testDatasetProperties.fieldNames.fieldDetails | Liste von JavaScript-Objekten, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. | | \.testDatasetProperties.fieldNames.fieldDetails.\.name | Name des Felds, das die Art der Informationen definiert, auf die dieser Datensatz beschränkt werden soll Datentyp: Zeichenfolge. | | \.testDatasetProperties.fieldDetails.\.type | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. | | \.testDatasetProperties.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. | | \.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 {#SimilarityVersion-getProperties__ul_pmw_523_plb}Standard: run_once Datentyp: Zeichenfolge. | | \.updateFrequency | Die Häufigkeit, mit der das Modell für die Lösungsdefinition neu erstellt werden muss. Mögliche Werte: * do_not_update * jeden_1_Tag * jeden_1_Stunden * jeden_6_Stunden * jeden_12_Stunden * jede_1_Minute * jeden_15_Minuten * jeden_30_Minuten {#SimilarityVersion-getProperties__ul_kjm_2jh_3mb}Standard: do_not_update Datentyp: Zeichenfolge | | \.versionsnummer | Versionsnummer von Ähnlichkeitslösungsobjekt. Datentyp: Zeichenfolge. | [Tabelle : 2. Ergebnisse] {#SimilarityVersion-getProperties__table_e2m_zwz_4lb} Im folgenden Beispiel werden Eigenschaften der aktiven Objektversion im Store abgerufen. // 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" } ## ÄhnlichkeitslösungVersion -- getStatus(Boolean IncludesDetails) {#ariaid-title3} Ruft den Status des Schulungsabschlusses ab. {#SimilarityVersion-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. {#SimilarityVersion-getStatus_B__ul_n33_ckw_plb} Standardwert: False | [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ält ein [Ähnlichkeitslösungsobjekt](https://www.servicenow.com/docs/ySKVPcJtUL3Mo0Ghk45f_A#SimilaritySolutionAPI "Die Ähnlichkeitslösungs- API ist ein skriptfähiges Objekt, das in den Filialen Predictive Intelligence verwendet wird."). { "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 {#SimilarityVersion-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. {#SimilarityVersion-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 : 4. Ergebnisse] {#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" } ## ÄhnlichkeitslösungVersion -- 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. Ergebnisse] {#SimilarityVersion-getVersionNumber__table_ksz_sbw_plb} Das folgende Beispiel zeigt, wie Sie eine Versionsnummer abrufen. // 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 ## ÄhnlichkeitslösungVersion -vorhersage (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://www.servicenow.com/docs/aQw~oDpg6tKgED8LtNFyvw#c_GlideRecordAPI "Die GlideRecord- API wird für Datenbankvorgänge verwendet.") oder ein 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 } | | Optionen.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": Alle Ergebnisse zurückgeben. {#SimilarityVersion-predict_O_O__ul_f4d_xyx_slb} Standardwert: True | | Optionen.top_n | Nummer | Wenn angegeben, werden die besten 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 nach sys_id oder record_number sortierten Vorhersageergebnisse enthält. { : [Array] } | | \.\ | Liste von Objekten mit Details für jedes Vorhersageergebnis. Datentyp: Array von Objekten : [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ] | | \.\ .\.confidence | Wert der Konfidenz, die der Vorhersage zugeordnet ist. Beispiel: 53,84. Datentyp: Zahl | | \.\ .\.predictedSysId | Die sys_id des vorhergesagten Werts. Ergebnisse können aus jeder Tabelle stammen, in der Informationen vorhergesagt werden. Datentyp: Zeichenfolge | | \.\ .\.predictedValue | Wert, der das Vorhersageergebnis darstellt. Datentyp: Zeichenfolge | | \.\ .\.threshold | Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist. Datentyp: Zahl | [Tabelle : 8. Ergebnisse] {#SimilarityVersion-predict_O_O__table_xwz_pbw_plb} Das folgende Beispiel zeigt, wie Vorhersageergebnisse für einepredict ()- Methode angezeigt werden, die einen GlideRecord nach sys_id als Eingabe akzeptiert und optionale Parameter einschließt, um die Top-3-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(""); // 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": "" } ] } Das folgende Beispiel zeigt, wie Vorhersageergebnisse für einepredict()- Methode angezeigt werden, die ein Array von Feldnamen als Schlüssel-Wert-Paare für die Eingabe akzeptiert und optionale Parameter einschließt, um die Top-3-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": "" } ] }