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


---

# EncoderVersion -- Global

# EncoderVersion -- Global {#ariaid-title1}

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

Die EncoderVersion Die API stellt ein skriptfähiges Objekt bereit, 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 Encoderversionen basierend auf verwendet [Encoder-API](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#EncoderAPI "Die Encoder Die API stellt ein skriptfähiges Objekt bereit, das in verwendet wird Predictive IntelligenceSpeichert. Dieses Objekt konvertiert Eingabedaten in Zahlenvektoren basierend auf Encoder-spezifischen Zielen und Konfigurationen. Encoder können unabhängig voneinander verwendet werden, um Codierungen auszuführen, oder können als Teil von Lösungen zum Codieren von Textspalten konfiguriert werden.")Objekte in [Encoderspeicher](https://servicenow-prod.fluidtopics.net/OdVk3csoeh4kWhQPxVSopA#EncoderStoreAPI "Die EncoderStore Die API bietet Methoden zum Speichern und Abrufen von Encodern.").

Das System aktiviert die neueste Version von Encoder 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 Encoder Methoden:

* [GetActiveVersion()](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-getActiveVersion "Ruft die aktiven ab EncoderVersion-Objekt.")
* [GetAllVersions()](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-getAllVersions "Ruft alle Versionen von ab Ein Encoder.")
* [GetLatestVersion()](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-getLatestVersion "Ruft die neueste Version von ab Ein Encoder.")
* [Getversion()](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-getVersion_S "Ruft einen Encoder ab Nach angegebener Versionsnummer.")
{#EncoderVersionAPI__ul_ycl_fzf_tlb}

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

Ruft Encoder-Objekteigenschaften ab Und Versionsnummer.
{#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 des Datensatzes und [Encoder](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-Encoder_O "Erstellt einen Encoder.")Details. Die Ergebnisse variieren je nach Setup der Objekteigenschaft. { "algorithmConfig" : {Object}, "datasetsProperties": [Array], "domainName": "String", "isActive": "String", "label": "String", "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String", "versionNumber": "Number" } |
| \<Object\>.AlgorithmConfig | Optional. JavaScript-Objekt mit Algorithmuskonfigurationseigenschaften. 'algorithmConfig' : { "algorithm": "String" } Datentyp: Objekt. |
| \<Object\>.AlgorithmConfig.algorithmus | Name des Algorithmus zum Trainieren dieses Encoders. Mögliche Werte: * paravec: Worteinbettung des Absatzvektors. * tf-idf: Begriffshäufigkeit: Text auf Basis der inversen Dokumenthäufigkeit (TF-IDF). {#EncoderV-getProperties__ul_encoder_alg_vals} Datentyp: Zeichenfolge. |
| \<Object\>.DatasetsEigenschaften | Liste 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.")Eigenschaften, die dem Encoder zugeordnet sind. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } Datentyp: Array. |
| \<Object\>.DatasetsProperties.tableName | Name der Tabelle für den Datensatz. Beispiel: `„Tabellenname": „Incident" `. Datentyp: Zeichenfolge. |
| \<Object\>.DatenbasisEigenschaften.Feldnamen | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„Feldnamen": ["short_description", "Priorität"] `. Datentyp: Array. |
| \<Object\>.DatasetsProperties.fieldnames.fieldDetails | Liste der JavaScript-Objekte, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. |
| \<Object\>.DatasetsProperties.fieldnames.fieldDetails. \<object\>.Name | Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll. Datentyp: Zeichenfolge. |
| \<Object\>.DatenbasisEigenschaften.Felddetails. \<object\>.Typ | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. |
| \<Object\>.DatasetsProperties.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\>.Isaktiv | 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 |
| \<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\>.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\>.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 {#EncoderV-getProperties__ul_pmw_523_plb}Standard: Run_once Datentyp: Zeichenfolge. |
| \<Object\>.VersionNumber | Versionsnummer von Encoder Objekt. Datentyp: Zeichenfolge. |
[Tabelle : 2. Rückgaben]

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

    // 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, von 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. Rückgaben]

{#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 -- getSimilarWords (Array-Eingabe, Objektoptionen) {#ariaid-title4}

Gibt Wörter zurück, die jedem Eingabewort in der absteigenden Rangfolge der Ähnlichkeit ähneln.
{#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 Ergebnisse zu verfeinern. { "topN":"String" } |
| Optionen.TopN | Zeichenfolge | Wenn angegeben, werden die Top-Ergebnisse bis zur angegebenen Zahl zurückgegeben Von Wörtern. Verwenden Sie beispielsweise `„10" `Zum Rückgeben der Top 10 der ähnlichsten Wörter. |
[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 dargestellt `[Wort, Ähnlichkeitspunktzahl] `. |
[Tabelle : 6. Rückgaben]

{#EncoderV-getSimilarWords_A_O__table_nxj_kdb_rlb}  
Das folgende Beispiel zeigt, wie ähnliche Wörter mit abgerufen werden <kbd class="ph userinput">Handschuh </kbd>Encoder.

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

Ruft den Abschlussstatus des Trainings ab.
{#EncoderV-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. {#EncoderV-getStatus_B__ul_n33_ckw_plb} Standard: Falsch |
[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ältEin [Encoder](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#EncoderAPI "Die Encoder Die API stellt ein skriptfähiges Objekt bereit, das in verwendet wird Predictive IntelligenceSpeichert. Dieses Objekt konvertiert Eingabedaten in Zahlenvektoren basierend auf Encoder-spezifischen Zielen und Konfigurationen. Encoder können unabhängig voneinander verwendet werden, um Codierungen auszuführen, oder können 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} } |
| \<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 {#EncoderV-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. {#EncoderV-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 : 8. Rückgaben]

{#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. Rückgaben]

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

    // 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 von Zeichenfolgen als Wörter, von 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 bereitgestellte Wort. |
[Tabelle : 12. Rückgaben]

{#EncoderV-getWordVectors_A__table_ktt_mdb_rlb}  
Das folgende Beispiel zeigt, wie ein Vektor aus dem Wort abgerufen wird <kbd class="ph userinput">Hallo </kbd>.

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


