--- 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 --- # EncoderVersion : Global # EncoderVersion : Global {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer Die EncoderVersion- API stellt ein skriptfähiges Objekt bereit, 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 Encoderversionen basierend auf [Encoder-API](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#EncoderAPI "Die Encoder- API stellt ein skriptfähiges Objekt bereit, das in den Speichern Predictive Intelligence verwendet wird. Dieses Objekt konvertiert Eingabedaten basierend auf Encoder-spezifischen Zielen und Konfigurationen in Zahlenvektoren. Encoder können unabhängig zum Ausführen von Codierungen verwendet oder als Teil von Lösungen zum Codieren von Textspalten konfiguriert werden.") -Objekten im [Encoder-Speicher](https://www.servicenow.com/docs/U~Xwa~kCMvIE5d7_6Z0OzA#EncoderStoreAPI "Die EncoderStore- API bietet Methoden zum Speichern und Abrufen von Encodern.")verwendet. Das System aktiviert die neueste Version der Encoder , 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 Methoden in dieser API kann mit den folgenden Encodermethoden zugegriffen werden: * [abrufenAktiveVersion()](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#Encoder-getActiveVersion "Ruft das aktive ab EncoderVersion-Objekt") * [abrufenAlleVersionen()](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#Encoder-getAllVersions "Ruft alle Versionen von ab einen Encoder.") * [abrufenAktuelleVersion()](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#Encoder-getLatestVersion "Ruft die aktuelle Version von ab einen Encoder.") * [getVersion ()](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#Encoder-getVersion_S "Ruft einen Encoder ab anhand der angegebenen Versionsnummer.") {#EncoderVersionAPI__ul_ycl_fzf_tlb} ## EncoderVersion -- getProperties() {#ariaid-title2} Ruft Eigenschaften des Encoder-Objekts und Versionsnummerab. {#EncoderV-getProperties__table_d2m_zwz_4lb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 1. Parameter] {#EncoderV-getProperties__table_d2m_zwz_4lb} {#EncoderV-getProperties__table_e2m_zwz_4lb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | Inhalt der Datensatz- und [Encoder-](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#Encoder-Encoder_O "Erstellt einen Encoder.") Details. Die Ergebnisse variieren je nach Einrichtung der Objekteigenschaften. { "algorithmConfig" : {Object}, "datasetsProperties": [Array], "domainName": "String", "isActive": "String", "label": "String", "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String", "versionNumber": "Number" } | | \.Algorithmuskonfiguration | Optional. JavaScript-Objekt, das Algorithmuskonfigurationseigenschaften enthält. 'algorithmConfig' : { "algorithm": "String" } Datentyp: Objekt. | | \.algorithmKonfiguration.algorithm | Name des Algorithmus zum Trainieren dieses Encoders. Mögliche Werte: * paravec: Texteinbettung für Absatzvektoren. * tf-idf: Begriffshäufigkeit -- Text auf Basis der inversen Dokumenthäufigkeit (TF-IDF). {#EncoderV-getProperties__ul_encoder_alg_vals} Datentyp: Zeichenfolge. | | \.datasetsProperties | Liste der [DatasetDefinition()-](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.") Eigenschaften, die dem Encoder zugeordnet sind. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Array. | | \.datasetsEigenschaften.tabellenname | Name der Tabelle für den Datensatz. Beispiel: `„tableName" : „Incident"`. Datentyp: Zeichenfolge. | | \.datasetsProperties.fieldNames | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„fieldNames" : ["short_description", "priority"]`. Datentyp: Array. | | \.datasetsProperties.fieldNames.fieldDetails | Liste von JavaScript-Objekten, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. | | \.datasetsProperties.fieldNames.fieldDetails.\.name | Name des Felds, das die Art der Informationen definiert, auf die dieser Datensatz beschränkt werden soll Datentyp: Zeichenfolge. | | \.datasetsProperties.fieldDetails.\.type | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. | | \.datasetsProperties.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. | | \.istAktiv | Kennzeichnung, die angibt, ob diese Version aktiv ist. Gültige Werte: * wahr: Version ist aktiv. * „falsch": Version ist nicht aktiv. {#EncoderV-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. | | \.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. | | \.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 {#EncoderV-getProperties__ul_pmw_523_plb}Standard: run_once Datentyp: Zeichenfolge. | | \.versionsnummer | Objekt Versionsnummer von „Encoder ". Datentyp: Zeichenfolge. | [Tabelle : 2. Ergebnisse] {#EncoderV-getProperties__table_e2m_zwz_4lb} Im folgenden Beispiel werden Eigenschaften der aktiven Objektversion im Store abgerufen. // Get properties var mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization'); gs.print(JSON.stringify(JSON.parse(mlEncoder.getActiveVersion().getProperties()), null, 2)); Ausgabe: *** Script: { "datasetsProperties": [ { "tableName": "incident", "fieldNames": [ "assignment_group", "short_description", "description" ], "encodedQuery": "activeANYTHING" } ], "domainName": "global", "isActive": "true", "label": "my encoder definition", "name": "ml_x_snc_global_global_my_encoder_definition", "processingLanguage": "en", "stopwords": [ "Default English Stopwords" ], "versionNumber": "1" } ## EncoderVersion -- getSentenceVectors(Array-Eingabe) {#ariaid-title3} Gibt Vektoren für jeden Eingabesatz zurück. {#EncoderV-getSentenceVectors_A__table_rtq_hdb_rlb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Eingabe | Array | Array von Zeichenfolgen als Sätze, aus denen Vektoren empfangen werden sollen. | [Tabelle : 3. Parameter] {#EncoderV-getSentenceVectors_A__table_rtq_hdb_rlb} {#EncoderV-getSentenceVectors_A__table_stq_hdb_rlb__entry__2} | Typ | Beschreibung | |-|-| | Zeichenfolge | Array von Satzvektoren. | [Tabelle : 4. Ergebnisse] {#EncoderV-getSentenceVectors_A__table_stq_hdb_rlb} Das folgende Beispiel zeigt, wie ein Vektor für einen einzelnen Satz zurückgegeben wird. var myEncoderName = 'GloVe'; var myEncoder = sn_ml.EncoderStore.get(myEncoderName); var input = ["I like to code."]; var vectors = myEncoder.getActiveVersion().getSentenceVectors(input); gs.print(vectors); Ausgabe: *** Script: [-0.16243751347064972,0.30614474415779114,0.08489049971103668, -0.48100000619888306,-0.170997753739357,0.08779674768447876,-0.07848624140024185,-0.15123701095581055, -0.07843250036239624,-1.9505999088287354,0.3007825016975403,-0.07804800570011139,-0.04779449850320816, 0.04803549498319626,0.09848674386739731,0.2427891194820404,-0.41138750314712524,0.10880374908447266, ... , 0.21227750182151794,0.18478751182556152,-0.3113832473754883,-0.16560424864292145,0.09052124619483948] ## EncoderVersion -- getÄhnlicheWords(Array-Eingabe, Objektoptionen) {#ariaid-title4} Gibt Wörter zurück, die jedem Eingabewort in der absteigenden Rangfolge der Ähnlichkeit ähnlich sind. {#EncoderV-getSimilarWords_A_O__table_mxj_kdb_rlb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Eingabe | Array | Array von Wörtern, für die ähnliche Wörter gefunden werden sollen. | | Optionen | Objekt | Zuordnen, um die Ergebnisse zu verfeinern. { "topN":"String" } | | Optionen.topN | Zeichenfolge | Wenn angegeben, werden die besten Ergebnisse bis zur angegebenen Anzahl zurückgegeben von Wörtern. Verwenden Sie beispielsweise `„10" `, um die 10 ähnlichsten Wörter zurückzugeben. | [Tabelle : 5. Parameter] {#EncoderV-getSimilarWords_A_O__table_mxj_kdb_rlb} {#EncoderV-getSimilarWords_A_O__table_nxj_kdb_rlb__entry__2} | Typ | Beschreibung | |-|-| | Array | Liste von Elementen, die die ähnlichen Wörter für das Eingabewort an der entsprechenden Position enthalten. Diese ähnlichen Wörter werden durch ein Array von Paaren im Format `[word, Ähnlichkeitspunktzahl]`dargestellt. | [Tabelle : 6. Ergebnisse] {#EncoderV-getSimilarWords_A_O__table_nxj_kdb_rlb} Das folgende Beispiel zeigt, wie ähnliche Wörter mit dem GliVe- Encoder abgerufen werden. var myEncoderName = 'GloVe'; var myEncoder = sn_ml.EncoderStore.get(myEncoderName); var input = ["apple"]; var options = {"topN":"5"}; gs.print(myEncoder.getActiveVersion().getSimilarWords(input, options)); Ausgabe: *** Script: [[["iphone",0.5987],["macintosh",0.5836],["ipod",0.5761],["microsoft",0.5664],["ipad",0.5628]]] ## EncoderVersion -- getStatus(Boolean IncludesDetails) {#ariaid-title5} Ruft den Status des Schulungsabschlusses ab. {#EncoderV-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. {#EncoderV-getStatus_B__ul_n33_ckw_plb} Standardwert: False | [Tabelle : 7. Parameter] {#EncoderV-getStatus_B__table_xfh_vbw_plb} {#EncoderV-getStatus_B__table_yfh_vbw_plb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | JavaScript-Objekt, das Informationen zum Schulungsstatus für enthält ein [Encoder](https://www.servicenow.com/docs/G7ohgdKHJdsFxubAhcpxJw#EncoderAPI "Die Encoder- API stellt ein skriptfähiges Objekt bereit, das in den Speichern Predictive Intelligence verwendet wird. Dieses Objekt konvertiert Eingabedaten basierend auf Encoder-spezifischen Zielen und Konfigurationen in Zahlenvektoren. Encoder können unabhängig zum Ausführen von Codierungen verwendet oder als Teil von Lösungen zum Codieren von Textspalten konfiguriert werden.") -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 {#EncoderV-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. {#EncoderV-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 : 8. Ergebnisse] {#EncoderV-getStatus_B__table_yfh_vbw_plb} Das folgende Beispiel zeigt ein erfolgreiches Ergebnis mit abgeschlossenem Training. // Get status var mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization'); gs.print(JSON.stringify(JSON.parse(mlEncoder.getActiveVersion().getStatus(true), null, 2))); Ausgabe: { "state":"solution_complete", "percentComplete":"100", "hasJobEnded":"true", "details":{"stepLabel":"Encoder Complete"} // This information is only returned if getStatus(true); } Das folgende Beispiel zeigt ein nicht erfolgreiches Ergebnis mit abgeschlossenem Training. // Get status var encoderName = 'ml_x_snc_global_global_encoder'; var mlEncoder = sn_ml.EncoderStore.get(encoderName); var trainingStatus = mlEncoder.getLatestVersion().getStatus(); gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2)); Ausgabe: { "state":"solution_error", "percentComplete":"100", "hasJobEnded":"true" } ## EncoderVersion -- getVersionNumber() {#ariaid-title6} Ruft die Versionsnummer von ab ein Lösungsobjekt. {#EncoderV-getVersionNumber__table_jsz_sbw_plb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Keine | | | [Tabelle : 9. Parameter] {#EncoderV-getVersionNumber__table_jsz_sbw_plb} {#EncoderV-getVersionNumber__table_ksz_sbw_plb__entry__2} | Typ | Beschreibung | |-|-| | Zeichenfolge | Versionsnummer. | [Tabelle : 10. Ergebnisse] {#EncoderV-getVersionNumber__table_ksz_sbw_plb} Das folgende Beispiel zeigt, wie Sie eine Versionsnummer abrufen. // Get version number var mlEncoder = sn_ml.EncoderStore.get('ml_incident_categorization'); gs.print("Version number: "+JSON.stringify(JSON.parse(mlEncoder.getActiveVersion().getVersionNumber()), null, 2)); Ausgabe: Version number: 1 ## EncoderVersion -- getWordVectors(Array-Eingabe) {#ariaid-title7} Gibt Vektoren für jedes Eingabewort zurück. {#EncoderV-getWordVectors_A__table_jtt_mdb_rlb__entry__3} | Name | Typ | Beschreibung | |-|-|-| | Eingabe | Array | Liste der Zeichenfolgen als Wörter, aus denen Vektoren empfangen werden sollen. | [Tabelle : 11. Parameter] {#EncoderV-getWordVectors_A__table_jtt_mdb_rlb} {#EncoderV-getWordVectors_A__table_ktt_mdb_rlb__entry__2} | Typ | Beschreibung | |-|-| | Array | Liste der Vektoren für jedes angegebene Wort. | [Tabelle : 12. Ergebnisse] {#EncoderV-getWordVectors_A__table_ktt_mdb_rlb} Das folgende Beispiel zeigt, wie Sie einen Vektor aus dem Wort hello abrufen. var myEncoderName = 'GloVe'; var myEncoder = sn_ml.EncoderStore.get(myEncoderName); var input = ["hello"]; gs.print(myEncoder.getActiveVersion().getWordVectors(input)); Ausgabe: *** Script: [[-0.337119996547699,-0.2169100046157837,-0.006636499892920256, -0.41624999046325684,-1.2554999589920044,-0.0284659992903471,-0.7219499945640564, -0.5288699865341187,0.0072085000574588776,0.3199700117111206,0.02942500077188015, -0.013236000202596188,0.4351100027561188,0.2571600079536438,0.3899500072002411, ... , 0.3384299874305725,0.4055800139904022,0.18073000013828278,0.6424999833106995]]