RegressionSolutionVersion : Global

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

    • Die RegressionSolutionVersion- API ist ein skriptfähiges Objekt, das in den Speichern 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 Lösungsversionen arbeiten, die auf RegressionSolution-API -Objekten im RegressionSolution-Speicherbasieren.

    Das System erstellt bei jedem Training einer Lösungsdefinition eine Lösungsversion. Die meisten Versionen werden während des geplanten Lösungstrainings erstellt.

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

    RegressionSolutionVersion – getProperties()

    Ruft Lösungsobjekteigenschaften ab und Versionsnummer.

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

    Listet die Eigenschaften des DatasetDefinition()- Objekts auf, das der Lösung zugeordnet ist.

    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}
    <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>.Encoder Encoder-Objekt, das dieser Lösung zugewiesen ist. Siehe Encoder: Encoder (Objektkonfiguration).

    Datentyp: Objekt.
    <Object>.eingabeFeldNamen Liste der Eingabefeldnamen als Zeichenfolgen. Das Modell verwendet diese Felder, um Vorhersagen zu treffen.

    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>.predictedInterval Wertebereich, der das Konfidenzniveau der Vorhersage angibt.

    Datentyp: Array
    <Object>.processingLanguage Verarbeitungssprache im zweibuchstabigen ISO 639-1-Sprachcodeformat.

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

    Datentyp: Zeichenfolge
    <Object>.Stoppwörter Optional. Voreingestellte Liste von Zeichenfolgen, die das System basierend auf der Einstellung der Eigenschaft language automatisch generiert. Einzelheiten hierzu finden Sie unter Anwenderdefinierte Stoppwortliste erstellen.

    Datentyp: Array.
    <Object>.versionsnummer Versionsnummer von RegressionSolution- Objekt.

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

    // Get properties
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

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

    Ausgabe:

    {
  "datasetProperties": {
    "encodedQuery": "",
    "fieldNames": [
      "short_description",
      "sourcedc",
      "targetdc",
      "dbsize",
      "duration"
    ],
    "tableName": "cloudinfratext"
  },
  "domainName": "global",
  "encoderProperties": {
    "datasetsProperties": [],
    "name": "wc_regression"
  },
  "inputFieldNames": [
    "short_description",
    "sourcedc",
    "targetdc",
    "dbsize"
  ],
  "isActive": "true",
  "label": "Regression Test for DB Restore",
  "name": "ml_x_snc_global_global_regression",
  "predictedFieldName": "duration",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

    RegressionSolutionVersion – getStatus(Boolean IncludesDetails)

    Ruft den Status des Schulungsabschlusses ab.

    Tabelle : 3. 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 : 4. Ergebnisse
    Typ Beschreibung
    Objekt JavaScript-Objekt, das Informationen zum Schulungsstatus für enthält ein RegressionSolution- 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 mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.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 solutionName = 'ml_x_snc_global_global_regression_solution';
var mlSolution = sn_ml.RegressionSolutionStore.get(solutionName);
var trainingStatus = mlSolution.getLatestVersion().getStatus();

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

    Ausgabe:

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

    RegressionSolutionVersion – getVersionNumber()

    Ruft die Versionsnummer von ab ein Lösungsobjekt.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Versionsnummer.

    Das folgende Beispiel zeigt, wie Sie eine Versionsnummer abrufen.

    // Get version number
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

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

    Ausgabe:

    Version number: 1

    RegressionSolutionVersion – vorhersagen (Objekteingabe, Objektoptionen)

    Ruft die Eingabedaten für eine Vorhersage ab.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Eingabe Objekt GlideRecord oder ein Array von JSON-Objekten, die Feldnamen und Werte als Schlüssel-Wert-Paare enthalten.
    Optionen Objekt Optionale Werte zum Filtern von Vorhersageergebnissen.
    {
  "apply_threshold": Boolean,
  "top_n": Number
}
    Optionen.apply_threshold Boolean Kennzeichnung, die angibt, ob der Schwellenwert für die Lösung überprüft und auf den Ergebnissatz angewendet werden soll.
    Gültige Werte:
    • wahr: Gibt Ergebnisse zurück, bei denen die Konfidenz größer als der Schwellenwert ist.
    • „falsch“: Alle Ergebnisse zurückgeben.

    Standardwert: True
    Optionen.top_n Nummer Wenn angegeben, werden die besten Ergebnisse bis zur angegebenen Anzahl von Vorhersagen zurückgegeben.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Objekt JSON-Objekt, das die nach sys_id oder record_number sortierten Vorhersageergebnisse enthält. 
    {
    <identifier>: [Array]
}
    <Object>.<identifier> Liste von Objekten mit Details für jedes Vorhersageergebnis.

    Datentyp: Array von Objekten

    <identifier>: [
  {
    "confidence": Number,
    "predictedSysId": "String",
    "predictedValue": "String", 
    "threshold": Number
  }
]
    <Object>.<identifier> .<object>.confidence Wert der Konfidenz, die der Vorhersage zugeordnet ist. Beispiel: 53,84.

    Datentyp: Zahl
    <Object>.<identifier> .<object>.predictedSysId Die sys_id des vorhergesagten Werts. Ergebnisse können aus jeder Tabelle stammen, in der Informationen vorhergesagt werden.

    Datentyp: Zeichenfolge
    <Object>.<identifier> .<object>.predictedValue Wert, der das Vorhersageergebnis darstellt.

    Datentyp: Zeichenfolge
    <Object>.<identifier> .<object>.threshold Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist.

    Datentyp: Zahl

    Das folgende Beispiel zeigt, wie Vorhersageergebnisse für einepredict ()- Methode angezeigt werden, die einen GlideRecord nach sys_id als Eingabe akzeptiert und optionale Parameter einschließt, um die Top-3-Ergebnisse zu beschränken und den Schwellenwert auszuschließen.

    var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

// single GlideRecord input
var input = new GlideRecord("incident");
input.get("<sys_id>");

// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;

var results = mlSolution.getVersion(1).predict(input, options);
// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));
    {
        "<sys_id/now_GR>": [
    {
      "confidence": 62.10782320780268,
      "threshold": 20.36,
      "predictedValue": "Clone Issues",
      "predictedSysId": ""
    },
    {
      "confidence": 6.945237375770391,
      "threshold": 16.63,
      "predictedValue": "Instance Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 5.321061076300759,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    }
  ]
}

    Das folgende Beispiel zeigt, wie Vorhersageergebnisse für einepredict()- Methode angezeigt werden, die ein Array von Feldnamen als Schlüssel-Wert-Paare für die Eingabe akzeptiert und optionale Parameter einschließt, um die Top-3-Ergebnisse zu beschränken und den Schwellenwert auszuschließen.

    var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');
// key-value pairs input
var input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];
// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;
var results = mlSolution.predict(input, options);
// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));
    {
  "1": [
    {
      "confidence": 37.5023032262591,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 24.439964862166583,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 11.736320486031047,
      "threshold": 100,
      "predictedValue": "Security",
      "predictedSysId": ""
    }
  ],
  "2": [
    {
      "confidence": 99,
      "threshold": 17.77,
      "predictedValue": "Email",
      "predictedSysId": ""
    },
    {
      "confidence": 3.182137005157543,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 2.8773826570713514,
      "threshold": -1,
      "predictedValue": "Email (I/f)",
      "predictedSysId": ""
    }
  ]
}