SimilaritySolution – Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 7 Minuten Lesedauer

    • Die SimilaritySolution- API ist ein skriptfähiges Objekt, das in Predictive Intelligence -Speichern verwendet wird.

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

    Der Flow vom Setup der Lösung bis zum Training lautet wie folgt:
    1. Erstellen Sie einen Encoder mit der Encoder -API.
    2. Verwenden Sie den Konstruktor, um ein Ähnlichkeitslösungsobjekt zu erstellen.
    3. Fügen Sie das Lösungsobjekt dem Ähnlichkeitslösungsspeicher mit der Methode SimilaritySolutionStore – add() hinzu.
    4. Trainieren Sie die Lösung mit der Methode „submitTrainingJob() “. Dadurch wird eine Version des Objekts erstellt, die Sie mit der SimilaritySolutionVersion- API verwalten können.
    5. Rufen Sie Vorhersagen mit der Methode SimilaritySolutionVersion – prediction() ab.
    Hinweis:
    Diese API führt mit vollständigen Berechtigungen aus. Um den Benutzerzugriff einzuschränken, fügen Sie einen Zugriffskontrollmechanismus in das Skript ein.

    Richtlinien zur Verwendung finden Sie unter ML-APIsverwenden.

    SimilaritySolution – SimilaritySolution(Object config)

    Erstellt eine Ähnlichkeitslösung.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Konfiguration Objekt JavaScript-Objekt, das Konfigurationseigenschaften des enthält Lösung.
    {  
  "domainName": "String",
  "encoder": {Object},
  "label": "String",
  "lookupDataset": {Object},
  "minRowCount": "String",
  "processingLanguage": "String",
  "stopwords": [Array],
  "testDataset": {Object},
  "trainingFrequency": "String",
  "updateFrequency": "String"
}
    config.domainName 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 Trainiertes Encoder-Objekt, das dieser Lösung zugewiesen werden soll. Siehe Encoder: Encoder(Object config).
    config.label Zeichenfolge Identifiziert die Vorhersageaufgabe.
    config.lookupDatensatz Objekt Name der DatasetDefinition, die als Suchsatz verwendet werden soll.
    config.minRowCount Zeichenfolge Optional. Mindestanzahl von Datensätzen, die im Datensatz für das Training erforderlich sind.

    Standard: 10.000
    config.processingLanguage Zeichenfolge Optional. Verarbeitungssprache im aus zwei Buchstaben bestehenden ISO 639-1-Sprachcodeformat.

    Standard: „en“
    config.stoppwords Array Optional. Voreingestellte Liste von Zeichenfolgen, die das System basierend auf der Eigenschaftseinstellung language automatisch generiert. Weitere Informationen finden Sie unter Benutzerdefinierte Stoppwortlisten erstellen.

    Standard: Englische Stoppwörter
    config.testDataset Objekt Name der DatasetDefinition, die nach Ähnlichkeiten mit lookupDataset -Ergebnissen gescannt werden soll.
    config.trainingHäufigkeit Zeichenfolge Optional. Die Häufigkeit, mit der das Modell neu trainiert werden soll.
    Mögliche Werte:
    • jeden_30_Tage
    • alle_60_Tage
    • all_90_days
    • all_120_days
    • all_180_days
    • run_once
    Standard: run_once
    config.updateFrequency Die Häufigkeit, mit der das Modell für die Lösungsdefinition neu erstellt werden muss.
    Mögliche Werte:
    • do_not_update
    • jeden_1_Tag
    • jede_1_Stunde
    • jede_6_Stunden
    • all_12_hours
    • jede_1_Minute
    • alle_15_Minuten
    • jede_30_Minuten
    Standard: do_not_update

    Das folgende Beispiel zeigt, wie Sie ein Objekt erstellen und dem hinzufügen SimilaritySolution Store.

    var incidentData = new sn_ml.DatasetDefinition({
        'tableName' : 'incident',
        'fieldNames' : ['category', 'short_description']        
    });
    var kbData = new sn_ml.DatasetDefinition({
        'tableName' : 'kb_knowledge',
        'fieldNames' : ['short_description'],
        'encodedQuery' : 'active=true'
    });
    var encoder = sn_ml.EncoderStore.get('GloVe');
    var mySolution = new sn_ml.SimilaritySolution({
        'label': "similarity solution",
        'lookupDataset' : kbData,
        'testDataset' : incidentData,        
        'encoder' : encoder        
    });
    
    // add solution
    var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);

    SimilaritySolution – cancelTrainingJob()

    Bricht einen Auftrag für ein Lösungsobjekt , das zum Trainieren übermittelt wurde.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein vorhandener Trainingsauftrag abgebrochen wird.

    var mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity');

mySolution.cancelTrainingJob();

    SimilaritySolution – getActiveVersion()

    Ruft den aktiven ab SimilaritySolutionVersion- Objekt.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Objekt Aktives SimilaritySolutionVersion- Objekt.

    Das folgende Beispiel zeigt, wie Sie eine aktive ÄhnlichkeitLösung Version aus dem Store abrufen und ihren Trainingsstatus zurückgeben.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_similarity');

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

    Ausgabe:

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

    SimilaritySolution – getAllVersions()

    Ruft alle Versionen von ab ein SimilaritySolution- Objekt.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Array Vorhandene Versionen eines Lösungsobjekts. Siehe auch SimilaritySolutionVersion- API.

    Das folgende Beispiel zeigt, wie alle SimilaritySolution -Versionsobjekte abgerufen und die Lösungsversionsmethoden getVersionNumber() und getStatus() für sie aufgerufen werden.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_Similarity');

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"}

    SimilaritySolution – getLatestVersion()

    Ruft die neueste Version von ab eine Lösung.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Objekt SimilaritySolutionVersion Objekt, das der neuesten Version von entspricht eine SimilaritySolution.

    Das folgende Beispiel zeigt, wie Sie die neueste Version einer Lösung abrufen und ihren Trainingsstatus zurückgeben.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_Similarity');

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

    Ausgabe:

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

    SimilaritySolution – getName()

    Ruft den Namen des Objekts ab, das für die Interaktion mit dem Speicher 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 ÄhnlichkeitLösung Datensatzinformationen aktualisiert und der Name des Objekts gedruckt wird.

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

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

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

// update solution
sn_ml.SimilaritySolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', mySimilarity);

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

    Ausgabe:

    Solution Name: ml_x_snc_global_global_my_solution_definition_4

    SimilaritySolution – getProperties()

    Ruft Eigenschaften des Lösungsobjekts aban.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    Objekt Inhalt der Details des Datensatzes und des SimilaritySolution()- Objekts im SimilaritySolutionStore.
    {
  "domainName": "String",
  "encoder": {Object},
  "label": "String",
  "lookupDatasetProperties": {Object},
  "name": "String",
  "processingLanguage": "String",
  "scope": "String",
  "stopwords": [Array],
  "testDatasetProperties": {Object},
  "trainingFrequency": "String",
  "updateFrequency": "String"
}
    <Object>.domainName Domänenname, der diesem Datensatz zugeordnet ist. Siehe Domänentrennung und Predictive Intelligence.

    Datentyp: Zeichenfolge.
    <Object>.Encoder Encoder-Objekt, das dieser Lösung zugewiesen ist. Siehe Encoder: Encoder(Object config).

    Datentyp: Objekt.
    <Object>.Bezeichnung Identifiziert die Vorhersageaufgabe. 
    {
  "label": "my first prediction"
}

    Datentyp: Zeichenfolge.
    <Object>.lookupDatasetEigenschaften Details der DatasetDefinition() -Objekt, das als Suchsatz verwendet wird. 
    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}

    Datentyp: Objekt.
    <Object>.suchenDatensatzEigenschaften.Tabellenname Name der Tabelle für den Datensatz. Beispiel: "tableName" : "Incident".

    Datentyp: Zeichenfolge.
    <Object>.lookupDatasetProperties.fieldNames Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: „fieldNames“ : ["short_description", "priority"].

    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>.type ML-Feldtyp (maschinelles Lernen).

    Datentyp: Zeichenfolge.
    <Object>.lookupDatasetProperties.fieldDetails.encodedQuery Codierte Abfragezeichenfolge im Standard-Glide-Format. Weitere Informationen finden Sie unter Codierte Abfragezeichenfolgen.

    Datentyp: Zeichenfolge.
    <Object>.name Vom System zugewiesener Name.

    Datentyp: Zeichenfolge.
    <Object>.processingLanguage Verarbeitungssprache im aus zwei Buchstaben bestehenden ISO 639-1-Sprachcodeformat.

    Datentyp: Zeichenfolge.
    <Object>.Bereich Objektumfang. Derzeit ist der einzige gültige Wert global.

    Datentyp: Zeichenfolge
    <Object>.Stoppwörter Optional. Voreingestellte Liste von Zeichenfolgen, die das System basierend auf der Eigenschaftseinstellung language automatisch generiert. Weitere Informationen finden Sie unter Benutzerdefinierte Stoppwortlisten erstellen.

    Datentyp: Array.
    <Object>.testDatasetProperties Details der DatasetDefinition() Objekt, das zum Abrufen von Ähnlichkeiten zwischen den in diesem Modell gesuchten Ergebnissen und den in lookupDatasetgefundenen Ergebnissen verwendet wird. 
    {
  "encodedQuery": "String",
  "fieldDetails": [Array],
  "fieldNames": [Array],
  "tableName": "String"
}

    Datentyp: Objekt.
    <Object>.testDatasetProperties.tableName Name der Tabelle für den Datensatz. Beispiel: "tableName" : "Incident".

    Datentyp: Zeichenfolge.
    <Object>.testDatasetProperties.fieldNames Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: „fieldNames“ : ["short_description", "priority"].

    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>.type ML-Feldtyp (maschinelles Lernen).

    Datentyp: Zeichenfolge.
    <Object>.testDatasetProperties.fieldDetails.encodedQuery Codierte Abfragezeichenfolge im Standard-Glide-Format. Weitere Informationen finden Sie unter Codierte Abfragezeichenfolgen.

    Datentyp: Zeichenfolge.
    <Object>.trainingHäufigkeit Die Häufigkeit, mit der das Modell neu trainiert werden soll.
    Mögliche Werte:
    • jeden_30_Tage
    • alle_60_Tage
    • all_90_days
    • all_120_days
    • all_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
    • jeden_1_Tag
    • jede_1_Stunde
    • jede_6_Stunden
    • all_12_hours
    • jede_1_Minute
    • alle_15_Minuten
    • jede_30_Minuten
    Standard: do_not_update

    Datentyp: Zeichenfolge

    Im folgenden Beispiel werden Eigenschaften eines Lösungsobjekts im Store abgerufen.

    var mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity_solution');

gs.print(JSON.stringify(JSON.parse(mySolution.getProperties()), null, 2));
    Ausgabe:
    *** Script: {
  "domainName": "global",
  "encoderProperties": {
    "datasetsProperties": [],
    "name": "wordCorpusA"
  },
  "label": "similarity",
  "lookupDatasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "short_description"
    ]
  },
  "name": "ml_x_snc_global_global_similarity",
  "processingLanguage": "en",
  "scope": "global",
  "stopwords": [
    "Default English Stopwords"
  ],
  "testDatasetProperties": {
    "tableName": "incident",
    "fieldNames": [
      "short_description"
    ]
  },
  "trainingFrequency": "every_30_days",
  "updateFrequency": "do_not_update"
}

    SimilaritySolution – getVersion(String version)

    Ruft eine Lösung ab nach angegebener Versionsnummer.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Version Zeichenfolge Vorhandene Versionsnummer einer Lösung.
    Tabelle : 15. Ergebnisse
    Typ Beschreibung
    Objekt Angegebene Version des SimilaritySolution()- Objekts, für das Sie ÄhnlichkeititySolutionVersion -API-Methoden aufrufen können.

    Das folgende Beispiel zeigt, wie der Trainingsstatus einer Lösung anhand der Versionsnummer abgerufen wird.

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_similarity');

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

    Ausgabe:

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

    SimilaritySolution – setActiveVersion(String version)

    Aktiviert eine angegebene Version einer Lösung im Store.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    Version Zeichenfolge Name der zu aktivierenden Version des SimilaritySolution()- Objekts.

    Durch die Aktivierung dieser Version werden alle anderen Versionen deaktiviert.
    Tabelle : 17. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie eine Lösungsversion im Store aktiviert wird.

    sn_ml.SimilaritySolution.setActiveVersion("ml_incident_categorization");

    SimilaritySolution – submitTrainingJob()

    Sendet einen Trainingsauftrag.

    Hinweis:
    Bevor Sie diese Methode ausführen, müssen Sie dem Speicher zuerst eine Lösung mit der Methode SimilaritySolutionStore – add() hinzufügen.
    Tabelle : 18. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 19. Ergebnisse
    Typ Beschreibung
    Objekt SimilaritySolutionVersion Objekt, das SimilaritySolution dem trainierten entspricht. 
    // Create a dataset 
var incidentData = new sn_ml.DatasetDefinition({
    'tableName' : 'incident',
    'fieldNames' : ['category', 'short_description']
});

var kbData = new sn_ml.DatasetDefinition({
    'tableName' : 'kb_knowledge',
    'fieldNames' : ['short_description'],
    'encodedQuery' : 'active=true'
});

// Create a solution 
var encoder = sn_ml.EncoderStore.get('GloVe');
var mySolution = new sn_ml.SimilaritySolution({
    'label': "similarity solution",
    'lookupDataset' : kbData,
    'testDataset' : incidentData,
    'encoder' : encoder,
});

// Add solution
var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);


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