---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# ClusteringSolution -- Global

# ClusteringSolution -- Global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 11 Minuten Lesedauer

Die ClusteringSolution API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.

Diese(s) API erfordert Predictive IntelligencePlugin (com.glide.platform_ml) und wird in bereitgestellt `sn_ml `Namespace.  
Der Flow „Lösungssetup zu Training" lautet wie folgt:

1. Erstellen Sie einen Datensatz mit [Datendefinition](https://servicenow-prod.fluidtopics.net/P8pkp_FhlIJCSLrp2tVuyA#DatasetDefinitionAPI "Die Datendefinition API stellt Methoden zur Identifizierung bereit Ein Satz von Datensätzen, einschließlich Tabellenname, Spalten und Zeilenauswahlkriterien, die als Eingabe für ML-Trainingsalgorithmen verwendet werden sollen. Datensätze enthalten nicht die tatsächlichen Daten.")API.
2. Obligatorisch, wenn der K-Means-Clustering-Algorithmus verwendet wird. Erstellen Sie einen Encoder mit [Encoder](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#EncoderAPI "Die Encoder Die API stellt ein skriptfähiges Objekt bereit, das in verwendet wird Predictive IntelligenceSpeichert. Dieses Objekt konvertiert Eingabedaten in Zahlenvektoren basierend auf Encoder-spezifischen Zielen und Konfigurationen. Encoder können unabhängig voneinander verwendet werden, um Codierungen auszuführen, oder können als Teil von Lösungen zum Codieren von Textspalten konfiguriert werden.")API.
3. Verwenden Sie [Konstruktor](https://servicenow-prod.fluidtopics.net/QZIIopgS3YcqyOlnAMV4eQ#ClusteringSol-ClusteringSolution_O "Erstellt eine Clusterlösung.")Dient zum Erstellen eines Clustering-Lösungsobjekts.
4. Fügen Sie das Lösungsobjekt dem Clustering-Lösungsspeicher mit hinzu [ClusteringSolutionStore -- add()](https://servicenow-prod.fluidtopics.net/4XlOm9_NK3xarXS1BNEk2w#ClusteringStore-add_O "Fügt eine neue Lösung hinzu Objekt für den Store und gibt einen eindeutigen Namen zurück.")Methode.
5. Trainieren Sie die Lösung mit [SubmitTrainingJob()](https://servicenow-prod.fluidtopics.net/QZIIopgS3YcqyOlnAMV4eQ#ClusteringSol-submitTrainingJob "Übermittelt einen Schulungsauftrag.")Methode. Dadurch wird eine Version des Objekts erstellt, das Sie mit verwalten können [ClusteringSolutionVersion](https://servicenow-prod.fluidtopics.net/v6lfpEVJeu5oMoc00YkHdw#ClusteringSolutionVersionAPI "Die ClusteringSolutionVersion API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.")API.
6. Rufen Sie Vorhersagen mit ab [ClusteringSolutionVersion -- Predict()](https://servicenow-prod.fluidtopics.net/v6lfpEVJeu5oMoc00YkHdw#C-predict_O_O "Ruft die Eingabedaten für eine Vorhersage ab.")Methode.

{#ClusteringSolutionAPI__ol_mmm_n1c_dmb}  
Hinweis:  
Diese API wird ausgeführt Mit vollständigen Berechtigungen vor Washington DCPatch 7-Release. Gewähren Sie nach diesem Release Zugriff mithilfe von ACLs. Weitere Informationen finden Sie unter [Query ACLs](https://www.servicenow.com/docs/access?context=query-acl-rule&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US).

Nutzungsrichtlinien finden Sie unter [Mit ML-APIs](https://www.servicenow.com/docs/access?context=using-ml-apis&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US).

## ClusteringSolution -- ClusteringSolution (Objektkonfiguration) {#ariaid-title2}

Erstellt eine Clusterlösung.
{#ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb__entry__3}{#ClusteringSol-ClusteringSolution_O__cluster-dbscan-distanceM-vals}{#ClusteringSol-ClusteringSolution_O__cluster-dbscan-epsilon-desc}{#ClusteringSol-ClusteringSolution_O__cluster-dbscan-minNeighbs-desc}{#ClusteringSol-ClusteringSolution_O__cluster-kmeans-targetC-desc}{#ClusteringSol-ClusteringSolution_O__solution-obj-domainN-default}{#ClusteringSol-ClusteringSolution_O__solution-cluster-minrec-desc}{#ClusteringSol-ClusteringSolution_O__solution-obj-stop-desc}

| Name | Typ | Beschreibung |
|-|-|-|
| Konfiguration | Objekt | JavaScript-Objekt, das Konfigurationseigenschaften von enthält Lösung. { "algorithmConfig": {Object}, "clusterConcept": "String", "clusterConceptFieldNames": [Array], "dataset": {Object}, "domainName": "String", "encoder": {Object}, "groupByFieldName": "String", "groupUnclusteredRecords": Boolean, "inputFieldNames": [Array], "label": "String", "maxTimeWindowForUpdate" : Number, "minRecordsPerCluster" : Number, "minRowCount": "String", "processingLanguage": "String", "stopwords": [Array], "trainingFrequency": "String", "updateFrequency": "String" } |
| Config.algorithmConfig | Objekt | Erforderlich, es sei denn, Sie legen fest encoderEigenschaft. JavaScript-Objekt mit Algorithmuskonfigurationseigenschaften.Eigenschaftseinstellungen variieren je nach Wert, der in festgelegt ist algorithmEigenschaft. 'algorithmConfig': { "algorithm": "String", // See algorithmConfig.algorithm setting description for property settings based on algorithm } |
| Config.algorithmConfig.algorithmus | Zeichenfolge | Methode zum Codieren Ihrer Lösung. Gültige Werte: * dbscan -- Dichte-basiertes räumliches Clustering von Anwendungen mit Rauschen (DBSCAN)-Clustering-Algorithmus. Mit diesem Algorithmus verwendete Eigenschaften: * distanceMetric * epsilon * minimumNeighbours {#ClusteringSol-ClusteringSolution_O__ul_cfy_mkk_xlb} * hdbscan -- Clustering-Algorithmus für hierarchisch dichtebasiertes räumliches Clustering von Anwendungen mit Rauschen (HDBSCAN). Mit diesem Algorithmus verwendete Eigenschaften: * minimumSamples {#ClusteringSol-ClusteringSolution_O__ul_o3n_zcw_wnb} * kmeans -- K-Means-Clustering-Algorithmus. Standard. Die targetCoverageEigenschaft wird mit diesem Algorithmus verwendet. {#ClusteringSol-ClusteringSolution_O__ul_wtd_l2k_xlb} Einige Anwender bevorzugen DBSCAN, da Sie vor dem Clustering nicht die Anzahl der Cluster in den Daten angeben müssen. Eigenschaften für dbscan: 'algorithmConfig': { "algorithm": "dbscan", "distanceMetric": "String", "epsilon": Number, "minimumNeighbours": Number } Eigenschaften für hdbscan: 'algorithmConfig': { "algorithm": "hdbscan", "minimumSamples": Number } Eigenschaften für kmeans: 'algorithmConfig': { "algorithm": "kmeans", "targetCoverage": Number } |
| Config.algorithmConfig.distanceMetrik | Zeichenfolge | Nur DBSCAN-Algorithmus. Entfernungsmetrik zum Scannen nach ähnlichen Datenobjekten. Gültige Werte: levenshteinDistance |
| Config.algorithmConfig.epsilon | Nummer | Nur DBSCAN-Algorithmus. Dezimalwert zwischen 0 und 1, der die Größe des Suchradius des Arbeitsbereichs darstellt. |
| Config.algorithmConfig.minimumNeighbours | Nummer | Nur DBSCAN-Algorithmus. Mindestanzahl von Nachbarn, die in einem Punkt erforderlich sind, um Teil eines Clusters zu sein. Für levenshteinDistanceDer Wert muss 1 sein, damit keine Punkte aus dem Datensatz ausgeschlossen werden. |
| Config.algorithmConfig.minimumSamples | Nummer | Mindestanzahl von Datenbeispielen in einem Arbeitsbereich, die erforderlich sind, um zu bestimmen, ob ein Punkt ein Kernpunkt ist. Standard: Keine |
| Config.algorithmConfig.targetCoverage | Nummer | Nur K-Means-Algorithmus. Perzentilfeld zum Herausfiltern von Datensätzen, die einander weniger ähnlich sind. |
| Config.clusterConcept | Zeichenfolge | Optional. Konzepttyp. Ein Konzept ist eine Reihe von Wörtern, die in absteigender Reihenfolge der Häufigkeit aufgeführt sind. Um ein TFIDF-basiertes Clusterkonzept zu generieren, legen Sie den Wert auf fest `Tfidf `. Konzepttypen werden in der Tabelle „Clustering-Definitionen" \[ml_capability_definition_clustering\] aufgeführt. Standard: Häufigkeitsbasiertes Clusterkonzept |
| Config.clusterConceptFeldNamen | Array | Optional. Liste der Feldnamen des Clusterkonzepts. Diese Werte sind externe Spalten zum Erstellen eines Clusterkonzepts und werden nicht für Cluster-Lösungsschulungen verwendet. Wenn externe Spalten angegeben werden, werden diese Spalten nur für das Clusterkonzept und nicht für das Training der Clustering-Lösung verwendet. Cluster-Konzeptfelder werden in der Tabelle „Clustering-Definitionen" \[ml_capability_definition_clustering\] aufgeführt. Standard: Eingabetextspalten generieren das Clusterkonzept |
| Config.datensatz | Objekt | [Datendefinition](https://servicenow-prod.fluidtopics.net/P8pkp_FhlIJCSLrp2tVuyA#DatasetDefinitionAPI "Die Datendefinition API stellt Methoden zur Identifizierung bereit Ein Satz von Datensätzen, einschließlich Tabellenname, Spalten und Zeilenauswahlkriterien, die als Eingabe für ML-Trainingsalgorithmen verwendet werden sollen. Datensätze enthalten nicht die tatsächlichen Daten.")Objektname. |
| Config.domainName | Zeichenfolge | Optional. Domänenname, der diesem Datensatz zugeordnet ist. Siehe [Domänentrennung und Predictive Intelligence](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US). Standard: Aktuelle Domäne, z. B. `„Global" `. |
| Config.encoder | Objekt | Erforderlich, es sei denn, Sie legen fest algorithmConfigEigenschaft bis `„LevenshteinDistance" `. Trainiertes Encoderobjekt, das dieser Lösung zugewiesen werden soll.Siehe [Encoder -- Encoder (Objektkonfiguration)](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-Encoder_O "Erstellt einen Encoder."). |
| config.groupByFieldName | Zeichenfolge | Optional. Feldname, nach dem das System Datensätze in einem oder mehreren Clustern gruppiert. Im folgenden Setup-Beispiel gruppiert das System jeden Typ in einem einzelnen Cluster, wobei 10 Cluster gerendert werden. * groupByFieldNameWert ist `„Kategorie" ` * [Datendefinition](https://servicenow-prod.fluidtopics.net/P8pkp_FhlIJCSLrp2tVuyA#DatasetDefinitionAPI "Die Datendefinition API stellt Methoden zur Identifizierung bereit Ein Satz von Datensätzen, einschließlich Tabellenname, Spalten und Zeilenauswahlkriterien, die als Eingabe für ML-Trainingsalgorithmen verwendet werden sollen. Datensätze enthalten nicht die tatsächlichen Daten.") tableNameWert ist `„Incident" ` * Die Tabelle „Incident \[Incident\]" hat 10 Kategorietypen {#ClusteringSol-ClusteringSolution_O__ul_bt4_y3h_dmb} |
| config.groupUnclusteredRecords | Boolean | Kennzeichnung, die angibt, ob nicht gruppierte Datensätze in Ergebnissen gruppiert werden sollen. Gültige Werte: * Wahr: Gruppieren Sie nicht gruppierte Datensätze separat in Ergebnissen. * Falsch: Gruppieren Sie nicht gruppierte Datensätze in Ergebnissen. Nicht gruppierte Werte (-1) werden mit den restlichen Ergebnissen angezeigt. {#ClusteringSol-ClusteringSolution_O__ul_ar4_blq_wnb} Standard: Falsch |
| config.inputFieldNames | Array | Liste der Eingabefeldnamen als Zeichenfolgen. Das Modell verwendet diese Felder, die für Vorhersagen verwendet werden. |
| Config.label | Zeichenfolge | Gibt die Vorhersageaufgabe an. |
| Config.maxTimeWindowForUpdate | Nummer | Optional. Anzahl der Minuten vor dem Modellaktualisierungspunkt, um nach Datensätzen zu suchen. Wenn der Wert beispielsweise 15 ist, sucht das System nur nach Datensätzen, die in den vorherigen 15 Minuten erstellt wurden. Standardmäßig scannt das System alle Datensätze. |
| Config.minRecordsPerCluster | Nummer | Optional. Mindestanzahl von Datensätzen, die in einem Cluster zugelassen werden sollen. Der Wert muss größer oder gleich 2 sein. Standard: 2 |
| Config.minZeilenanzahl | Zeichenfolge | Optional. Mindestanzahl von Datensätzen, die im Datensatz für das Training erforderlich sind. Standard: 10000 |
| config.processingLanguage | Zeichenfolge | Sprache wird im zweistelligen ISO 639-1-Sprachcodeformat verarbeitet. |
| Config.stopwords | Array | Optional. Voreingestellte Liste von Zeichenfolgen, die das System automatisch basierend auf generiert languageEigenschaftseinstellung. Weitere Informationen finden Sie unter [Erstellen Sie eine anwenderdefinierte Stoppwortliste](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US). Standard: Englische Stoppwörter |
| Config.trainingHäufigkeit | Zeichenfolge | Die Häufigkeit zum erneuten Trainieren des Modells. Mögliche Werte: * Every_30_days * Every_60_days * Every_90_days * Every_120_days * Every_180_days * Run_once {#ClusteringSol-ClusteringSolution_O__ul_pmw_523_plb}Standard: Run_once |
| Config.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 {#ClusteringSol-ClusteringSolution_O__ul_kjm_2jh_3mb}Standard: Do_not_Update |
[Tabelle : 1. Parameter]

{#ClusteringSol-ClusteringSolution_O__table_gm2_yt5_flb}  
Das folgende Beispiel zeigt, wie ein Objekt erstellt und zu hinzugefügt wird ClusteringSolution Store. Das Beispiel zeigt auch, wie das Objekt zum Training übermittelt wird.

    try{
        var myData = new sn_ml.DatasetDefinition({
            'tableName' : 'incident',
            'fieldNames' : ['category', 'short_description', 'state', 'description'],
            'encodedQuery' : 'activeANYTHING'
        });

        // get a trained encoder from the store
        var myEncoder = sn_ml.EncoderStore.get('<encoder_name >');
            
        var mySolution = new sn_ml.ClusteringSolution({
            'label': "clustering solution",
            'dataset' : myData,
            'encoder' : myEncoder,
            'inputFieldNames':['short_description'],                
            'groupByFieldName' : 'category',        
            'algorithmConfig' : {
                'algorithm' : 'kmeans',
                'targetCoverage' : '90'
            }
        });
        
        // add solution
        var solutionName = sn_ml.ClusteringSolutionStore.add(mySolution);
        var solutionVersion = mySolution.submitTrainingJob();    
        var trainingStatus = solutionVersion.getStatus();
        gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));
    ​
    } catch(ex){
        gs.print('Exception caught: '+ ex.getMessage());
    }

Ausgabe:

    {
      "state": "waiting_for_training",
      "percentComplete": "0",
      "hasJobEnded": "false"
    }

Das folgende Beispiel zeigt, wie das Feld „Beschreibung" als Clusterkonzeptfeld eingeschlossen wird.

    var myIncidentData = new sn_ml.DatasetDefinition({
        'tableName' : 'incident',
        'fieldNames' : ['category', 'short_description', 'description'],
    });

    var encodersolutionName = sn_ml.EncoderStore.get('<encoder_name >');

    var mySolution = new sn_ml.ClusteringSolution({
    	'label': 'clustering_test',
    	'dataset': myIncidentData,
    	'inputFieldNames': ['short_description'],
    	'encoder': encodersolutionName,
    	'clusterConceptFieldNames': ['description']
    });

    var solutionNameFromStore = sn_ml.ClusteringSolutionStore.add(mySolution);
    var myClassifier = mySolution.submitTrainingJob(); 

## ClusteringSolution -- cancelTrainingJob() {#ariaid-title3}

Bricht einen Auftrag für ab Ein Lösungsobjekt Das zum Training übermittelt wurde.
{#ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 2. Parameter]

{#ClusteringSol-cancelTrainingJob__table_bpb_k3z_llb} {#ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Rückgaben]

{#ClusteringSol-cancelTrainingJob__table_cpb_k3z_llb}  
Das folgende Beispiel zeigt, wie ein vorhandener Schulungsauftrag abgebrochen wird.

    var mySolution = sn_ml.ClusteringSolutionStore.get('ml_sn_global_global_clustering');

    mySolution.cancelTrainingJob();

## ClusteringSolution -- getActiveVersion() {#ariaid-title4}

Ruft die aktiven ab ClusteringSolutionVersion-Objekt.
{#ClusteringSol-getActiveVersion__table_tvl_m3z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 4. Parameter]

{#ClusteringSol-getActiveVersion__table_tvl_m3z_llb} {#ClusteringSol-getActiveVersion__table_uvl_m3z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Aktiv [ClusteringSolutionVersion](https://servicenow-prod.fluidtopics.net/v6lfpEVJeu5oMoc00YkHdw#ClusteringSolutionVersionAPI "Die ClusteringSolutionVersion API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.")Objekt. |
[Tabelle : 5. Rückgaben]

{#ClusteringSol-getActiveVersion__table_uvl_m3z_llb}  
Das folgende Beispiel zeigt, wie ein aktiver abgerufen wird ClusteringSolution Version aus dem Store und gibt den Schulungsstatus zurück.

    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');

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

Ausgabe:

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

## ClusteringSolution -- getAllVersions() {#ariaid-title5}

Ruft alle Versionen von ab Eine Clustering-Lösung.
{#ClusteringSol-getAllVersions__table_tvl_m3z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 6. Parameter]

{#ClusteringSol-getAllVersions__table_tvl_m3z_llb} {#ClusteringSol-getAllVersions__table_uvl_m3z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Array | Vorhandene Versionen eines Lösungsobjekts. Siehe auch [ClusteringSolutionVersion](https://servicenow-prod.fluidtopics.net/v6lfpEVJeu5oMoc00YkHdw#ClusteringSolutionVersionAPI "Die ClusteringSolutionVersion API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.")API. |
[Tabelle : 7. Rückgaben]

{#ClusteringSol-getAllVersions__table_uvl_m3z_llb}  
Das folgende Beispiel zeigt, wie alle abgerufen werden ClusteringSolution Versionsobjekte und rufen Sie auf GetVersionNumber() Und GetStatus() Lösungsversionsmethoden darauf.

    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');

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

## ClusteringSolution -- getLatestVersion() {#ariaid-title6}

Ruft die neueste Version von ab Eine Lösung.
{#ClusteringSol-getLatestVersion__table_tvl_m3z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 8. Parameter]

{#ClusteringSol-getLatestVersion__table_tvl_m3z_llb} {#ClusteringSol-getLatestVersion__table_uvl_m3z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | [ClusteringSolutionVersion](https://servicenow-prod.fluidtopics.net/v6lfpEVJeu5oMoc00YkHdw#ClusteringSolutionVersionAPI "Die ClusteringSolutionVersion API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.") Objekt, das der neuesten Version von entsprichtA [ClusteringSolution()](https://servicenow-prod.fluidtopics.net/QZIIopgS3YcqyOlnAMV4eQ#ClusteringSol-ClusteringSolution_O "Erstellt eine Clusterlösung."). |
[Tabelle : 9. Rückgaben]

{#ClusteringSol-getLatestVersion__table_uvl_m3z_llb}  
Das folgende Beispiel zeigt, wie Sie die neueste Version von abrufen Eine Lösung und gibt ihren Schulungsstatus zurück.{#ClusteringSol-getLatestVersion__mlsol-getLatestVersion-example}

    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');

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

Ausgabe:

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

## ClusteringSolution -- getName() {#ariaid-title7}

Ruft den Namen des Objekts ab, das für die Interaktion mit dem Store verwendet werden soll.
{#ClusteringSol-getName__table_pps_43z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 10. Parameter]

{#ClusteringSol-getName__table_pps_43z_llb} {#ClusteringSol-getName__table_qps_43z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Name des Lösungsobjekts. |
[Tabelle : 11. Rückgaben]

{#ClusteringSol-getName__table_qps_43z_llb}  
Das folgende Beispiel zeigt, wie aktualisiert wird ClusteringSolution Datensatzinformationen, und drucken Sie den Namen des Objekts aus.

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

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

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

    // update solution
    sn_ml.ClusteringSolutionStore.update('ml_x_snc_global_global_clustering_solution', myCluster);

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

Ausgabe:

    Solution Name: ml_x_snc_global_global_clustering_solution

## ClusteringSolution -- getProperties() {#ariaid-title8}

Ruft Lösungsobjekteigenschaften ab.
{#ClusteringSol-getProperties__table_pps_43z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 12. Parameter]

{#ClusteringSol-getProperties__table_pps_43z_llb} {#ClusteringSol-getProperties__table_qps_43z_llb__entry__2}{#ClusteringSol-getProperties__solution-obj-group-desc}

| Typ | Beschreibung |
|-|-|
| Objekt | Inhalt des Datensatzes und [ClusteringSolution()](https://servicenow-prod.fluidtopics.net/QZIIopgS3YcqyOlnAMV4eQ#ClusteringSol-ClusteringSolution_O "Erstellt eine Clusterlösung.")Objektdetails in [ClusteringSolutionStore](https://servicenow-prod.fluidtopics.net/4XlOm9_NK3xarXS1BNEk2w#ClusteringSolutionStoreAPI "Aktiviert das Speichern und Abrufen Lösungen."). { "algorithmConfig": {Object}, "datasetProperties": {Object}, "domainName": "String", "encoder": {Object}, "groupByFieldName": "String", "inputFieldNames": [Array], "label": "String", "minRecordsPerCluster" : Number, "name": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String", "updateFrequency": "String" } |
| \<Object\>.AlgorithmConfig | JavaScript-Objekt mit Algorithmuskonfigurationseigenschaften.Eigenschaftsergebnisse variieren je nach Wert, der in festgelegt ist algorithmEigenschaft. 'algorithmConfig' : { "algorithm": "String", // See algorithmConfig.algorithm setting description for property settings based on algorithm } Datentyp: Objekt. |
| \<Object\>.AlgorithmConfig.algorithmus | Methode zum Codieren Ihrer Lösung. Eigenschaften für dbscan: 'algorithmConfig': { "algorithm": "dbscan", "distanceMetric": "String", "epsilon": Number, "minimumNeighbours": Number } Eigenschaften für kmeans: 'algorithmConfig': { "algorithm": "kmeans", "targetCoverage": Number } Datentyp: Zeichenfolge. |
| \<Object\>.AlgorithmConfig.distanceMetric | Nur DBSCAN-Algorithmus. Entfernungsmetrik zum Scannen nach ähnlichen Datenobjekten. Datentyp: Zeichenfolge. |
| \<Object\>.AlgorithmConfig.epsilon | Nur DBSCAN-Algorithmus. Dezimalwert zwischen 0 und 1, der die Größe des Suchradius des Arbeitsbereichs darstellt. Datentyp: Zahl. |
| \<Object\>.AlgorithmConfig.minimumNeighbours | Nur DBSCAN-Algorithmus. Mindestanzahl von Nachbarn, die in einem Punkt erforderlich sind, um Teil eines Clusters zu sein. Für levenshteinDistanceDer Wert muss 1 sein, damit keine Punkte aus dem Datensatz ausgeschlossen werden. Datentyp: Zahl. |
| \<Object\>.AlgorithmConfig.targetCoverage | Nur K-Means-Algorithmus. Perzentilfeld zum Herausfiltern von Datensätzen, die einander weniger ähnlich sind. Datentyp: Zahl. |
| \<Object\>.DatasetProperties | Listet die Eigenschaften von auf [Datendefinition()](https://servicenow-prod.fluidtopics.net/P8pkp_FhlIJCSLrp2tVuyA#DDef-DatasetDefinition_O "Erstellt eine Instanz von Datendefinition Klasse, mit der Sie einen Datensatz nach Tabellenname, Feldern und Abfrage definieren können.")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\>.DatasetProperties.Feldnamen | Liste der Feldnamen aus der angegebenen Tabelle als Zeichenfolgen. Beispiel: `„Feldnamen": ["short_description", "Priorität"] `. Datentyp: Array. |
| \<Object\>.DatasetProperties.fieldnames.fieldDetails | Liste der JavaScript-Objekte, die Feldeigenschaften angeben. [ { "name": "String", "type": "String" } ] Datentyp: Array. |
| \<Object\>.DatasetProperties.fieldnames.fieldDetails. \<object\>.Name | Name des Felds, das den Typ der Informationen definiert, auf die dieser Datensatz beschränkt werden soll. Datentyp: Zeichenfolge. |
| \<Object\>.DatasetProperties.fieldDetails. \<object\>.Typ | Feldtyp für maschinelles Lernen. Datentyp: Zeichenfolge. |
| \<Object\>.DatasetProperties.fieldDetails.encodedQuery | Codierte Abfragezeichenfolge im Standard-Glide-Format. Siehe [Codierte Abfragezeichenfolgen](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). Datentyp: Zeichenfolge. |
| \<Object\>.Domänenname | Domänenname, der diesem Datensatz zugeordnet ist. Siehe [Domänentrennung und Predictive Intelligence](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US). Datentyp: Zeichenfolge. |
| \<Object\>.EncoderEigenschaften | Encoderobjekt, das dieser Lösung zugewiesen ist.Siehe [Encoder -- Encoder (Objektkonfiguration)](https://servicenow-prod.fluidtopics.net/ncoTmwylbzXEwXVmPzAZcw#Encoder-Encoder_O "Erstellt einen Encoder."). Datentyp: Objekt. |
| \<Object\>.GroupByFieldName | Feldname, nach dem das System Datensätze in einem oder mehreren Clustern gruppiert. Datentyp: Zeichenfolge |
| \<Object\>.InputFieldNames | Liste der Eingabefeldnamen als Zeichenfolgen. Das Modell verwendet diese Felder, die für Vorhersagen verwendet werden. Datentyp: Zeichenfolge. |
| \<Object\>.Bezeichnung | Gibt die Vorhersageaufgabe an. { "label": "my first prediction" } Datentyp: Zeichenfolge. |
| \<Object\>.MinRecordsPerCluster | Mindestanzahl von Datensätzen, die in einem Cluster zugelassen werden sollen. Datentyp: Zahl. |
| \<Object\>.Name | Vom System zugewiesener Name. Datentyp: Zeichenfolge. |
| \<Object\>.PredictedFieldName | Gibt ein Feld an, das auf Vorhersehbarkeit 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](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=yokohama&pubname=yokohama-intelligent-experiences&ft:locale=en-US). Datentyp: Array. |
| \<Object\>.TrainingHäufigkeit | Die Häufigkeit zum erneuten Trainieren des Modells. Mögliche Werte: * Every_30_days * Every_60_days * Every_90_days * Every_120_days * Every_180_days * Run_once {#ClusteringSol-getProperties__ul_pmw_523_plb}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 * Every_1_day * Every_1_Hour * Every_6_hours * Every_12_hours * Jede_1_Minute * Alle_15_Minuten * Alle_30_Minuten {#ClusteringSol-getProperties__ul_kjm_2jh_3mb}Standard: Do_not_Update Datentyp: Zeichenfolge |
[Tabelle : 13. Rückgaben]

{#ClusteringSol-getProperties__table_qps_43z_llb}  
Das folgende Beispiel ruft Eigenschaften von ab Ein Lösungsobjekt Im Store. {#ClusteringSol-getProperties__mlsol-getProps-example-other2}

    var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");

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

Ausgabe:

    *** Script: {
      "algorithmConfig": {
        "algorithm": "kmeans",
        "targetCoverage": "90"
      },
      "datasetProperties": {
        "tableName": "incident",
        "fieldNames": [
          "category",
          "short_description",
          "state",
          "description"
        ],
        "encodedQuery": "activeANYTHING"
      },
      "domainName": "global",
      "encoderProperties": {
        "datasetsProperties": [
          {
            "tableName": "incident",
            "fieldNames": [
              "assignment_group",
              "short_description",
              "description"
            ],
            "encodedQuery": "activeANYTHING"
          }
        ],
        "domainName": "global",
        "label": "my encoder definition",
        "name": "ml_x_snc_global_global_my_encoder_definition",
        "processingLanguage": "en",
        "scope": "global",
        "stopwords": [
          "Default English Stopwords"
        ],
        "trainingFrequency": "run_once"
      },
      "groupByFieldName": "category",
      "inputFieldNames": [
        "short_description"
      ],
      "label": "clustering solution",
      "minRecordsPerCluster": 2,
      "name": "ml_x_snc_global_global_clustering_solution",
      "processingLanguage": "en",
      "scope": "global",
      "stopwords": [
        "Default English Stopwords"
      ],
      "trainingFrequency": "run_once",
      "updateFrequency": "do_not_update"
    }}

## ClusteringSolution -- getVersion (Zeichenfolgenversion) {#ariaid-title9}

Ruft eine Lösung ab Nach angegebener Versionsnummer.
{#ClusteringSol-getVersion_S__table_pps_43z_llb__entry__3}{#ClusteringSol-getVersion_S__mlsol-gerversion-returns-other}

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

{#ClusteringSol-getVersion_S__table_pps_43z_llb} {#ClusteringSol-getVersion_S__table_qps_43z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Angegebene Version von [ClusteringSolution()](https://servicenow-prod.fluidtopics.net/QZIIopgS3YcqyOlnAMV4eQ#ClusteringSol-ClusteringSolution_O "Erstellt eine Clusterlösung.")Objekt, für das Sie anrufen können [ClusteringSolutionVersion](https://servicenow-prod.fluidtopics.net/v6lfpEVJeu5oMoc00YkHdw#ClusteringSolutionVersionAPI "Die ClusteringSolutionVersion API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.")API-Methoden. |
[Tabelle : 15. Rückgaben]

{#ClusteringSol-getVersion_S__table_qps_43z_llb}  
Das folgende Beispiel zeigt, wie der Schulungsstatus von abgerufen wird Eine Lösung nach Versionsnummer.{#ClusteringSol-getVersion_S__mlsol-gerversion-example-other}

    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering');

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

Ausgabe:

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

## ClusteringSolution -- setActiveVersion (Zeichenfolgenversion) {#ariaid-title10}

Aktiviert eine angegebene Version einer Lösung im Store.
{#ClusteringSol-setActiveVersion_S__table_pps_43z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Version | Zeichenfolge | Name von [ClusteringSolution()](https://servicenow-prod.fluidtopics.net/QZIIopgS3YcqyOlnAMV4eQ#ClusteringSol-ClusteringSolution_O "Erstellt eine Clusterlösung.")Zu aktivierende Objektversion. Durch Aktivieren dieser Version wird jede andere Version deaktiviert. |
[Tabelle : 16. Parameter]

{#ClusteringSol-setActiveVersion_S__table_pps_43z_llb} {#ClusteringSol-setActiveVersion_S__table_qps_43z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. Rückgaben]

{#ClusteringSol-setActiveVersion_S__table_qps_43z_llb}  
Das folgende Beispiel zeigt, wie aktiviert wird Eine Lösung Version im Store. {#ClusteringSol-setActiveVersion_S__mlsol-setActive-example2}

    sn_ml.ClusteringSolution.setActiveVersion("ml_incident_categorization");

## ClusteringSolution -- submitTrainingJob() {#ariaid-title11}

Übermittelt einen Schulungsauftrag.
Hinweis:  
Bevor Sie diese Methode ausführen, müssen Sie dem Store zuerst eine Lösung hinzufügen, indem Sie verwenden [ClusteringSolutionStore -- add()](https://servicenow-prod.fluidtopics.net/4XlOm9_NK3xarXS1BNEk2w#ClusteringStore-add_O "Fügt eine neue Lösung hinzu Objekt für den Store und gibt einen eindeutigen Namen zurück.")Methode.
{#ClusteringSol-submitTrainingJob__table_xmd_33z_llb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 18. Parameter]

{#ClusteringSol-submitTrainingJob__table_xmd_33z_llb} {#ClusteringSol-submitTrainingJob__table_ymd_33z_llb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | [ClusteringSolutionVersion](https://servicenow-prod.fluidtopics.net/v6lfpEVJeu5oMoc00YkHdw#ClusteringSolutionVersionAPI "Die ClusteringSolutionVersion API ist ein skriptfähiges Objekt, das in verwendet wird Predictive IntelligenceSpeichert.") Objekt, das dem entspricht [ClusteringSolution](https://servicenow-prod.fluidtopics.net/QZIIopgS3YcqyOlnAMV4eQ#ClusteringSol-ClusteringSolution_O "Erstellt eine Clusterlösung.") Wird trainiert. |
[Tabelle : 19. Rückgaben]

{#ClusteringSol-submitTrainingJob__table_ymd_33z_llb}  
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. {#ClusteringSol-submitTrainingJob__mlsol-submit-example-nonSol2}

    // Create a dataset 
    var myData = new sn_ml.DatasetDefinition({

      'tableName' : 'incident',
      'fieldNames' : ['assignment_group', 'short_description', 'description'],
      'encodedQuery' : 'activeANYTHING'

    });

    // get a trained encoder from the store
    var myEncoder = sn_ml.EncoderStore.get('ml_x_snc_global_global_encoder');

    // Create a solution 
    var mySolution = new sn_ml.ClusteringSolution({

      'label': "my solution definition",
      'dataset' : myData,
      'encoder' : myEncoder,
      '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.ClusteringSolutionStore.add(mySolution);

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


