Ähnlichkeitslösung : Global

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

    • Die Ähnlichkeitslösungs- 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.

    Der Lösungs-Setup-zu-Schulungs-Flow sieht wie folgt aus:
    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 hinzu, indem Sie die Methode Ähnlichkeitslösungsspeicher - add() verwenden.
    4. Trainieren Sie die Lösung mit der Methode „submitTrainingJob() “. Dadurch wird eine Version des Objekts erstellt, die Sie mit der Ähnlichkeitslösungsversion- API verwalten können.
    5. Vorhersagen mit der Ähnlichkeitslösungsversion – vorhergesagt () abrufen.
    Hinweis:
    Diese API wird von mit vollständigen Rechten ausgeführt. Um den Benutzerzugriff einzuschränken, fügen Sie einen Zugriffssteuerungsmechanismus in das Skript ein.

    Richtlinien zur Verwendung finden Sie unter ML-APIsverwenden .

    Ähnlichkeitslösung: Ähnlichkeitslösung (Objektkonfiguration)

    Erstellt eine Ähnlichkeitslösung.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Konfiguration Objekt JavaScript-Objekt mit Konfigurationseigenschaften für 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 Domain Separation 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 (Objektkonfiguration).
    config.label Zeichenfolge Gibt die Vorhersageaufgabe an.
    config.lookupDatensatz Objekt Name der Datensatzdefinition, 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 zweibuchstabigen ISO 639-1-Sprachcodeformat.

    Standard: „en“
    config.stoppwords Array 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.

    Standard: Englische Stoppwörter
    config.testDatensatz Objekt Name der Datensatzdefinition, die nach Ähnlichkeiten mit lookupDataset -Ergebnissen gescannt werden soll.
    config.trainingFrequency Zeichenfolge Optional. 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
    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
    • jeden_1_Stunden
    • jeden_6_Stunden
    • jeden_12_Stunden
    • jede_1_Minute
    • jeden_15_Minuten
    • jeden_30_Minuten
    Standard: do_not_update

    Das folgende Beispiel zeigt, wie Sie ein Objekt erstellen und zu hinzufügen Ähnlichkeitslösungsspeicher

    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);

    Ähnlichkeitslösung – cancelTrainingJob()

    Storniert 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 Sie einen vorhandenen Trainingsauftrag abbrechen.

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

mySolution.cancelTrainingJob();

    Ähnlichkeitslösung – getActiveVersion()

    Ruft das aktive ab Ähnlichkeitslösungsversion- Objekt.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Objekt Aktives Ähnlichkeitslösungsversion- Objekt.

    Das folgende Beispiel zeigt, wie Sie eine aktive Ähnlichkeitslösung Version aus dem Store abrufen und ihren Schulungsstatus 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"
}

    Ähnlichkeitslösung – getAllVersions()

    Ruft alle Versionen von ab ein Ähnlichkeitslösungsobjekt.

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

    Das folgende Beispiel zeigt, wie Sie alle Ähnlichkeitslösungsversionsobjekte abrufen und die Lösungsversionsmethoden getVersionNumber() und getStatus() dafür aufrufen.

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

    Ähnlichkeitslösung – getLatestVersion()

    Ruft die aktuelle Version von ab eine Lösung.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Objekt ÄhnlichkeitslösungVersion Objekt, das der aktuellen Version von entspricht einer Ähnlichkeitslösung.

    Das folgende Beispiel zeigt, wie Sie die aktuelle 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"
}

    Ähnlichkeitslösung – 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 Ähnlichkeitslö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

    Ähnlichkeitslösung – getProperties()

    Ruft Lösungsobjekteigenschaften ab.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 13. Ergebnisse
    Typ Beschreibung
    Objekt Inhalt der Details des Datensatzes und des Ähnlichkeitslösungsobjekts () im Ähnlichkeitslösungsspeicher.
    {
  "domainName": "String",
  "encoder": {Object},
  "label": "String",
  "lookupDatasetProperties": {Object},
  "name": "String",
  "processingLanguage": "String",
  "scope": "String",
  "stopwords": [Array],
  "testDatasetProperties": {Object},
  "trainingFrequency": "String",
  "updateFrequency": "String"
}
    <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>.label Gibt die Vorhersageaufgabe an. 
    {
  "label": "my first prediction"
}

    Datentyp: Zeichenfolge.
    <Object>.lookupDatasetProperties Details der Datensatzdefinition () 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: „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 von JavaScript-Objekten, die Feldeigenschaften angeben. 
    [
  {
    "name": "String",
    "type": "String"
  }
]

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

    Datentyp: Zeichenfolge.
    <Object>.lookupDatasetProperties.fieldDetails.<object>.type 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>.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>.testDatasetProperties Details der Datensatzdefinition () Objekt zum Abrufen von Ähnlichkeiten zwischen den in diesem Modell gesuchten Ergebnissen und den in lookupDatasetgefundenen Ergebnissen. 
    {
  "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 von JavaScript-Objekten, die Feldeigenschaften angeben. 
    [
  {
    "name": "String",
    "type": "String"
  }
]

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

    Datentyp: Zeichenfolge.
    <Object>.testDatasetProperties.fieldDetails.<object>.type Feldtyp für maschinelles Lernen.

    Datentyp: Zeichenfolge.
    <Object>.testDatasetProperties.fieldDetails.encodedQuery Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe Codierte Abfragezeichenfolgen.

    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>.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
    • jeden_1_Stunden
    • jeden_6_Stunden
    • jeden_12_Stunden
    • jede_1_Minute
    • jeden_15_Minuten
    • jeden_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"
}

    Ähnlichkeitslösung – getVersion(Zeichenfolgenversion)

    Ruft eine Lösung ab anhand der angegebenen Versionsnummer.

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

    Das folgende Beispiel zeigt, wie Sie den Trainingsstatus einer Lösung anhand der Versionsnummer abrufen.

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

    Ähnlichkeitslösung – setActiveVersion(String version)

    Aktiviert eine angegebene Version einer Lösung im Store.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    Version Zeichenfolge Name der zu aktivierenden Ähnlichkeitslösungs-Objektversion ().

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

    Das folgende Beispiel zeigt, wie Sie eine Lösungsversion im Store aktivieren.

    sn_ml.SimilaritySolution.setActiveVersion("ml_incident_categorization");

    Ähnlichkeitslösung –submitTrainingJob()

    Übermittelt einen Trainingsauftrag.

    Hinweis:
    Bevor Sie diese Methode ausführen können, müssen Sie dem Speicher zuerst eine Lösung mit der Methode Ähnlichkeitslösungsspeicher - add() hinzufügen.
    Tabelle : 18. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 19. Ergebnisse
    Typ Beschreibung
    Objekt ÄhnlichkeitslösungVersion Objekt, das Ähnlichkeitslösung 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();