KlassifizierungLösung – Global

Zürich-API-Referenz

Release

zurich

ft:locale

de-DE

ft:publication_title

Zürich-API-Referenz

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

KlassifizierungLösung – Global

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

8 Minuten Lesedauer

Die KlassifizierungLösung API ist ein skriptfähiges Objekt, das in verwendet wird Predictive Intelligence Speichert.

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

Der Flow „Setup der Lösung zu Training“ lautet wie folgt:

Erstellen Sie einen Datensatz mit Datendefinition API.
Optional. Erstellen Sie einen Encoder mit Encoder API.
Verwenden Sie Konstruktor Dient zum Erstellen eines Klassifizierungslösungsobjekts.
Fügen Sie das Lösungsobjekt dem Speicher der Klassifizierungslösung mit hinzu ClassificationSolutionStore – add() Methode.
Trainieren Sie die Lösung mit SubmitTrainingJob() Methode. Dadurch wird eine Version des Objekts erstellt, das Sie mit verwalten können ClassificationSolutionVersion API.
Rufen Sie Vorhersagen mit ab ClassificationSolutionVersion – Predict() 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 .

ClassificationSolution – ClassificationSolution (Objektkonfiguration)

Erstellt eine Klassifizierungslösung.

Tabelle : 1. Parameter
Name	Typ	Beschreibung
Konfiguration	Objekt	JavaScript-Objekt mit Konfigurationseigenschaften von Lösung. `{ "algorithmConfig": {Object}, "dataset": {Object}, "domainName": "String", "encoder": {Object}, "groupByFieldName": "String", "inputFieldNames": [Array], "label": "String", "minRowCount": "String", "predictedFieldName": "String", "processingLanguage": "String", "stopwords": [Array], "trainingFrequency": "String" }`
Config.algorithmKonfig	Objekt	JavaScript-Objekt mit Algorithmuskonfigurationseigenschaften. `'algorithmConfig' : { "algorithm": "String", "targetClassRecall": "String" }`
Config.algorithmConfig.algorithmus	Zeichenfolge	Methode zum Codieren Ihrer Lösung. Mögliche Werte: xgboost: XGBoost-Codierung zur Optimierung des Trainings. logisticRegression: Methode, die das logistische Regressionsmodell für kategorische Ziele wie nominal oder Ordnungszahl verwendet.
Config.algorithmConfig.targetClassRückruf	Zeichenfolge	Wendet einen Klassenrückrufparameter an, um das Training einer Lösung so zu steuern, dass eine bestimmte Klasse verzerrt wird. Format ist `„<ClassName:RecallValue>“` Wobei der Rückrufwert eine Zahl zwischen 0 und 100 ist, die einen Prozentsatz darstellt. Um diesen Lösungsparameter beispielsweise für alle Datensätze, die Sie in der E-Mail-Klasse trainieren, auf eine Genauigkeit von 90 % festzulegen und anzuwenden, wird der Wert auf festgelegt `„E-Mail:90“` .
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.encoder	Objekt	Optional. Trainiertes Encoderobjekt, das dieser Lösung zugewiesen werden soll. Siehe Encoder – Encoder (Objektkonfiguration).
Config.Erklärbarkeit	Boolean	Kennzeichnung, die angibt, ob eine Modellerklärbarkeit bereitgestellt werden soll. Verwenden Sie die Modellerklärbarkeit, um die Wichtigkeit jedes Eingabefelds für die Vorhersagen Ihres Modells zu identifizieren. Gültige Werte: Wahr: Das Klassifizierungsmodell enthält Erklärungsdetails. Informationen können in angezeigt werden Wichtigkeit Der Funktion Registerkarte des Lösungsformulars des Modells. Falsch: Das Klassifizierungsmodell enthält keine Erklärungsdetails. Standardwert: false Siehe auch: Model Explainability
config.groupByFieldName	Zeichenfolge	Optional. Feldname, nach dem das System Datensätze gruppiert, um Klassifizierungslösungen zu erstellen.Informationen zur Nutzung finden Sie unter „Gruppieren nach“ für die Klassifizierung verwendet .
config.inputFieldNames	Array	Liste der Eingabefeldnamen als Zeichenfolgen. Das Modell verwendet diese Felder, um Vorhersagen zu treffen.
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.processingLanguage	Zeichenfolge	Optional. Sprache wird im zweistelligen ISO 639-1-Sprachcodeformat verarbeitet. Standard: „en“
Config.Stoppwörter	Array	Optional. Voreingestellte Liste von Zeichenfolgen, die das System automatisch basierend auf generiert languageEigenschaftseinstellung. Weitere Informationen finden Sie unter Erstellen Sie eine anwenderdefinierte Stoppwortliste . Standard: Englische Stoppwörter
Config.trainingHäufigkeit	Zeichenfolge	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 ein Objekt erstellt und dem hinzugefügt wird ClassificationSolution Store.

var myData = new sn_ml.DatasetDefinition(
  { 
     'tableName' : 'incident', 
     'fieldNames' : ['category', 'short_description', 'priority'],
     'fieldDetails' : [
       {
         'name' : 'category',
         'type' : 'nominal'
       },
       {
         'name' : 'short_description',
         'type' : 'text'
       }], 
     'encodedQuery' : 'activeANYTHING'
  });

var mySolution = new sn_ml.ClassificationSolution({
  'label': "my solution definition",
  'dataset' : myData,
  'predictedFieldName' : 'category',
  'inputFieldNames': ['short_description']
});

var myClassificationName = sn_ml.ClassificationSolutionStore.add(mySolution);

ClassificationSolution – cancelTrainingJob()

Bricht einen Auftrag für ab Ein Lösungsobjekt 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 mySolution = sn_ml.ClassificationSolutionStore.get('ml_sn_global_global_classification');

mySolution.cancelTrainingJob();

ClassificationSolution – getActiveVersion()

Ruft die aktiven ab ClassificationSolutionVersion Objekt.

Tabelle : 4. Parameter
Name	Typ	Beschreibung
Keine

Tabelle : 5. Ergebnisse
Typ	Beschreibung
Objekt	Aktiv ClassificationSolutionVersion Objekt.

Das folgende Beispiel zeigt, wie Sie einen aktiven erhalten KlassifizierungLösung Version aus dem Store und gibt den Schulungsstatus zurück.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');

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

Ausgabe:

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

ClassificationSolution – getAllVersions()

Ruft alle Versionen von ab Eine Klassifizierungslösung.

Tabelle : 6. Parameter
Name	Typ	Beschreibung
Keine

Tabelle : 7. Ergebnisse
Typ	Beschreibung
Array	Vorhandene Versionen eines Lösungsobjekts. Siehe auch ClassificationSolutionVersion API.

Das folgende Beispiel zeigt, wie alle abgerufen werden KlassifizierungLösung Versionsobjekte und rufen Sie auf GetVersionNumber() Und GetStatus() Lösungsversionsmethoden darauf.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');

var mlSolutionVersions = mlSolution.getAllVersions();

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

Ausgabe:

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

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

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

ClassificationSolution – getLatestVersion()

Ruft die neueste Version von ab Eine Lösung.

Tabelle : 8. Parameter
Name	Typ	Beschreibung
Keine

Tabelle : 9. Ergebnisse
Typ	Beschreibung
Objekt	ClassificationSolutionVersion Objekt, das der neuesten Version von entspricht A KlassifizierungSolution() .

Das folgende Beispiel zeigt, wie Sie die neueste Version von abrufen Eine Lösung und gibt ihren Schulungsstatus zurück.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');

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

Ausgabe:

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

ClassificationSolution – 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 Lösungsobjekts.

Das folgende Beispiel zeigt, wie aktualisiert wird KlassifizierungLösung Datensatzinformationen erstellen und den Namen des Objekts drucken.

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

var eligibleFields = JSON.parse(myIncidentData.getEligibleFields('classification'));

var myClassification = new sn_ml.ClassificationSolution({
   'label': "my classification solution",
   'dataset' : myIncidentData,
   'inputFieldNames': eligibleFields['eligibleInputFieldNames'],
   'predictedFieldName': 'category'
});

// update solution
sn_ml.ClassificationSolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', myClassification);

// print solution name
gs.print('Solution Name: '+myClassification.getName());

Ausgabe:

Solution Name: ml_x_snc_global_global_my_solution_definition_4

ClassificationSolution – getProperties()

Ruft Lösungsobjekteigenschaften ab.

Tabelle : 12. Parameter
Name	Typ	Beschreibung
Keine

Tabelle : 13. Ergebnisse
Typ	Beschreibung
Objekt	Inhalt des Datensatzes und KlassifizierungSolution() Objektdetails in ClassificationSolutionStore . `{ "algorithmConfig": { "algorithm": "String", "targetClassRecall": "String" }, "datasetProperties": {Object}, "domainName": "String", "encoder": {Object}, "groupByFieldName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String" }`
<Object>.AlgorithmConfig	Methode zum Codieren der Lösung. Datentyp: Objekt.
<Object>.AlgorithmConfig.Algorithmus	Name des Codierungsalgorithmus für das Trainieren dieser Lösung. Mögliche Werte: xgboost: XGBoost-Codierung zur Optimierung des Trainings. logisticRegression: Methode, die das logistische Regressionsmodell für kategorische Ziele wie nominal oder Ordnungszahl verwendet. Datentyp: Zeichenfolge.
<Object>.AlgorithmConfig.targetClassRückruf	Klassenrückrufparameter, um das Training einer Lösung so zu steuern, dass eine bestimmte Klasse verzerrt wird. Der Rückrufwert ist eine Zahl zwischen 0 und 100, die einen Prozentsatz darstellt. Datentyp: Zeichenfolge
<Object>.DatasetEigenschaften	Listet die Eigenschaften von auf Datendefinition() Objekt, das der Lösung zugeordnet ist. `{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }` Datentyp: Objekt.
<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>.Encoder	Encoderobjekt, das dieser Lösung zugewiesen ist. Siehe Encoder – Encoder (Objektkonfiguration). Datentyp: Objekt.
<Object>.GroupByFieldName	Feldname, nach dem das System Datensätze gruppiert, um Klassifizierungslösungen zu erstellen. Datentyp: Zeichenfolge
<Object>.InputFieldNames	Liste der Eingabefeldnamen als Zeichenfolgen. Das Modell verwendet diese Felder, um Vorhersagen zu treffen. 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>.ProcessingLanguage	Sprache wird im zweistelligen ISO 639-1-Sprachcodeformat verarbeitet. Datentyp: Zeichenfolge.
<Object>.Umfang	Objektbereich. Derzeit ist der einzige gültige Wert `Global` . Datentyp: Zeichenfolge
<Object>.Stoppwörter	Optional. Voreingestellte Liste von Zeichenfolgen, die das System automatisch basierend auf generiert languageEigenschaftseinstellung. Weitere Informationen finden Sie unter Erstellen Sie eine anwenderdefinierte Stoppwortliste . Datentyp: Array.
<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 Lösungsobjekt Im Store.

var mySolution = sn_ml.ClassificationSolutionStore.get('ml_sn_global_global_classification_solution');

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 solution definition",
  "name": "ml_x_snc_global_global_my_solution_definition_26",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "trainingFrequency": "run_once"
}

ClassificationSolution – getVersion(Zeichenfolgenversion)

Ruft eine Lösung ab Nach angegebener Versionsnummer.

Tabelle : 14. Parameter
Name	Typ	Beschreibung
Version	Zeichenfolge	Vorhandene Versionsnummer von Eine Lösung.

Tabelle : 15. Ergebnisse
Typ	Beschreibung
Objekt	Angegebene Version von KlassifizierungSolution() Objekt, mit dem Sie anrufen können ClassificationSolutionVersion API-Methoden.

Das folgende Beispiel zeigt, wie der Schulungsstatus von abgerufen wird Eine Lösung nach Versionsnummer.

var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_classification');

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

Ausgabe:

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

ClassificationSolution – setActiveVersion(Zeichenfolgenversion)

Aktiviert eine angegebene Version einer Lösung im Store.

Tabelle : 16. Parameter
Name	Typ	Beschreibung
Version	Zeichenfolge	Name des KlassifizierungSolution() 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 Lösung Version im Store.

sn_ml.ClassificationSolution.setActiveVersion("ml_incident_categorization");

ClassificationSolution – submitTrainingJob()

Übermittelt einen Schulungsauftrag.

Hinweis:

Bevor Sie diese Methode ausführen, müssen Sie dem Store zuerst mithilfe von eine Lösung hinzufügen ClassificationSolutionStore – add() Methode.

Tabelle : 18. Parameter
Name	Typ	Beschreibung
Keine

Tabelle : 19. Ergebnisse
Typ	Beschreibung
Objekt	ClassificationSolutionVersion Objekt, das dem entspricht KlassifizierungLösung Wird trainiert.

Das folgende Beispiel zeigt, wie Sie einen Datensatz erstellen und auf anwenden Eine Lösung, fügen Sie die Lösung 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 a solution 
var mySolution = new sn_ml.ClassificationSolution({

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

});

// Add the solution to the store to later be able to retrieve it.
var my_unique_name = sn_ml.ClassificationSolutionStore.add(mySolution);

// Train the solution - this is a long running job 
var myClassifierVersion = mySolution.submitTrainingJob();