VorhersageabilitätEstimate – Global

Die VorhersageabilitätEstimate API ist ein skriptfähiges Objekt, das in verwendet wird Predictive Intelligence Speichert. Dieses Objekt bietet eine Schätzung, wie vorhersagbare Felder eines Datensatzes sein können und welche Funktionen für die Vorhersage dieser Felder nützlich sein können.

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

Der Flow „Setup-to-Training“ der Vorhersagbarkeitsschätzung lautet wie folgt:

1. Erstellen Sie einen Datensatz mit Datendefinition API.
2. Verwenden Sie Konstruktor Dient zum Erstellen eines Objekts zur Vorhersagbarkeitsschätzung.
3. Fügen Sie das Objekt „Vorhersagbarkeitsschätzung“ dem Speicher „Vorhersagbarkeitsschätzung“ mit hinzu PredictabilityEstimateStore – add() Methode.
4. Trainieren Sie die Vorhersagbarkeitsschätzung mit SubmitTrainingJob() Methode. Dadurch wird eine Version des Objekts erstellt, das Sie mit verwalten können VorhersageabilitätEstimateVersion API.
5. Rufen Sie geschätzte Vorhersagewerte mit ab PredictabilityEstimateVersion – getResults() Methode.

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 .

PredictabilityEstimate – PredictabilityEstimate (Objektkonfiguration)

Erstellt eine Vorhersagbarkeitsschätzung.

Um neue Vorhersageschätzungen für denselben Datensatz abzurufen, verwenden Sie diesen Konstruktor, um ein neues Vorhersageobjekt mit einem eindeutigen Namen zu erstellen.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Konfiguration	Objekt	JavaScript-Objekt mit Konfigurationseigenschaften von Vorhersagbarkeitsschätzung. { "dataset": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "minRowCount": "String", "predictedFieldName": "String", "trainingFrequency": "String" }
Config.Dataset	Objekt	Datendefinition Name.
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.inputFieldNames	Array	Liste der Kandidateneingabefelder als Zeichenfolgen, die bei der Schätzung berücksichtigt werden sollen.
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.predictedFeldname	Zeichenfolge	Gibt ein Feld an, das zur Vorhersagbarkeit trainiert werden soll.
Config.trainingHäufigkeit	Zeichenfolge	Optional. 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 Schätzauftrag erstellen und dem PredictabilityEstimate Store 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 ab Ein Schätzungsobjekt für Vorhersagbarkeit 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 myEstimate = sn_ml.PredictabilityEstimateStore.get('ml_sn_global_global_predictability_estimate');

myEstimate.cancelTrainingJob();

PredictabilityEstimate – getActiveVersion()

Ruft die aktiven ab VorhersageabilitätEstimateVersion Objekt.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 5. Ergebnisse

Typ	Beschreibung
Objekt	Aktiv VorhersageabilitätEstimateVersion Objekt.

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

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 Vorhersagbarkeitsschätzung.

Tabelle : 6. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 7. Ergebnisse

Typ	Beschreibung
Array	Vorhandene Versionen eines Lösungsobjekts. Siehe auch VorhersageabilitätEstimateVersion API.

Das folgende Beispiel zeigt, wie alle abgerufen werden VorhersageabilitätEstimate Versionsobjekte und rufen Sie auf GetVersionNumber() Und GetStatus() Geschätzte Versionsmethoden für sie.

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 Vorhersagbarkeitsschätzung.

Tabelle : 8. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 9. Ergebnisse

Typ	Beschreibung
Objekt	VorhersageabilitätEstimateVersion Objekt, das der neuesten Version von entspricht A VorhersageabilitätEstimate() .

Das folgende Beispiel zeigt, wie Sie die neueste Version von abrufen Eine Vorhersagbarkeitsschätzung und gibt ihren 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 Store 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 aktualisiert wird VorhersageabilitätEstimate Datensatzinformationen erstellen und den Namen des Objekts drucken.

// 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 des Datensatzes und VorhersageabilitätEstimate() Objektdetails in VorhersageabilitätEstimateStore . { "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String" }
<Object>.DatasetEigenschaften	Listet die Eigenschaften von auf Datendefinition() Objekt, 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: „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>.DatasetProperties.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>.InputFieldNames	Liste der Kandidateneingabefelder als Zeichenfolgen, die bei der Schätzung berücksichtigt werden sollen. 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>.Umfang	Objektbereich. 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: 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 Schätzungsobjekt für Vorhersagbarkeit Im Store.

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

Ruft eine Vorhersagbarkeitsschätzung ab Nach angegebener Versionsnummer.

Tabelle : 14. Parameter

Name	Typ	Beschreibung
Version	Zeichenfolge	Vorhandene Versionsnummer von Eine Vorhersagbarkeitsschätzung.

Tabelle : 15. Rückgaben

Typ	Beschreibung
Objekt	Angegebene Version von VorhersageabilitätEstimate() Objekt, mit dem Sie anrufen können VorhersageabilitätEstimateVersion API-Methoden.

Das folgende Beispiel zeigt, wie der Schulungsstatus von abgerufen wird 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(Zeichenfolgenversion)

Aktiviert eine angegebene Version einer Vorhersagbarkeitsschätzung im Store.

Tabelle : 16. Parameter

Name	Typ	Beschreibung
Version	Zeichenfolge	Name des VorhersageabilitätEstimate() 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 Eine Vorhersagbarkeitsschätzung Version im Store.

sn_ml.PredictabilityEstimate.setActiveVersion("ml_x_snc_global_global_my_estimate_definition");

PredictabilityEstimate – submitTrainingJob()

Übermittelt einen Schulungsauftrag.

Hinweis:

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

Tabelle : 18. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 19. Ergebnisse

Typ	Beschreibung
Objekt	VorhersageabilitätEstimateVersion Objekt, das dem entspricht VorhersageabilitätEstimate Wird trainiert.

Das folgende Beispiel zeigt, wie Sie einen Datensatz erstellen und auf anwenden Fügen Sie eine Vorhersagbarkeitsschätzung hinzu 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 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();