PredictabilityEstimate – Global

Die PredictabilityEstimate- API ist ein skriptfähiges Objekt, das in Speichern von Predictive Intelligence verwendet wird. Dieses Objekt schätzt, wie vorhersehbar Felder eines Datensatzes sein können und welche Funktionen für die Vorhersage dieser Felder nützlich sein können.

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

Der Setup-zu-Training-Flow der Vorhersagbarkeitsschätzung lautet wie folgt:

1. Erstellen Sie einen Datensatz mit der DatasetDefinition- API.
2. Verwenden Sie den Konstruktor, um ein Objekt für die Vorhersagbarkeitsschätzung zu erstellen.
3. Fügen Sie das Objekt der Vorhersagbarkeitsschätzung dem Speicher der Vorhersagbarkeitsschätzung mit der Methode PredictabilityEstimateStore – add() hinzu.
4. Trainieren Sie die Vorhersagbarkeitsschätzung mit der Methode „submitTrainingJob() “. Dadurch wird eine Version des Objekts erstellt, die Sie mit der PredictabilityEstimateVersion- API verwalten können.
5. Rufen Sie geschätzte Vorhersagewerte mit der Methode PredictabilityEstimateVersion – getResults() ab.

Hinweis:

Diese API führt mit vollständigen Berechtigungen aus. Um den Benutzerzugriff einzuschränken, fügen Sie einen Zugriffskontrollmechanismus in das Skript ein.

Richtlinien zur Verwendung finden Sie unter ML-APIsverwenden.

PredictabilityEstimate – PredictabilityEstimate(Object config)

Erstellt eine Vorhersagbarkeitsschätzung.

Um neue Vorhersagbarkeitsschätzungen für denselben Datensatz zu erhalten, verwenden Sie diesen Konstruktor, um ein neues PredictabilityEstimate-Objekt mit einem eindeutigen Namen zu erstellen.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Konfiguration	Objekt	JavaScript-Objekt, das Konfigurationseigenschaften des enthält Schätzung der Vorhersagbarkeit. { "dataset": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "minRowCount": "String", "predictedFieldName": "String", "trainingFrequency": "String" }
config.dataset	Objekt	Nameder Datensatzdefinition.
config.domainName	Zeichenfolge	Optional. Domänenname, der diesem Datensatz zugeordnet ist. Siehe Domänentrennung und Predictive Intelligence. Standard: Aktuelle Domäne, z. B. „global“.
config.inputFieldNames	Array	Liste der Kandidateneingabefelder als Zeichenfolgen, die für die Schätzung berücksichtigt werden sollen.
config.label	Zeichenfolge	Identifiziert die Vorhersageaufgabe.
config.minRowCount	Zeichenfolge	Optional. Mindestanzahl von Datensätzen, die im Datensatz für das Training erforderlich sind. Standard: 10.000
config.predictedFieldName	Zeichenfolge	Identifiziert ein Feld, das für die Vorhersagbarkeit trainiert werden soll.
config.trainingHäufigkeit	Zeichenfolge	Optional. 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

Das folgende Beispiel zeigt, wie Sie eine Schätzungsaufgabe erstellen und dem PredictabilityEstimate-Speicher hinzufügen.

var myIncidentData = new sn_ml.DatasetDefinition({
  'tableName' : 'incident',
  'encodedQuery' : 'activeANYTHING'
});

var myEstimate = new sn_ml.PredictabilityEstimate({
  'label': "predictability estimate",
  'dataset' : myIncidentData,
  'inputFieldNames':['short_description'], 
  'predictedFieldName': 'category'
});

var myEstimateName = sn_ml.PredictabilityEstimateStore.add(myEstimate);

PredictabilityEstimate – cancelTrainingJob()

Bricht einen Auftrag für Objekt einer Vorhersagbarkeitsschätzung , das zum Trainieren übermittelt wurde.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 3. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie ein vorhandener Trainingsauftrag abgebrochen wird.

var myEstimate = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

myEstimate.cancelTrainingJob();

PredictabilityEstimate – getActiveVersion()

Ruft den aktiven ab PredictabilityEstimateVersion- Objekt.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 5. Ergebnisse

Typ	Beschreibung
Objekt	Aktives PredictabilityEstimateVersion- Objekt.

Das folgende Beispiel zeigt, wie Sie eine aktive PredictabilityEstimate Version aus dem Store abrufen und ihren Trainingsstatus zurückgeben.

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

Ausgabe:

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

PredictabilityEstimate – getAllVersions()

Ruft alle Versionen von ab eine Schätzung der Vorhersagbarkeit.

Tabelle : 6. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 7. Ergebnisse

Typ	Beschreibung
Array	Vorhandene Versionen eines Lösungsobjekts. Siehe auch PredictabilityEstimateVersion- API.

Das folgende Beispiel zeigt, wie alle PredictabilityEstimate -Versionsobjekte abgerufen und die Methoden getVersionNumber() und getStatus() für die Schätzung der Version aufgerufen werden.

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

var mlEstimateVersions = mlEstimate.getAllVersions();

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

Ausgabe:

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

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

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

PredictabilityEstimate – getLatestVersion()

Ruft die neueste Version von ab eine Schätzung der Vorhersagbarkeit.

Tabelle : 8. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 9. Ergebnisse

Typ	Beschreibung
Objekt	PredictabilityEstimateVersion Objekt, das der neuesten Version von entspricht eine PredictabilityEstimate().

Das folgende Beispiel zeigt, wie Sie die neueste Version eine Vorhersagbarkeitsschätzung und gibt den Trainingsstatus zurück.

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

Ausgabe:

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

PredictabilityEstimate – getName()

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

Tabelle : 10. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 11. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Name des Schätzungsobjekts.

Das folgende Beispiel zeigt, wie PredictabilityEstimate Datensatzinformationen aktualisiert und der Name des Objekts gedruckt wird.

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

var myEstimate = new sn_ml.PredictabilityEstimate({
   'label': "my estimate",
   'dataset' : myIncidentData,
   'inputFieldNames':['short_description'],
   'predictedFieldName': 'category'
});

// update estimate
sn_ml.PredictabilityEstimateStore.update('ml_x_snc_global_global_my_definition_4', myEstimate);

// print estimate name
gs.print('Estimate Name: '+myEstimate.getName());

Ausgabe:

Estimate Name: ml_x_snc_global_global_my_definition_4

PredictabilityEstimate – getProperties()

Ruft Objekteigenschaften der Vorhersagbarkeitsschätzung ab.

Tabelle : 12. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 13. Ergebnisse

Typ	Beschreibung
Objekt	Inhalt der Objektdetails „Datensatz“ und „PredictabilityEstimate()“ im PredictabilityEstimateStore. { "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String" }
<Object>.datasetEigenschaften	Listet die Eigenschaften des DatasetDefinition()- Objekts auf, das der Schätzung zugeordnet ist. { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }
<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>.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.

Im folgenden Beispiel werden Eigenschaften Objekt einer Vorhersagbarkeitsschätzung im Store abgerufen.

var mySolution = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

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

Ausgabe:

*** Script: {
  "datasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "category",
      "short_description",
      "priority",
      "assignment_group.name"
    ],
    "fieldDetails": [
      {
        "name": "category",
        "type": "nominal"
      },
      {
        "name": "short_description",
        "type": "text"
      }
    ]
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "label": "my estimate definition",
  "name": "ml_x_snc_global_global_my_definition_26",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "trainingFrequency": "run_once"
}

PredictabilityEstimate – getVersion(String version)

Ruft eine Schätzung der Vorhersagbarkeit ab nach angegebener Versionsnummer.

Tabelle : 14. Parameter

Name	Typ	Beschreibung
Version	Zeichenfolge	Vorhandene Versionsnummer eine Schätzung der Vorhersagbarkeit.

Tabelle : 15. Ergebnisse

Typ	Beschreibung
Objekt	Angegebene Version des PredictabilityEstimate()- Objekts, für das Sie PredictabilityEstimateVersion -API-Methoden aufrufen können.

Das folgende Beispiel zeigt, wie der Trainingsstatus eine Vorhersagbarkeitsschätzung nach Versionsnummer.

var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

Ausgabe:

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

PredictabilityEstimate – setActiveVersion(String version)

Aktiviert eine angegebene Version einer Vorhersagbarkeitsschätzung im Store.

Tabelle : 16. Parameter

Name	Typ	Beschreibung
Version	Zeichenfolge	Name der zu aktivierenden PredictabilityEstimate()- Objektversion. Durch die Aktivierung dieser Version werden alle anderen Versionen deaktiviert.

Tabelle : 17. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie eine Schätzung der Vorhersagbarkeit im Store aktiviert wird.

sn_ml.PredictabilityEstimate.setActiveVersion("ml_x_snc_global_global_my_estimate_definition");

PredictabilityEstimate – submitTrainingJob()

Sendet einen Trainingsauftrag.

Hinweis:

Bevor Sie diese Methode ausführen, müssen Sie dem Speicher zuerst eine Vorhersagbarkeitsschätzung mit der Methode PredictabilityEstimateStore – add() hinzufügen.

Tabelle : 18. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 19. Ergebnisse

Typ	Beschreibung
Objekt	PredictabilityEstimateVersion Objekt, das PredictabilityEstimate dem trainierten entspricht.

Das folgende Beispiel zeigt, wie Sie einen Datensatz erstellen, auf eine Lösung anwenden eine Vorhersagbarkeitsschätzung, fügen Sie sie hinzu einem Speicher hinzufügen und den Trainingsauftrag übermitteln.

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

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

});

// Create an estimate 
var myEstimate = new sn_ml.PredictabilityEstimate({

  'label': "my estimate definition",
  'dataset' : myData,
  'predictedFieldName' : 'assignment_group',
  'inputFieldNames':['short_description']

});

// Add the estimate to the store to later be able to retrieve it.
var my_unique_name = sn_ml.PredictabilityEstimateStore.add(myEstimate);

// Train the estimate - this is a long running job 
var myEstimateVersion = myEstimate.submitTrainingJob();