Ähnliche Lösungsversion – Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 6 Minuten Lesedauer
  • Die Ähnliche Lösungsversion 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.

    Diese API wird für die Arbeit mit Lösungsversionen basierend auf verwendet Ähnlichkeitslösungs-API Objekte in Ähnlicher Lösungsspeicher .

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

    Methoden in dieser API sind wie folgt zugänglich Ähnliche Lösung Methoden:

    SimilaritySolutionVersion – getProperties()

    Ruft Lösungsobjekteigenschaften ab Und Versionsnummer.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Objekt Inhalt des Datensatzes und Ähnliche Lösung Versionsdetails. Die Ergebnisse variieren je nach Setup der Objekteigenschaft.
    {
      "domainName": "String",
      "encoder": {Object},  
      "isActive": "String",
      "label": "String",
      "lookupDatasetProperties": {Object},
      "name": "String",
      "predictedFieldName": "String",
      "processingLanguage": "String",
      "scope": "String",
      "stopwords": [Array],
      "testDatasetProperties": {Object},
      "trainingFrequency": "String",
      "updateFrequency": "String",
      "versionNumber": "String"
    }
    <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>.Isaktiv Kennzeichnung, die angibt, ob diese Version aktiv ist.
    Gültige Werte:
    • Wahr: Version ist aktiv.
    • Falsch: Version ist nicht aktiv.

    Datentyp: Zeichenfolge

    <Object>.Bezeichnung Gibt die Vorhersageaufgabe an.
    {
      "label": "my first prediction"
    }

    Datentyp: Zeichenfolge.

    <Object>.LookupDatasetProperties Details von Datendefinition() Objekt, das als Suchsatz verwendet wird.
    {
      "encodedQuery": "String",
      "fieldDetails": [Array],
      "fieldNames": [Array],
      "tableName": "String"
    }

    Datentyp: Objekt.

    <Object>.LookupDatasetProperties.tableName Name der Tabelle für den Datensatz. Beispiel: „Tabellenname“: „Incident“ .

    Datentyp: Zeichenfolge.

    <Object>.LookupDatasetProperties.fieldnames Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: „Feldnamen“: [„short_description“, „Priorität“] .

    Datentyp: Array.

    <Object>.LookupDatasetProperties.fieldnames.fieldDetails Liste der JavaScript-Objekte, die Feldeigenschaften angeben.
    [
      {
        "name": "String",
        "type": "String"
      }
    ]

    Datentyp: Array.

    <Object>.LookupDatasetProperties.fieldnames.fieldDetails. <object>.Name Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll.

    Datentyp: Zeichenfolge.

    <Object>.LookupDatasetProperties.fieldDetails. <object>.Typ Feldtyp für maschinelles Lernen.

    Datentyp: Zeichenfolge.

    <Object>.LookupDatasetProperties.fieldDetails.encodedQuery Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen .

    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>.TestDatasetEigenschaften Details von Datendefinition() Objekt, das zum Abrufen von Ähnlichkeiten zwischen Ergebnissen verwendet wird, die in diesem Modell gesucht werden, und Ergebnissen, die in gefunden wurden lookupDataset.
    {
      "encodedQuery": "String",
      "fieldDetails": [Array],
      "fieldNames": [Array],
      "tableName": "String"
    }

    Datentyp: Objekt.

    <Object>.TestDatasetProperties.tableName Name der Tabelle für den Datensatz. Beispiel: „Tabellenname“: „Incident“ .

    Datentyp: Zeichenfolge.

    <Object>.TestDatasetEigenschaften.Feldnamen Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: „Feldnamen“: [„short_description“, „Priorität“] .

    Datentyp: Array.

    <Object>.TestDatasetProperties.fieldnames.fieldDetails Liste der JavaScript-Objekte, die Feldeigenschaften angeben.
    [
      {
        "name": "String",
        "type": "String"
      }
    ]

    Datentyp: Array.

    <Object>.TestDatasetProperties.fieldnames.fieldDetails. <object>.Name Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll.

    Datentyp: Zeichenfolge.

    <Object>.TestDatasetProperties.fieldDetails. <object>.Typ Feldtyp für maschinelles Lernen.

    Datentyp: Zeichenfolge.

    <Object>.TestDatasetProperties.fieldDetails.encodedQuery Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen .

    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.

    <Object>.UpdateHäufigkeit Die Häufigkeit, mit der das Modell für die Lösungsdefinition neu erstellt werden muss.
    Mögliche Werte:
    • Do_Not_Update
    • Every_1_day
    • Every_1_Hour
    • Every_6_hours
    • Every_12_hours
    • Jede_1_Minute
    • Alle_15_Minuten
    • Alle_30_Minuten
    Standard: Do_Not_Update

    Datentyp: Zeichenfolge

    <Object>.VersionNumber Versionsnummer von Ähnliche Lösung Objekt.

    Datentyp: Zeichenfolge.

    Das folgende Beispiel ruft Eigenschaften der aktiven Objektversion im Store ab.

    // Get properties
    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');
    
    gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));

    Ausgabe:

    *** Script: {
      "domainName": "global",
      "encoderProperties": {
        "datasetsProperties": [],
        "name": "wordCorpusA"
      },
      "isActive": "true",
      "label": "similarity",
      "lookupDatasetProperties": {
        "encodedQuery": "",
        "fieldNames": [
          "short_description"
        ],
        "tableName": "incident"
      },
      "name": "ml_x_snc_global_global_similarity",
      "processingLanguage": "en",
      "stopwords": [
        "Default English Stopwords"
      ],
      "testDatasetProperties": {
        "fieldNames": [
          "short_description"
        ],
        "tableName": "incident"
      },
      "versionNumber": "3"
    }

    SimilaritySolutionVersion – getStatus(boolescher Wert inklusivDetails)

    Ruft den Abschlussstatus des Trainings ab.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    EinbeziehenDetails Boolean Kennzeichnung, die angibt, ob der Status zurückgegeben werden soll details.
    Gültige Werte:
    • Wahr: Gibt zusätzliche Details zurück.
    • Falsch: Keine zusätzlichen Details zurückgeben.

    Standardwert: False

    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt JavaScript-Objekt mit Schulungsstatusinformationen fürA Ähnliche Lösung Objekt.
    {
      "state": "String",
      "percentComplete": "Number as a String",
      "hasJobEnded": "Boolean value as a String",
      "details": {Object}
    }
    <Object>.Status Abschlussstatus des Trainings. Wenn der Schulungsauftrag einen Terminalstatus erreicht, verlässt der Auftrag diesen Status nicht. Wenn der Status Terminal ist, wird die hasJobEndedEigenschaft ist auf festgelegt Wahr .
    Mögliche Werte:
    • Abrufen_Dateien_für_Training
    • Preparing_Data
    • Erneut versuchen
    • Solution_CANCEL (Terminal)
    • Solution_Complete (Terminal)
    • Solution_error (Terminal)
    • Lösung_unvollständig
    • Training_Request_Received
    • Training_Request_Timed_out (Terminal)
    • Training_Solution
    • Uploading_Solution
    • Warten_auf_Training

    Datentyp: Zeichenfolge

    <Object>.HasJobEnded Kennzeichnung, die angibt, ob das Training abgeschlossen ist.
    Gültige Werte:
    • Wahr: Training ist abgeschlossen.
    • Falsch: Training ist unvollständig.

    Datentyp: Boolescher Wert als Zeichenfolge

    <Object>.Prozent abgeschlossen Abschluss des Trainings in Prozent. Wenn der Fertigstellungsprozentsatz kleiner als 100 ist, befindet sich der Auftrag möglicherweise in einem Terminalstatus. Zum Beispiel, wenn das Training eine Zeitüberschreitung hat.

    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.SimilaritySolutionStore.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_similarity_solution';
    var mlSolution = sn_ml.SimilaritySolutionStore.get(solutionName);
    var trainingStatus = JSON.parse(mlSolution.getLatestVersion().getStatus());
    
    gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));

    Ausgabe:

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

    SimilaritySolutionVersion – 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 eine Versionsnummer abgerufen wird.

    // Get version number
    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_incident_categorization');
    
    gs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));

    Ausgabe:

    Version number: 1

    SimilaritySolutionVersion – Predict (Objekteingabe, Objektoptionen)

    Ruft die Eingabedaten für eine Vorhersage ab.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Eingabe Objekt GlideRecord Oder 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
    }
    Options.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: Ergebnisse zurückgeben, bei denen die Konfidenz größer als der Schwellenwert ist.
    • Falsch: Alle Ergebnisse zurückgeben.

    Standardwert: True

    Optionen.Top_n Anzahl Wenn angegeben, werden die Top-Ergebnisse bis zur angegebenen Anzahl von Vorhersagen zurückgegeben.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Objekt JSON-Objekt, das die Vorhersageergebnisse enthält, sortiert nach sys_ID oder Record_number.
    {
        <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>.Konfidenz 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, für die Informationen vorhergesagt werden.

    Datentyp: Zeichenfolge

    <Object>.<identifier>. <object>.PredictedValue Wert, der das Vorhersageergebnis darstellt.

    Datentyp: Zeichenfolge

    <Object>.<identifier>. <object>.Schwellenwert Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist.

    Datentyp: Zahl

    Das folgende Beispiel zeigt, wie Vorhersageergebnisse für angezeigt werden Vorhersagen() Methode, die einen GlideRecord nach sys_ID für die Eingabe verwendet und optionale Parameter enthält, um auf die drei wichtigsten Ergebnisse zu beschränken und den Schwellenwert auszuschließen.

    var mlSolution = sn_ml.SimilaritySolutionStore.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 angezeigt werden Vorhersagen() Methode, die ein Array von Feldnamen als Schlüssel-Wert-Paare für die Eingabe verwendet und optionale Parameter enthält, um auf die drei wichtigsten Ergebnisse zu beschränken und den Schwellenwert auszuschließen.

    var mlSolution = sn_ml.SimilaritySolutionStore.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": ""
        }
      ]
    }