Encoder – Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 7 Minuten Lesedauer

    • Die Encoder Die API stellt ein skriptfähiges Objekt bereit, das in verwendet wird Predictive Intelligence Speichert. 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.

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

    Encoder sind Textverarbeitungsobjekte, die entweder vortrainiert oder basierend auf den von Ihnen bereitgestellten Sprachdatensätzen trainiert werden. Sie können Encoder trainieren, die bestimmen, wie das System Textfelder interpretiert und verarbeitet. Für ML-Lösungen, die Text enthalten, können Sie einen Encoder trainieren, um anzugeben, wie Text verarbeitet und der trainierte Encoder in einer Lösung verwendet werden soll.

    Encoder verfügen über Konfiguration und Versionen und können unabhängig mit ihrer eigenen Wiederholungshäufigkeit trainiert werden. API-definierte Encoder unterscheiden sich von UI-definierten Encodern, da das erneute Trainieren von UI-definierten Encodern von den Lösungen gesteuert wird, die sie verwenden.

    Der Flow „Encoder-Setup-to-Training“ lautet wie folgt:
    1. Erstellen Sie einen oder mehrere Datensätze mit Datendefinition API.
    2. Verwenden Sie Konstruktor Dient zum Erstellen eines Encoderobjekts.
    3. Fügen Sie das Encoderobjekt dem Encoderspeicher mit hinzu EncoderStore – add() Methode.
    4. Codierer mit trainieren SubmitTrainingJob() Methode. Dadurch wird eine Version des Objekts erstellt, das Sie mit verwalten können EncoderVersion API.
    Sobald Sie einen Encoder trainiert haben, können Sie ihn in einem Lösungsobjekt verwenden:
    Hinweis:
    Diese API wird ausgeführt Mit vollständigen Berechtigungen vor dem Vancouver Patch 7 Hotfix 2b und Washington DC Patch 7-Releases. Gewähren Sie in späteren Releases Zugriff mithilfe von ACLs. Weitere Informationen finden Sie unter Query ACLs.

    Nutzungsrichtlinien finden Sie unter Mit ML APIs .

    Encoder – Encoder (Objektkonfiguration)

    Erstellt einen Encoder.

    Um einen Encoder für einen oder mehrere Datensätze abzurufen, verwenden Sie diesen Konstruktor, um ein neues Encoderobjekt mit einem eindeutigen Namen zu erstellen.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Konfiguration Objekt JavaScript-Objekt mit Konfigurationseigenschaften von Encoder.
    {
  "algorithmConfig": {Object},
  "datasets": [Array],
  "domainName": "String",
  "label": "String",
  "minRowCount": "String",
  "processingLanguage": "String",
  "stopwords": [Array],
  "trainingFrequency": "String"
}
    Config.algorithmKonfig Objekt Optional. JavaScript-Objekt mit Algorithmuskonfigurationseigenschaften. 
    'algorithmConfig' : {
  "algorithm": "String"
}
    Config.algorithmConfig.algorithmus Zeichenfolge Name des Algorithmus zum Trainieren dieses Encoders.
    Mögliche Werte:
    • paravec: Einbettung von Absatzvektorwörtern.
    • tf-idf: Begriffshäufigkeit: Text auf Basis der Inverse Document Frequency (TF-IDF).
    Config.Datasets Array Liste von Datendefinition Objektnamen.
    Config.Domänenname Zeichenfolge Optional. Domänenname, der diesem Datensatz zugeordnet ist. Siehe Domänentrennung und Predictive Intelligence.

    Standard: Aktuelle Domäne, z. B. „Global“ .
    Config.label Zeichenfolge Gibt die Vorhersageaufgabe an.
    Config.minRowCount Zeichenfolge Optional. Mindestanzahl der Datensätze, die im Datensatz für das Training erforderlich sind.

    Standard: 10000
    config.processingLanguage Zeichenfolge Optional. Sprache wird im zweistelligen ISO 639-1-Sprachcodeformat verarbeitet.

    Standard: „en“
    Config.Stoppwörter Array Optional. Voreingestellte Liste von Zeichenfolgen, die das System automatisch basierend auf generiert languageEigenschaftseinstellung. Weitere Informationen finden Sie unter Erstellen Sie eine anwenderdefinierte Stoppwortliste .

    Standard: Englische Stoppwörter
    Config.trainingHäufigkeit Zeichenfolge Die Häufigkeit, mit der das Modell neu trainiert werden soll.
    Mögliche Werte:
    • Every_30_days
    • Every_60_days
    • Every_90_days
    • Every_120_days
    • Every_180_days
    • run_once
    Standard: Run_once

    Das folgende Beispiel zeigt, wie Sie einen Encoderauftrag erstellen und dem Encoderspeicher hinzufügen.

    var myPrbData = new sn_ml.DatasetDefinition({
    'tableName' : 'problem',
    'fieldNames' : ['short_description'],
    'encodedQuery' : 'activeANYTHING'
});

var myIncidentData = new sn_ml.DatasetDefinition({
    'tableName' : 'incident',
    'fieldNames' : ['short_description', 'description'],
    'encodedQuery' : 'activeANYTHING'
});

var myEncoder = new sn_ml.Encoder({
    'label': "encoder",
    'datasets' : [myPrbData, myIncidentData],
    'algorithmConfig' : {
        'algorithm' : 'tf-idf'
    }
});
var myEncoderName = sn_ml.EncoderStore.add(myEncoder);

    Encoder – cancelTrainingJob()

    Bricht einen Auftrag für ab Ein Encoderobjekt Das zum Training übermittelt wurde.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie einen vorhandenen Schulungsauftrag abbrechen.

    var myEncoder = sn_ml.EncoderStore.get('ml_sn_global_global_encoder');

myEncoder.cancelTrainingJob();

    Encoder – getActiveVersion()

    Ruft die aktiven ab EncoderVersion-Objekt.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Objekt Aktiv EncoderVersion Objekt.

    Das folgende Beispiel zeigt, wie Sie einen aktiven erhalten Encoder Version aus dem Store und gibt den Schulungsstatus zurück. 

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

gs.print(JSON.stringify(JSON.parse(mlEncoder.getActiveVersion().getStatus()), null, 2));

    Ausgabe:

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

    Encoder – getAllVersions()

    Ruft alle Versionen von ab Ein Encoder.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Array Vorhandene Versionen eines Encoderobjekts. Siehe auch EncoderVersion API.

    Das folgende Beispiel zeigt, wie alle abgerufen werden Encoder Versionsobjekte und rufen Sie auf GetVersionNumber() Und GetStatus() Encoderversionsmethoden für sie.

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

var mlEncoderVersions = mlEncoder.getAllVersions();

for (i = 0; i < mlEncoderVersions.length; i++) {
gs.print("Version " + mlEncoderVersions[i].getVersionNumber() + " Status: " + mlEncoderVersions[i].getStatus() +"\n");
};

    Ausgabe:

    Version 3 Status: {"state":"encoder_complete","percentComplete":"100","hasJobEnded":"true"}

Version 2 Status: {"state":"encoder_complete","percentComplete":"100","hasJobEnded":"true"}

Version 1 Status: {"state":"encoder_cancelled","percentComplete":"0","hasJobEnded":"true"}

    Encoder – getLatestVersion()

    Ruft die neueste Version von ab Ein Encoder.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Objekt EncoderVersion Objekt, das der neuesten Version von entspricht Ein Encoder() .

    Das folgende Beispiel zeigt, wie Sie die neueste Version von abrufen Ein Encoder und gibt seinen Trainingsstatus zurück.

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

gs.print(JSON.stringify(JSON.parse(mlEncoder.getLatestVersion().getStatus()), null, 2));

    Ausgabe:

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

    Encoder – getName()

    Ruft den Namen des Objekts ab, das für die Interaktion mit dem Store verwendet werden soll.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name des Encoderobjekts.

    Das folgende Beispiel zeigt, wie aktualisiert wird Encoder Datensatzinformationen erstellen und den Namen des Objekts drucken. 

    // Update encoder
var myIncidentData = new sn_ml.DatasetDefinition({
   'tableName' : 'incident',
   'fieldNames' : ['category', 'short_description', 'priority'],
   'encodedQuery' : 'activeANYTHING'
});

var eligibleFields = JSON.parse(myIncidentData.getEligibleFields(encoder));

var myEncoder = new sn_ml.Encoder({
   'label': "my encoder",
   'datasets' : [myIncidentData],
   'inputFieldNames': eligibleFields['eligibleInputFieldNames'],
   'predictedFieldName': 'category'
});

// update encoder
sn_ml.EncoderStore.update('ml_x_snc_global_global_my_definition_4', myEncoder);

// print encoder name
gs.print('Encoder Name: '+myEncoder.getName());

    Ausgabe:

    Encoder Name: ml_x_snc_global_global_my_definition_4

    Encoder – getProperties()

    Ruft Lösungsobjekteigenschaften ab.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    Objekt Inhalt des Datensatzes und Encoder() Objektdetails in EncoderStore .
    {
  "algorithmConfig" : {Object},
  "datasetsProperties": [Array],
  "domainName": "String",
  "label": "String",
  "name": "String",
  "processingLanguage": "String",
  "scope": "String",
  "stopwords": [Array],
  "trainingFrequency": "String"
}
    <Object>.AlgorithmConfig.Algorithmus Name des Algorithmus zum Trainieren dieses Encoders.
    Mögliche Werte:
    • paravec: Einbettung von Absatzvektorwörtern.
    • tf-idf: Begriffshäufigkeit: Text auf Basis der Inverse Document Frequency (TF-IDF).

    Datentyp: Zeichenfolge.
    <Object>.AlgorithmConfig Optional. JavaScript-Objekt mit Algorithmuskonfigurationseigenschaften. 
    'algorithmConfig' : {
  "algorithm": "String"
}

    Datentyp: Objekt.
    <Object>.DatenbasisEigenschaften

    Liste von Datendefinition() Eigenschaften, die dem Encoder zugeordnet sind.

    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}

    Datentyp: Array.
    <Object>.DatenbasisEigenschaften.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>.DatenbasisEigenschaften.Feldnamen.Felddetails Liste der JavaScript-Objekte, die Feldeigenschaften angeben. 
    [
  {
    "name": "String",
    "type": "String"
  }
]

    Datentyp: Array.
    <Object>.DatenbasisEigenschaften.Feldnamen.Felddetails. <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 .

    Datentyp: Zeichenfolge.
    <Object>.Domänenname Domänenname, der diesem Datensatz zugeordnet ist. Siehe Domänentrennung und Predictive Intelligence.

    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 zur Vorhersagbarkeit 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 .

    Datentyp: Array.
    <Object>.TrainingHäufigkeit Die Häufigkeit, mit der das Modell neu trainiert werden soll.
    Mögliche Werte:
    • Every_30_days
    • Every_60_days
    • Every_90_days
    • Every_120_days
    • Every_180_days
    • run_once
    Standard: Run_once

    Datentyp: Zeichenfolge.

    Das folgende Beispiel ruft Eigenschaften von ab Ein Encoderobjekt Im Store. 

    var myEncoder = sn_ml.EncoderStore.get('ml_sn_global_global_encoder');

gs.print(JSON.stringify(JSON.parse(myEncoder.getProperties()), null, 2));
    Ausgabe:
    *** Script: {
  "datasetsProperties": [
    {
      "tableName": "incident",
      "fieldNames": [
        "assignment_group",
        "short_description",
        "description"
      ],
      "encodedQuery": "activeANYTHING"
    }
  ],
  "domainName": "global",
  "label": "my encoder definition",
  "name": "ml_x_snc_global_global_my_encoder_definition",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "trainingFrequency": "run_once"
}

    Encoder – getVersion(Zeichenfolgenversion)

    Ruft einen Encoder ab Nach angegebener Versionsnummer.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Version Zeichenfolge Vorhandene Versionsnummer von Ein Encoder.
    Tabelle : 15. Rückgaben
    Typ Beschreibung
    Objekt Angegebene Version von Encoder() Objekt, mit dem Sie anrufen können EncoderVersion API-Methoden.

    Das folgende Beispiel zeigt, wie der Schulungsstatus von abgerufen wird Ein Encoder nach Versionsnummer.

    var mlEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

gs.print(JSON.stringify(JSON.parse(mlEncoder.getVersion('1').getStatus()), null, 2));

    Ausgabe:

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

    Encoder – setActiveVersion(Zeichenfolgenversion)

    Aktiviert eine angegebene Version eines Encoders im Speicher.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    Version Zeichenfolge Name des Encoder() Zu aktivierende Objektversion.

    Durch Aktivieren dieser Version wird jede andere Version deaktiviert.
    Tabelle : 17. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie aktivieren Ein Encoder Version im Store. 

    sn_ml.Encoder.setActiveVersion("ml_incident_categorization");

    Encoder – submitTrainingJob()

    Übermittelt einen Schulungsauftrag.

    Hinweis:
    Bevor Sie diese Methode ausführen, müssen Sie dem Speicher zuerst mithilfe von einen Encoder hinzufügen EncoderStore – add() Methode.
    Tabelle : 18. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 19. Ergebnisse
    Typ Beschreibung
    Objekt EncoderVersion Objekt, das dem entspricht Encoder Wird trainiert.

    Das folgende Beispiel zeigt, wie Sie einen Datensatz erstellen und auf anwenden Einen Encoder hinzufügen An einen Store und übermitteln Sie den Schulungsauftrag. 

    // Create a dataset 
var myData = new sn_ml.DatasetDefinition({

  'tableName' : 'incident',
  'fieldNames' : ['assignment_group', 'short_description', 'description'],
  'encodedQuery' : 'activeANYTHING'

});

// Create an encoder 
var myEncoder = new sn_ml.Encoder({

  'label': "my encoder definition",
  'datasets' : [myData],
  'predictedFieldName' : 'assignment_group',
  'inputFieldNames':['short_description']

});

// Add the encoder to the store to later be able to retrieve it.
var my_unique_name = sn_ml.EncoderStore.add(myEncoder);

// Train the encoder - this is a long running job 
var myEncoderVersion = myEncoder.submitTrainingJob();