PredictabilityEstimateVersion : Global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 4 Minuten Lesedauer

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

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

    Verwenden Sie diese API, wenn Sie mit Versionen der Vorhersagbarkeitsschätzung basierend auf PredictabilityEstimate-API -Objekten im PredictabilityEstimate-Store arbeiten.

    Das System aktiviert die neueste Version der Schätzung der Vorhersagbarkeit , wenn das Training abgeschlossen wird. Es kann jeweils nur eine Version aktiv sein. Sie können jedoch jede zuvor trainierte Version aktivieren, die Sie verwenden möchten, um Vorhersagen zu treffen.

    Auf die Methoden in dieser API kann mit den folgenden PredictabilityEstimate- Methoden zugegriffen werden:

    PredictabilityEstimateVersion – getProperties()

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

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

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

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

    Datentyp: Objekt.
    <Object>.datensatzEigenschaften.tabellenname 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 von JavaScript-Objekten, die Feldeigenschaften angeben. 
    [
  {
    "name": "String",
    "type": "String"
  }
]

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

    Datentyp: Zeichenfolge.
    <Object>.datasetProperties.fieldDetails.<object>.type 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 Domain Separation und Predictive Intelligence.

    Datentyp: Zeichenfolge.
    <Object>.eingabeFeldNamen Liste der Kandidateneingabefelder als Zeichenfolgen, die für die Schätzung berücksichtigt werden sollen.

    Datentyp: Zeichenfolge.
    <Object>.istAktiv Kennzeichnung, die angibt, ob diese Version aktiv ist.
    Gültige Werte:
    • wahr: Version ist aktiv.
    • „falsch“: Version ist nicht aktiv.

    Datentyp: Zeichenfolge
    <Object>.label 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 für die Vorhersagbarkeit trainiert werden soll.

    Datentyp: Zeichenfolge.
    <Object>.scope Objektbereich. Derzeit ist globalder einzige gültige Wert.

    Datentyp: Zeichenfolge
    <Object>.trainingFrequency Die Häufigkeit, mit der das Modell neu trainiert werden soll.
    Mögliche Werte:
    • jeden_30_Tage
    • jeden_60_Tage
    • jeden_90_Tage
    • jeden_120_Tage
    • jeden_180_Tage
    • run_once
    Standard: run_once

    Datentyp: Zeichenfolge.
    <Object>.versionsnummer Versionsnummer von 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>.<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 des Nominal-Eingabefelds.
    "nominalInputFields": [
      {
        "fieldName": "String",
        "modelImprovement": "String"     
      }
    ]

    Datentyp: Array.
    <Object>.<output field name>.nominalInputFields.fieldName Nominaler Eingabefeldname.

    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 des Texteingabefelds.
    
    "textInputFields": [
      {
        "fieldName": "String",
        "density": "String"
      }
    ]

    Datentyp: Array.
    <Object>.textEingabeFelder.Feldname Name des Texteingabefelds.

    Datentyp: Zeichenfolge.
    <Object>.textInputFields.density Wert zwischen 0 und 1,0, der die Häufigkeit darstellt, 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 Sie Ergebnisse für eine ausgewählte Version einer Vorhersagbarkeitsschätzung im Store abrufen.

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

    Ruft den Status des Schulungsabschlusses ab.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    IncludeDetails Boolean Kennzeichnung, die angibt, ob der Status detailszurückgegeben werden soll.
    Gültige Werte:
    • „wahr“: Zusätzliche Details zurückgeben.
    • „falsch“: Es werden keine zusätzlichen Details zurückgegeben.

    Standardwert: False
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Objekt JavaScript-Objekt, das Informationen zum Schulungsstatus für enthält ein PredictabilityEstimate- Objekt.
    {
  "state": "String",
  "percentComplete": "Number as a String",
  "hasJobEnded": "Boolean value as a String",
  "details": {Object}
}
    <Object>.state Abschlussstatus des Trainings. Wenn der Trainingsauftrag einen Terminalstatus erreicht, verlässt er diesen Zustand nicht. Bei einem Status im Terminal-Bereich wird die Eigenschaft hasJobEnded auf truefestgelegt.
    Mögliche Werte:
    • fetching_files_for_training
    • präparieren_daten
    • Erneut versuchen
    • solution_cancelled (Terminal)
    • solution_complete (Terminal)
    • solution_error (Terminal)
    • solution_incomplete
    • „training_request_received“
    • „training_request_timed_out “ (Terminal)
    • „training_solution“
    • „uploading_solution“
    • warten_für_Training

    Datentyp: Zeichenfolge
    <Object>.hatAuftragBeendet Kennzeichnung, die angibt, ob das Training abgeschlossen ist.
    Gültige Werte:
    • „wahr“: Das Training ist abgeschlossen.
    • „falsch“: Das Training ist unvollständig.

    Datentyp: Boolescher Wert als Zeichenfolge
    <Object>.percentComplete Schulungsfortschritt abgeschlossen. Wenn der Prozentsatz der Fertigstellung kleiner als 100 ist, befindet sich der Auftrag möglicherweise in einem Terminalstatus. Zum Beispiel, wenn das Training abläuft.

    Datentyp: Zahl als Zeichenfolge

    Bereich: 0 bis 100
    <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 ein Objekt für die Vorhersagbarkeitsschätzung.

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

    Das folgende Beispiel zeigt, wie Sie eine Versionsnummer abrufen.

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