---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# MLLösung : Global

# MLLösung : Global {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 5 Minuten Lesedauer

Die MLSolution- API bietet Methoden zum Verarbeiten von Predictive Intelligence -Vorhersagen und zum Abrufen von Lösungsobjekten für alle Fähigkeiten: Ähnlichkeit, Klassifizierung und Clustering.  
Diese API bietet Methoden, die häufig unter allen Lösungsfunktionen verwendet werden, sowie Methoden, die speziell für Klassifizierungs- und Clustering-Lösungen gelten.

* Gängige Methoden für alle Lösungsobjekte:
  * getCapability ()
  * getVersion ()
  * istAktiv ()
  * vorhersagen ()
  {#MLSolutionAPI__ul_uyg_bjy_xjb}
* Methoden, die nur für Klassifizierungs- und Regressionslösungen verwendet werden:
  * anwendenVorhersage ()
  {#MLSolutionAPI__ul_wls_bjy_xjb}
* Methoden, die nur für das Clustering von Lösungen verwendet werden:
  * abrufenClusterZuweisungen ()
  * abrufenClusterFürDatensatz ()
  * abrufenClusterInfo()
  {#MLSolutionAPI__ul_j35_bjy_xjb}
{#MLSolutionAPI__ul_cd1_1jy_xjb}

Die ML-Lösung Die API erfordert das Plugin Predictive Intelligence (com.glide.platform_ml) und wird im Namespace `sn_ml` bereitgestellt.

Die Methoden in diesem Objekt werden mit [MLSolutionFactory](https://www.servicenow.com/docs/rrGjU8GwlFMdKqkTyFvYZA#MLSolutionFactoryAPI "Die MLSolutionFactory- API ist eine Factory-Klasse zum Abrufen eines skriptfähigen MLSolution-Objekts.")instanziiert.{#MLSolutionAPI__classInstantMLSF}
**Zugehörige Konzepte**   

* [MLSolutionUtil](https://www.servicenow.com/docs/LCqp4D5nnp7uPFjq5N6~pw#MLSolutionUtilAPI "Die MLSolutionUtil-Skripteinbindung bietet Methoden zum Abrufen von Predictive Intelligence -Vorhersagen.")
* [REST API: Vorhersagen für mehrere Lösungen abrufen](https://www.servicenow.com/docs/D81qF7gvrsOasAqwDt0~FA#agent-intelligence-api "Die Predictive Intelligence -API stellt Endpunkte bereit, die einen Feldwert basierend auf einem oder mehreren Eingabefeldern und einer trainierten Lösung vorhersagen.")

## MLSolution -- anwenden von Prediction(GlideRecord now_GR) {#ariaid-title2}

Ruft das Vorhersageergebnis für eine Klassifizierungslösung ab und wendet es auf den Eingabe-GlideRecord an, wenn der Konfidenzwert höher als der Schwellenwert ist.
{#MLSolution-applyPrediction_GR__table_hqw_pbm_yfb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| now_GR | GlideRecord | GlideRecord-Objekt, das Werte enthält, für die eine Vorhersage ausgeführt und die Ergebnisse angewendet werden sollen. |
[Tabelle : 1. Parameter]

{#MLSolution-applyPrediction_GR__table_hqw_pbm_yfb} {#MLSolution-applyPrediction_GR__table_iqw_pbm_yfb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die Vorhersage angewendet wurde: * true: Vorhersage angewendet * false: Vorhersage abgelehnt {#MLSolution-applyPrediction_GR__ul_pvl_ggm_ckb} |
[Tabelle : 2. Ergebnisse]

{#MLSolution-applyPrediction_GR__table_iqw_pbm_yfb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("ml_incident_categorization");

    var inputGR = new GlideRecord("incident");
    inputGR.get("0ef47232db801300864adfea5e961912");

    mlSolution.applyPrediction(inputGR);

## MLLösung -- getCapability() {#ariaid-title3}

Ruft die Fähigkeitsinformationen einer trainierten Lösung ab.
{#MLSolution-getCapability__table_em3_pfx_ggb__entry__3}

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

{#MLSolution-getCapability__table_em3_pfx_ggb} {#MLSolution-getCapability__table_fm3_pfx_ggb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Typ der trainierten Lösung. Mögliche Werte: * Ähnlichkeit * Klassifizierung * Clustering {#MLSolution-getCapability__ul_sv5_slm_ckb} |
[Tabelle : 4. Ergebnisse]

{#MLSolution-getCapability__table_fm3_pfx_ggb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("ml_x_global_clustering");

    // configure optional parameters
    var options = {};
    options.group_by = 'network';
    options.cluster_id = 1;
    options.top_n_per_cluster = 3;

    if (mlSolution.getCapability() == 'clustering') {
    	var results = mlSolution.getClusterAssignments(options);
    	// pretty print JSON results
    	gs.print(JSON.stringify(JSON.parse(results), null, 2));
    }

## MLSolution -- getClusterAssignments (Objektoptionen) {#ariaid-title4}

Ruft Zuweisungen für eine Clusterlösung ab.
{#MLSolution-getClusterAssignments_O__table_t1q_hxt_rhb__entry__3}{#MLSolution-getClusterAssignments_O__ml-cluster-create-xbl}

| Name | Typ | Beschreibung |
|-|-|-|
| Optionen | Objekt | Optional. Werte, die zum Eingrenzen der zurückgegebenen Ergebnisse nach Gruppe und Ebene in einer Clusterlösung verwendet werden. Standard: Gibt Clustermitgliedschaften für alle Cluster zurück. |
| Optionen.Gruppe_Nach | Zeichenfolge | Optional. Gibt das Segmentierungsfeld an, für das Clustermitgliedschaften abgerufen werden sollen, z. B. assignment_group. Dieses Feld bietet die gleiche Gruppierung wie Optionen im Kontrollkästchen Gruppe verwenden nach im Formular „ Clustering-Definition ". Die bereitgestellten Informationen variieren je nach der im Feld Tabelle ausgewählten Tabelle. Weitere Informationen finden Sie unter [Clusterlösung erstellen und trainieren](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US) . |
| Optionen.Cluster_ID | Zeichenfolge | Optional. Cluster-ID einer trainierten Lösung in der Tabelle „Clusterzusammenfassung" \[ml_cluster_summary\]. |
| options.top_n_per_cluster | Nummer | Anzahl der besten Ergebnisse, die für jedes Cluster empfangen werden sollen. |
[Tabelle : 5. Parameter]

{#MLSolution-getClusterAssignments_O__table_t1q_hxt_rhb} {#MLSolution-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | JSON-Array mit Clusterinformationen in aufsteigender Reihenfolge nach cluster_id: * cluster_id: Zeichenfolge. Eindeutige Clusternummer innerhalb einer Lösung von Clustern.{#MLSolution-getClusterAssignments_O__mlv-getClusterInfo-returnsID} * rec_display_id: Zeichenfolge. Datensatztyp und -nummer.{#MLSolution-getClusterAssignments_O__mlv-GetClustrAssn-rec-dispid} * rec_sys_id: Zeichenfolge. sys_id des Datensatzes.{#MLSolution-getClusterAssignments_O__mlv-GetClustrAssn-rec-sysid} * group_by: Bei Gruppierung der Name des Segmentierungsfelds, das diesem Cluster zugeordnet ist.{#MLSolution-getClusterAssignments_O__mlv-getClusterInfo-returnsGrp} {#MLSolution-getClusterAssignments_O__ul_oz5_dwm_rhb} |
[Tabelle : 6. Ergebnisse]

{#MLSolution-getClusterAssignments_O__table_u1q_hxt_rhb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("ml_x_global_clustering");

    // configure optional parameters
    var options = {};
    options.group_by = 'network';
    options.cluster_id = '1';
    // returns top 3 results per cluster
    options.top_n_per_cluster = 3;

    var results = mlSolution.getClusterAssignments(options);

Ausgabe:

    [{"cluster_id":"1","rec_display_id":"Incident: INC0014483","rec_sys_id":"04e33e7adb401300864adfea5e961900","group_by":"network"},
     {"cluster_id":"1","rec_display_id":"Incident: INC0011133","rec_sys_id":"5bd23af2db401300864adfea5e96194d","group_by":"network"}]

## MLSolution -- getClusterForRecord(GlideRecord now_GR) {#ariaid-title5}

Ruft die Clusterinformationen für eine Clusterlösung ab.
{#MLSolution-getClusterForRecord_GR__table_ak2_xcn_rhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| now_GR | GlideRecord | Name des Eingabe-GlideRecord |
[Tabelle : 7. Parameter]

{#MLSolution-getClusterForRecord_GR__table_ak2_xcn_rhb} {#MLSolution-getClusterForRecord_GR__table_bk2_xcn_rhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die cluster_id aus der Tabelle „Clusterzusammenfassung" \[ml_cluster_summary\], wenn der Datensatz zu einem Cluster gehört. Wenn der Datensatz nicht zu einem Cluster gehört, wird eine leere Zeichenfolge zurückgegeben. |
[Tabelle : 8. Ergebnisse]

{#MLSolution-getClusterForRecord_GR__table_bk2_xcn_rhb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("solution_name");
    var now_GR = new GlideRecord('incident');
    if (mlSolution.getCapability() == 'clustering') {
    var clusterId = mlSolution.getClusterForRecord(now_GR);
    }

## MLLösung -- getClusterInfo(Objektoptionen) {#ariaid-title6}

Ruft Informationen für eine angegebene Clusterlösung ab.
{#MLSolution-getClusterInfo_O__table_ak2_xcn_rhb__entry__3}{#MLSolution-getClusterInfo_O__ml-cluster-create-xbl}

| Name | Typ | Beschreibung |
|-|-|-|
| Optionen | Objekt | Optional. Schränkt die zurückgegebenen Ergebnisse nach Gruppe und Ebene innerhalb einer Clusterlösung ein. Standard: Gibt Clustermitgliedschaften für alle Cluster zurück. |
| Optionen.Gruppe_Nach | Zeichenfolge | Optional. Gibt das Segmentierungsfeld an, für das Clustermitgliedschaften abgerufen werden sollen, z. B. assignment_group. Dieses Feld bietet die gleiche Gruppierung wie Optionen im Kontrollkästchen Gruppe verwenden nach im Formular „ Clustering-Definition ". Die bereitgestellten Informationen variieren je nach der im Feld Tabelle ausgewählten Tabelle. Weitere Informationen finden Sie unter [Clusterlösung erstellen und trainieren](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US) . |
| Optionen.Cluster_ID | Zeichenfolge | Optional. Cluster-ID einer trainierten Lösung in der Tabelle „Clusterzusammenfassung" \[ml_cluster_summary\]. |
[Tabelle : 9. Parameter]

{#MLSolution-getClusterInfo_O__table_ak2_xcn_rhb} {#MLSolution-getClusterInfo_O__table_bk2_xcn_rhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | JSON-Array mit Clusterinformationen in aufsteigender Reihenfolge nach cluster_id: * cluster_id: Zeichenfolge. Eindeutige Clusternummer innerhalb einer Lösung von Clustern.{#MLSolution-getClusterInfo_O__mlv-getClusterInfo-returnsID} * cluster_quality: Zeichenfolge. Zahl von 0 bis 100. Höhere Zahlen bedeuten eine höhere Clusterdichte.{#MLSolution-getClusterInfo_O__mlv-getClusterInfo-returnsCQ} * cluster_size: Zeichenfolge. Anzahl der Datensätze in einem Cluster.{#MLSolution-getClusterInfo_O__mlv-getClusterInfo-returnsSize} * group_by: Bei Gruppierung der Name des Segmentierungsfelds, das diesem Cluster zugeordnet ist.{#MLSolution-getClusterInfo_O__mlv-getClusterInfo-returnsGrp} * cluster_concept: Zeichenfolge. Satz von Wörtern, die den Cluster in absteigender Reihenfolge der Häufigkeit beschreiben.{#MLSolution-getClusterInfo_O__mlv-getClusterInfo-returnsConcept} {#MLSolution-getClusterInfo_O__ul_oz5_tv5_rhb} |
[Tabelle : 10. Ergebnisse]

{#MLSolution-getClusterInfo_O__table_bk2_xcn_rhb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("ml_x_global_clustering");

    // configure optional parameters
    var options = {};
    options.group_by = 'network';
    options.cluster_id = 1;

    var results = mlSolution.getClusterInfo(options);

Ausgabe:

    [ {"cluster_id":"1","cluster_quality":"56.6","cluster_size":"46","group_by":"SLA","cluster_concept":"issue occur capacity ..."},
      {"cluster_id":"2","cluster_quality":"55.47","cluster_size":"75","group_by":"SLA","cluster_concept":"clone instance request ..."},
    ... ]

## MLSolution -- getVersion() {#ariaid-title7}

Ruft die Version der aktiven Lösung ab.
{#MLSolution-getVersion__table_hrt_ngx_ggb__entry__3}

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

{#MLSolution-getVersion__table_hrt_ngx_ggb} {#MLSolution-getVersion__table_irt_ngx_ggb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Version der aktiven Lösung. |
[Tabelle : 12. Ergebnisse]

{#MLSolution-getVersion__table_irt_ngx_ggb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("solution_name");

    var solutionVersion = mlSolution.getVersion();

## MLLösung -- isActive() {#ariaid-title8}

Bestimmt, ob eine Lösung aktiv ist.
{#MLSolution-isActive__table_xzj_lgx_ggb__entry__3}

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

{#MLSolution-isActive__table_xzj_lgx_ggb} {#MLSolution-isActive__table_yzj_lgx_ggb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die Lösung aktiv ist. * wahr: Lösung aktiv * false: Lösung inaktiv {#MLSolution-isActive__ul_cnk_ltv_bkb} |
[Tabelle : 14. Ergebnisse]

{#MLSolution-isActive__table_yzj_lgx_ggb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("solution_name");

    var isActive = mlSolution.isActive();

## MLLösung - Vorhersage (Objekteingabe, Objektoptionen) {#ariaid-title9}

Ruft die Vorhersageergebnisse vom Vorhersageserver anhand eines GlideRecord oder eines Arrays von Schlüssel-Wert-Paaren ab.
Sie können diese Methode verwenden, um eine Vorhersage mit mehreren Eingabedatensätzen aufzurufen, da GlideRecord ein Iterator ist.
{#MLSolution-predict_O_O__table_vv5_yfx_ggb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Eingabe | Objekt | [GlideRecord](https://www.servicenow.com/docs/aQw~oDpg6tKgED8LtNFyvw#c_GlideRecordAPI "Die GlideRecord- API wird für Datenbankvorgänge verwendet.") oder ein Array von JSON-Objekten, die Feldnamen und Werte als Schlüssel-Wert-Paare enthalten. |
| Optionen | Objekt | Optional. JSON-Schlüssel-Wert-Paar mit den folgenden Eigenschaften: * top_n: Nummer. Wenn angegeben, werden die besten Ergebnisse bis zur angegebenen Anzahl von Vorhersagen zurückgegeben.{#MLSolution-predict_O_O__solution-prediction-topn} * anwenden_threshold: Boolesch. Überprüft den Schwellenwert für die Lösung und wendet ihn auf den Ergebnissatz an. Der Schwellenwert ist der Lösungsschwellenwert für Ähnlichkeit oder der Schwellenwert auf Klassenebene für die Klassifizierung. Der Standardwert ist „true".{#MLSolution-predict_O_O__solution-prediction-thresh} * custom_results_filter: Zeichenfolge. Nur Ähnlichkeitslösungen. Gibt den zulässigen Satz an, aus dem Ergebnisse mithilfe einer codierten Abfrage zurückgegeben werden.{#MLSolution-predict_O_O__solution-prediction-custom} {#MLSolution-predict_O_O__ul_eqd_tcs_ckb} |
[Tabelle : 15. Parameter]

{#MLSolution-predict_O_O__table_vv5_yfx_ggb} {#MLSolution-predict_O_O__table_khq_hgx_ggb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | JSON-Objekt, das die nach sys_id oder record_number sortierten Vorhersageergebnisse enthält. * predictedValue: Zeichenfolge. Wert, der das Vorhersageergebnis darstellt.{#MLSolution-predict_O_O__ml-returnsVal} * vorhergesagteSysId: Zeichenfolge. Die sys_id des vorhergesagten Werts. Ergebnisse können aus jeder Tabelle stammen, in der Informationen vorhergesagt werden.{#MLSolution-predict_O_O__ml-returnsID} * Konfidenz: Zahl. Wert der Konfidenz, die der Vorhersage zugeordnet ist. Beispiel: 53,84.{#MLSolution-predict_O_O__ml-returnsConf} * threshold: Zahl. Wert des konfigurierten Schwellenwerts, der der Vorhersage zugeordnet ist.{#MLSolution-predict_O_O__ml-returnsThrsh} * detaillierteErgebnisse: Objekt. Nur Ähnlichkeitslösungen. JSON-Schlüssel-Wert-Paar, das Details zu den übereinstimmenden Textindizes enthält.{#MLSolution-predict_O_O__ml-returnsDetR} {#MLSolution-predict_O_O__ul_fg2_vcs_ckb} |
[Tabelle : 16. Ergebnisse]

{#MLSolution-predict_O_O__table_khq_hgx_ggb}  

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("ml_incident_categorization");

    // single GlideRecord input
    var input = new GlideRecord("incident");
    input.get("0ef47232db801300864adfea5e961912");

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

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("ml_incident_categorization");

    // multiple GlideRecord input
    var input = new GlideRecord("incident");
    input.addQuery("sys_created_onONLast week@javascript:gs.beginningOfLastWeek()@javascript:gs.endOfLastWeek()");
    input.query();

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

Ausgabe:

    {
        input_gr_sys_id1: [
                    {
                        predictedValue : xxx,
                        predictedSysId : xx0,
                        confidence : xxx,
                        threshold : xxx,
                        detailedResults : [.....]

                    }, 
                    {
                        predictedValue : yyy,
                        predictedSysId : xx1,
                        confidence : xxx,
                        threshold : xxx,
                        detailedResults : [.....]
                    }
            ],
        input_gr_sys_id2 : [
                    {
                        predictedValue : xxx,
                        predictedSysId : xx0,
                        confidence : xxx,
                        threshold : xxx,
                        detailedResults : [.....]

                    }, 
                ...
            ]
    }

    var mlSolution = sn_ml.MLSolutionFactory.getSolution("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));