PredictabilityEstimateVersion – Global

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

    • Die PredictabilityEstimateVersion- API ist ein skriptfähiges Objekt, das in Predictive Intelligence -Speichern verwendet wird.

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

    Diese API wird für die Arbeit mit Versionen von Vorhersagbarkeitsschätzungen verwendet, die auf PredictabilityEstimate-API -Objekten im PredictabilityEstimate-Speicherbasieren.

    Das System aktiviert die neueste Version der Schätzung der Vorhersagbarkeit , 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 PredictabilityEstimate- Methoden zugänglich:

    PredictabilityEstimateVersion – getProperties()

    Ruft Eigenschaften des Objekts der Vorhersagbarkeitsschätzung ab und Versionsnummer.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Objekt Inhalt der Datensatz- und PredictabilityEstimate- Versionsdetails. Die Ergebnisse variieren je nach Setup der Objekteigenschaften.
    {
  "datasetProperties": {Object},
  "domainName": "String", 
  "inputFieldNames": [Array],
  "label": "String",
  "name": "String",
  "predictedFieldName": "String",
  "scope": "String",
  "trainingFrequency": "String",
  "versionNumber": "Number"
}
    <Object>.datasetEigenschaften

    Listet die Eigenschaften des DatasetDefinition()- Objekts auf, das der Vorhersagbarkeitsschätzung zugeordnet ist.

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

    Datentyp: Objekt.
    <Object>.datasetProperties.tableName Name der Tabelle für den Datensatz. Beispiel: "tableName" : "Incident".

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

    Datentyp: Array.
    <Object>.datasetProperties.fieldNames.fieldDetails Liste der JavaScript-Objekte, die Feldeigenschaften angeben. 
    [
  {
    "name": "String",
    "type": "String"
  }
]

    Datentyp: Array.
    <Object>.datasetProperties.fieldNames.fieldDetails.<object>.name Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll.

    Datentyp: Zeichenfolge.
    <Object>.datasetProperties.fieldDetails.<object>.type ML-Feldtyp (maschinelles Lernen).

    Datentyp: Zeichenfolge.
    <Object>.datasetProperties.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>.inputFieldNames Liste der Kandidateneingabefelder als Zeichenfolgen, die für die Schätzung berücksichtigt werden sollen.

    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>.Bereich Objektumfang. Derzeit ist der einzige gültige Wert global.

    Datentyp: Zeichenfolge
    <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 PredictabilityEstimate- Objekt.

    Datentyp: Zeichenfolge.

    Im folgenden Beispiel werden Eigenschaften der aktiven Objektversion im Store abgerufen.

    // Get properties
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getProperties()), null, 2));

    Ausgabe:

    "datasetProperties": {
    "encodedQuery": "activeANYTHING^EQ",
    "fieldNames": [
      "short_description",
      "category"
    ],
    "tableName": "incident"
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "isActive": "true",
  "label": "Incident Categorization_Trainer",
  "name": "ml_incident_categorization",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

    PredictabilityEstimateVersion – getResults()

    Gibt JSON-Ergebnisse zurück, die vorgeschlagene Eingabefelder für ein Ausgabefeld enthalten.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt JSON-Objektergebnisse, die vorgeschlagene Eingabefeldoptionen für ein Ausgabefeld enthalten.
    <Object>an.<output field name> Name des Ausgabefelds, z. B. Kategorie, das vorgeschlagene Eingabefelder enthält.
    {
  "<output field name>": {
    "nominalInputFields": [Array],
    "textInputFields": [Array]
  }
}

    Datentyp: Objekt
    <Object><output field name>.nominalInputFields Details zum Nominal-Eingabefeld.
    "nominalInputFields": [
      {
        "fieldName": "String",
        "modelImprovement": "String"     
      }
    ]

    Datentyp: Array.
    <Object><output field name>.nominalInputFields.fieldName Name des nominellen Eingabefelds.

    Datentyp: Zeichenfolge.
    <Object><output field name>.nominalInputFields.modelImprovement Punktzahl als relative Angabe, wie wahrscheinlich es ist, dass dieses Feld die Ergebnisse verbessert.

    Datentyp: Zahl als Zeichenfolge.
    <Object>.textInputFields Details zum Texteingabefeld.
    
    "textInputFields": [
      {
        "fieldName": "String",
        "density": "String"
      }
    ]

    Datentyp: Array.
    <Object>.textInputFields.fieldName Name des Texteingabefelds.

    Datentyp: Zeichenfolge.
    <Object>.textEingabeFelder.Dichte Wert zwischen 0 und 1,0, der die Häufigkeit angibt, mit der das Feld nicht leer ist. Ein Wert von 1,0 bedeutet, dass das Feld nicht in allen Zeilen leer ist, und ein Wert von 0 gibt an, dass das Feld in allen Zeilen leer ist.

    Datentyp: Zahl als Zeichenfolge.

    Das folgende Beispiel zeigt, wie Ergebnisse für eine ausgewählte Version einer Vorhersagbarkeitsschätzung im Store abgerufen werden.

    // Get results
var estimateName = "ml_x_snc_global_global_predictability_estimate;"
var mlEstimate = sn_ml.PredictabilityEstimateStore.get(estimateName);

var results = mlEstimate.getActiveVersion().getResults();

gs.print(JSON.stringify(JSON.parse(results), null, 2));

    Ausgabe:

    {
  "category": {
    "nominalInputFields": [
      {
        "fieldName": "number",
        "modelImprovement": "0.167052396325189"
      },
      {
        "fieldName": "task_effective_number",
        "modelImprovement": "0.167052396325189"
      }
    ],
    "textInputFields": [
      {
        "fieldName": "short_description",
        "density": "1.0"
      }
    ]
  }
}

    PredictabilityEstimateVersion – getStatus(Boolean includeDetails)

    Ruft den Abschlussstatus des Trainings ab.

    Tabelle : 5. 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 : 6. Ergebnisse
    Typ Beschreibung
    Objekt JavaScript-Objekt, das Informationen zum Trainingsstatus für enthält ein PredictabilityEstimate- 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 mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlEstimate.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 mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_my_estimate_definition');
var trainingStatus = mlEstimate.getLatestVersion().getStatus();

gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));

    Ausgabe:

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

    PredictabilityEstimateVersion – getVersionNumber()

    Ruft die Versionsnummer von ab Objekt einer Vorhersagbarkeitsschätzung.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Versionsnummer.

    Das folgende Beispiel zeigt, wie Sie eine Versionsnummer erhalten.

    // Get version number
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

gs.print("Version number: "+JSON.stringify(JSON.parse(mlEstimate.getActiveVersion().getVersionNumber()), null, 2));

    Ausgabe:

    Version number: 1