EncoderVersion – Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 5 Minuten Lesedauer

    • Skriptfähiges Objekt, das in Predictive Intelligence -Speichern verwendet wird.

    Die EncoderVersion Die API erfordert das Plugin Predictive Intelligence (com.glide.platform_ml) und wird im sn_ml- Namespace bereitgestellt.

    Diese API wird zum Arbeiten mit Encoder-Versionen verwendet, die auf Encoder-API -Objekten im Encoder-Speicherbasieren.

    Das System aktiviert die neueste Version der -Encoder , wenn das Training abgeschlossen ist, und lässt jeweils nur eine Version zu. Sie können jedoch jede zuvor trainierte Version aktivieren, die Sie für Vorhersagen verwenden möchten.

    Methoden in dieser API sind mit den folgenden Encoder- Methoden zugänglich:

    EncoderVersion – getProperties()

    Ruft Eigenschaften des Encoder-Objekts ab und Versionsnummer.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Objekt Inhalt der Datensatz- und Encoder- Details. Die Ergebnisse variieren je nach Setup 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"
}
    <Object>.algorithmConfig Optional. JavaScript-Objekt, das Eigenschaften der Algorithmuskonfiguration enthält. 
    'algorithmConfig' : {
  "algorithm": "String"
}

    Datentyp: Objekt.
    <Object>.algorithmConfig.algorithm Name des Algorithmus zum Trainieren dieses Encoders.
    Mögliche Werte:
    • paravec: Einbettung von Absatzvektorwörtern.
    • tf-idf: Bedingungshäufigkeit – Inverser Dokumenthäufigkeit (TF-IDF)-basierter Text.

    Datentyp: Zeichenfolge.
    <Object>.datasetsEigenschaften

    Liste der DatasetDefinition()- Eigenschaften, die dem Encoder zugeordnet sind.

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

    Datentyp: Array.
    <Object>.datasetsEigenschaften.tabelleName Name der Tabelle für den Datensatz. Beispiel: "tableName" : "Incident".

    Datentyp: Zeichenfolge.
    <Object>.datasetsProperties.fieldNames Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: „fieldNames“ : ["short_description", "priority"].

    Datentyp: Array.
    <Object>.datasetsEigenschaften.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>.datasetsProperties.fieldDetails.<object>.type ML-Feldtyp (maschinelles Lernen).

    Datentyp: Zeichenfolge.
    <Object>.datasetsProperties.fieldDetails.encodedQuery Codierte Abfragezeichenfolge im Standard-Glide-Format. Weitere Informationen finden Sie unter Codierte Abfragezeichenfolgen.

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

    Datentyp: Zeichenfolge.
    <Object>.ist Aktiv Kennzeichnung, die angibt, ob diese Version aktiv ist.
    Gültige Werte:
    • true: Version ist aktiv.
    • false: Version ist nicht aktiv.

    Datentyp: Zeichenfolge
    <Object>.Bezeichnung Identifiziert die Vorhersageaufgabe. 
    {
  "label": "my first prediction"
}

    Datentyp: Zeichenfolge.
    <Object>.name Vom System zugewiesener Name.

    Datentyp: Zeichenfolge.
    <Object>.predictedFieldName Identifiziert ein Feld, das für die Vorhersagbarkeit trainiert werden soll.

    Datentyp: Zeichenfolge.
    <Object>.processingLanguage Verarbeitungssprache im aus zwei Buchstaben bestehenden ISO 639-1-Sprachcodeformat.

    Datentyp: Zeichenfolge.
    <Object>.Bereich Objektumfang. Derzeit ist der einzige gültige Wert global.

    Datentyp: Zeichenfolge
    <Object>.Stoppwörter Optional. Voreingestellte Liste von Zeichenfolgen, die das System basierend auf der Eigenschaftseinstellung language automatisch generiert. Weitere Informationen finden Sie unter Benutzerdefinierte Stoppwortlisten erstellen.

    Datentyp: Array.
    <Object>.trainingHäufigkeit Die Häufigkeit, mit der das Modell neu trainiert werden soll.
    Mögliche Werte:
    • jeden_30_Tage
    • alle_60_Tage
    • all_90_days
    • all_120_days
    • all_180_days
    • run_once
    Standard: run_once

    Datentyp: Zeichenfolge.
    <Object>.Versionsnummer Versionsnummer des Encoder- Objekt.

    Datentyp: Zeichenfolge.

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

    Gibt Vektoren für jeden Eingabesatz zurück.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Eingabe Array Array von Zeichenfolgen als Sätze, aus denen Vektoren empfangen werden sollen.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Array von Satzvektoren.

    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 input, Object options)

    Gibt Wörter zurück, die jedem Eingabewort in der absteigenden Rangfolge der Ähnlichkeit ähneln.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Eingabe Array Array von Wörtern, für die ähnliche Wörter gefunden werden sollen.
    Optionen Objekt Ordnen Sie zu, um die Ergebnisse einzugrenzen. 
    { "topN":"String" }
    options.topN Zeichenfolge Wenn angegeben, werden die besten Ergebnisse bis zur angegebenen Zahl zurückgegeben von Wörtern. Verwenden Sie beispielsweise „10“ , um die 10 ähnlichsten Wörter zurückzugeben.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Array Liste der Elemente, 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 [Wort, Ähnlichkeitspunktzahl]dargestellt.

    Das folgende Beispiel zeigt, wie ähnliche Wörter mit dem Global 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 includeDetails)

    Ruft den Abschlussstatus des Trainings ab.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    includeDetails Boolean

    Kennzeichnung, die angibt, ob der Status detailszurückgegeben werden soll.

    Gültige Werte:
    • true: Zusätzliche Details zurückgeben.
    • false: Keine zusätzlichen Details zurückgeben.

    Standardwert: False
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Objekt JavaScript-Objekt, das Informationen zum Trainingsstatus für enthält ein Encoder -Objekt.
    {
  "state": "String",
  "percentComplete": "Number as a String",
  "hasJobEnded": "Boolean value as a String",
  "details": {Object}
}
    <Object>.Status Abschlussstatus des Trainings. Wenn der Trainingsauftrag einen Endstatus erreicht, verlässt der Auftrag diesen Status nicht. Wenn der Status abgeschlossen ist, wird die Eigenschaft hasJobEnded auf truefestgelegt.
    Mögliche Werte:
    • fetching_files_for_training
    • vorbereiten_daten
    • Erneut versuchen
    • solution_cancelled (Terminal)
    • solution_complete (Terminal)
    • solution_error (Terminal)
    • solution_incomplete
    • „training_request_received“
    • „training_request_timed_out “ (Terminal)
    • „training_solution“
    • wird hochgeladen
    • wait_for_training

    Datentyp: Zeichenfolge
    <Object>.hasJobEnded

    Kennzeichnung, die angibt, ob das Training abgeschlossen ist.

    Gültige Werte:
    • true: Training ist abgeschlossen.
    • false: Training ist unvollständig.

    Datentyp: Boolescher Wert als Zeichenfolge
    <Object>.percentComplete Zahl zwischen null und 100, die den Abschluss des Trainings in Prozent angibt. Wenn der Prozentsatz der Fertigstellung weniger als 100 beträgt, befindet sich die Aufgabe möglicherweise in einem Endstatus. Zum Beispiel, wenn beim Training eine Zeitüberschreitung auftritt.

    Datentyp: Zahl als Zeichenfolge
    <Object>.Details Objekt mit einer Liste zusätzlicher Schulungsdetails.

    Datentyp: Objekt

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

    Ruft die Versionsnummer von ab ein Lösungsobjekt.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Versionsnummer.

    Das folgende Beispiel zeigt, wie Sie eine Versionsnummer erhalten.

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

    Gibt Vektoren für jedes Eingabewort zurück.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Eingabe Array Liste der Zeichenfolgen als Wörter, aus denen Vektoren empfangen werden sollen.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Array Liste der Vektoren für jedes angegebene Wort.

    Das folgende Beispiel zeigt, wie ein Vektor aus dem Wort hello abgerufenwird.

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