---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://www.servicenow.com/docs/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# ClusteringSolutionVersion - グローバル

# ClusteringSolutionVersion - グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：41分

ClusteringSolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。

この API には 予測インテリジェンス プラグイン (com.glide.platform_ml) が必要です。この API は `sn_ml` 名前空間内で提供されます。

これは、[ClusteringSolution ストア](https://www.servicenow.com/docs/DzNjNUD44HbHWLENi4N96Q#ClusteringSolutionStoreAPI "ソリューション の保存と取得を有効にします 。")内の [ClusteringSolution API](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSolutionAPI "ClusteringSolution API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") オブジェクトに基づくソリューションバージョンを操作するために使用されます。

ソリューション定義をトレーニングするたびに、ソリューションのバージョンが作成されます。ほとんどのバージョンは、スケジュール設定済みのソリューショントレーニング中に作成されます。  
この API のメソッドは、次の ClusteringSolution メソッドを使用してアクセスできます。

* [getActiveVersion()](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSol-getActiveVersion "アクティブな ClusteringSolutionVersion オブジェクト。")
* [getAllVersions()](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSol-getAllVersions "クラスタリングソリューション のすべてのバージョンを取得します")
* [getLatestVersion()](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSol-getLatestVersion "の最新バージョンを取得しますソリューション。")
* [getVersion()](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSol-getVersion_S "指定されたバージョン番号を使用します。ソリューションを取得します")
{#ClusteringSolutionVersionAPI__ul_ycl_fzf_tlb}

## ClusteringSolutionVersion - cancelUpdateJob() {#ariaid-title2}

トレーナーの更新ジョブをキャンセルします。
{#C-cancelUpdateJob__table_cb4_q3b_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#C-cancelUpdateJob__table_cb4_q3b_rlb} {#C-cancelUpdateJob__table_db4_q3b_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 2. 返される内容]

{#C-cancelUpdateJob__table_db4_q3b_rlb}  
次の例は、[submitTrainingJob()](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSol-submitTrainingJob "トレーニングジョブを送信します。") メソッドを使用して、送信されたアクティブなトレーニングジョブをキャンセルする方法を示しています。

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

    mlSolutionVersion.cancelUpdateJob();

## ClusteringSolutionVersion - deleteClusterAssignments(オブジェクト options) {#ariaid-title3}

テーブルシーケンス内の位置または GlideDateTime に基づいて、行からクラスター割り当てを削除します。
{#C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| オプション | オブジェクト | クラスター割り当てを削除するための 1 つのオプションを定義するオブジェクト。 注: 1 つの削除オプションのみが有効です。 |
| options.updatedUntil | 文字列 | updated_since 値がこの値よりも前であるクラスターの行を削除します。形式は [GlideDateTime](https://www.servicenow.com/docs/Dy1YseqYjRu0xSRsxt9hHQ#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。")として指定する必要があります。 { "updatedUntil" : "String" } |
| options.sequenceUntil | 文字列 | クラスターの行を削除します ML クラスター詳細 \[ml_cluster_detail\] テーブルでこの値の前に発生する insert_sequence 値。シーケンス位置の開始点の値は 1 です。 { "sequenceUntil" : Number } |
[表 : 3. パラメーター]

{#C-deleteClusterAssignments_O__table_cwv_r3b_rlb} {#C-deleteClusterAssignments_O__table_dwv_r3b_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| 番号 | ML クラスター詳細 \[ml_cluster_detail\] テーブルから削除される行の数。 |
[表 : 4. 返される内容]

{#C-deleteClusterAssignments_O__table_dwv_r3b_rlb}  
次の例は、updated_since の時間が <kbd class="ph userinput">'2020-06-28 02:50:53'</kbd> よりも前であるクラスターの行を削除する方法を示しています。

    var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");

    var mlSolutionVersion = mlSolution.getActiveVersion();

    var options = {};
    options.updatedUntil = '2020-06-28 02:50:53';

    var results = mlSolutionVersion.deleteClusterAssignments(options);

    gs.print("Number of deleted rows: "+results);

出力:

    Number of deleted rows: 6417

次の例は、updated_since が <kbd class="ph userinput">1000</kbd> よりも前で連続した位置にあるクラスターの行を削除する方法を示しています。

    var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");

    var mlSolutionVersion = mlSolution.getActiveVersion();

    var options = {};
    options.sequenceUntil = 1000;

    var results = mlSolutionVersion.deleteClusterAssignments(options);

    gs.print("Number of deleted rows: "+results);

出力：

    Number of deleted rows: 999

## ClusteringSolutionVersion - getClusterAssignments(オブジェクト options) {#ariaid-title4}

クラスタリングソリューションの割り当てを取得します。
{#C-getClusterAssignments_O__table_gby_x2w_plb__entry__3}{#C-getClusterAssignments_O__ml-cluster-create-xbl}

| 名前 | タイプ | 説明 |
|-|-|-|
| オプション | オブジェクト | 返された結果を、クラスタリングソリューション内のグループ、レベル、システム更新時間、およびテーブル行番号で絞り込むために使用する値。少なくとも 1 つの引数を指定する必要があります。 { "cluster_id": "String", "group_by": "String", "limit": Number, "sequenceSince": Number, "sequenceUntil": Number, "topNPerCluster": Number, "updatedSince": "String", "updatedUntil": "String" } |
| options.cluster_id | 文字列 | オプション。クラスターサマリー \[ml_cluster_summary\] テーブルのトレーニング済みソリューションのクラスター ID。 |
| options.group_by | 文字列 | オプション。クラスターメンバーシップ (assignment_group など) を取得するセグメンテーションフィールドを識別します。 このフィールドは、\[クラスタリング定義\] フォームの \[グループ化\] チェックボックスで提供されるオプションと同じグループ化を提供します。表示される情報は、\[テーブル\] フィールドで選択したテーブルによって異なります。詳細については、「 [クラスタリングソリューションの作成とトレーニング](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US) 」を参照してください。 |
| options.limit | 番号 | オプション。取得するクラスター割り当ての最大数。 |
| options.sequenceSince | 番号 | テーブルシーケンスの開始位置。insert_sequence が有効で、ML クラスター詳細 \[ml_cluster_detail\] テーブルでこの値の後に配置されているクラスターの情報を返します。シーケンス位置の開始点の値は 1 です。 |
| options.sequenceUntil | 番号 | クラスターの割り当てを返しますML クラスター詳細 \[ml_cluster_detail\] テーブルでこの値の前に発生する insert_sequence 値。シーケンス位置の開始点の値は 1 です。 |
| options.topNPerCluster | 番号 | クラスターごとに受信する上位の結果の数。 |
| options.updatedSince | 文字列 | オプション。日付と時刻。 [GlideDateTime](https://www.servicenow.com/docs/Dy1YseqYjRu0xSRsxt9hHQ#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。")。 |
| options.updatedUntil | 文字列 | オプション。日付と時刻。 [GlideDateTime](https://www.servicenow.com/docs/Dy1YseqYjRu0xSRsxt9hHQ#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。")。 |
[表 : 5. パラメーター]

{#C-getClusterAssignments_O__table_gby_x2w_plb} {#C-getClusterAssignments_O__table_u1q_hxt_rhb__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | クラスター情報を含むオブジェクトのリスト (cluster_id の昇順)。 [ { "cluster_id": "String", "group_by": "String", "rec_display_id": "String", "rec_sys_id": "String" } ] |
| \<object\>.cluster_id | クラスターのソリューション内の一意のクラスター番号。 |
| \<object\>.group_by | グループ化されている場合、このクラスターに関連付けられているセグメンテーションフィールドの名前。 |
| \<object\>.rec_display_id | レコードのタイプと番号。 |
| \<object\>.rec_sys_id | レコード sys_id。 |
[表 : 6. 返される内容]

{#C-getClusterAssignments_O__table_u1q_hxt_rhb}  
次の例は、options オブジェクトを使用してクラスタリング結果をフィルタリングする方法を示しています。

    var mlSolution = sn_ml.ClusteringSolutionStore.get("solution_name");

    var mlSolutionVersion = mlSolution.getActiveVersion();

    var options = {};
    options.clusterId = 56;
    options.topNPerCluster = 10;
    options.updatedUntil = '2020-01-17 23:16:14'; 
    options.updatedSince = '2020-01-17 23:16:13'; 
    options.sequenceUntil = 1000; 
    options.sequenceSince = 1100; 
    options.limit = 100;

    var results = mlSolutionVersion.getClusterAssignments(options)

    gs.print(results);

出力：

    [{"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"}]

## ClusteringSolutionVersion - getClusterInfo(オブジェクト options) {#ariaid-title5}

ストア内 指定されたクラスタリングソリューションの情報を取得します。。純度測定は、純度の基になるクラスターフィールドにパーセンテージの形でインサイトを提供します。
{#C-getClusterInfo_O__table_gby_x2w_plb__entry__3}{#C-getClusterInfo_O__ml-cluster-create-xbl}

| 名前 | タイプ | 説明 |
|-|-|-|
| オプション | オブジェクト | オプション。クラスタリングソリューション内で結果のフィルタリングを可能にするプロパティを含むオブジェクト。 { "clusterId": "String", "groupBy": "String", "limit": "String", "recSysId": "String", "sequenceSince": Number, "sequenceUntil": Number, "updatedSince": "String", "updatedUntil": "String" } デフォルト：すべてのクラスターのクラスターメンバーシップを返します。 |
| options.clusterId | 文字列 | オプション。クラスターサマリー \[ml_cluster_summary\] テーブルのトレーニング済みソリューションのクラスター ID。 |
| options.groupBy | 文字列 | オプション。クラスターメンバーシップ (assignment_group など) を取得するセグメンテーションフィールドを識別します。 このフィールドは、\[クラスタリング定義\] フォームの \[グループ化\] チェックボックスで提供されるオプションと同じグループ化を提供します。表示される情報は、\[テーブル\] フィールドで選択したテーブルによって異なります。詳細については、「 [クラスタリングソリューションの作成とトレーニング](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US) 」を参照してください。 |
| options.limit | 番号 | オプション。取得するクラスター割り当ての最大数。 |
| options.recSysId | 文字列 | オプション。クラスター情報の検索に使用するレコードの sys_id。 |
| options.sequenceSince | 番号 | テーブルシーケンスの開始位置。insert_sequence が有効で、ML クラスター詳細 \[ml_cluster_detail\] テーブルでこの値の後に配置されているクラスターの情報を返します。シーケンス位置の開始点の値は 1 です。 |
| options.sequenceUntil | 番号 | オプション。テーブルシーケンスの終了位置。クラスターの割り当てを返しますML クラスター詳細 \[ml_cluster_detail\] テーブルでこの値の前に発生する insert_sequence 値。シーケンス位置の開始点の値は 1 です。 |
| options.updatedSince | 文字列 | オプション。日付と時刻。 [GlideDateTime](https://www.servicenow.com/docs/Dy1YseqYjRu0xSRsxt9hHQ#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。") 形式。 |
| options.updatedUntil | 文字列 | オプション。日付と時刻。 [GlideDateTime](https://www.servicenow.com/docs/Dy1YseqYjRu0xSRsxt9hHQ#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。")。 |
[表 : 7. パラメーター]

{#C-getClusterInfo_O__table_gby_x2w_plb} {#C-getClusterInfo_O__table_xk3_v3b_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | クラスター情報を含むオブジェクトのリスト。 [ { "cluster_concept": "String", "cluster_id": "String", "cluster_quality": "String", "cluster_size": "String", "group_by": "String", "insert_sequence": "String", "purity": "String", "sys_updated_on": "String" } ] |
| \<object\>.cluster_concept | 頻度の降順によるクラスターを説明する単語のセット。 データタイプ：文字列 |
| \<object\>.cluster_id | クラスターのソリューション内の一意のクラスター番号。 |
| \<object\>.cluster_quality | 0 ～ 100 の数値。数値が大きいほどクラスター密度が高いことを示します。 データタイプ：文字列 |
| \<object\>.cluster_size | クラスター内のレコードの数。 データタイプ：文字列 |
| \<object\>.group_by | グループ化されている場合、このクラスターに関連付けられているセグメンテーションフィールドの名前。 データタイプ：文字列 |
| \<object\>.insert_sequence | クラスターサマリー \[ml_cluster_summary\] テーブル内のクラスターの連続位置番号。 データタイプ：文字列 |
| \<object\>.purity | クラスター品質の純度を表すパーセンテージ値。 |
| \<object\>.sys_updated_on | このクラスターが最後に更新された日時を表すシステムの [GlideDateTime](https://www.servicenow.com/docs/xWri1nmJyGLw7m~IPzfcdg#c_GlideDateTimeScoped "スコープ指定された GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。") 値。 データタイプ：文字列 |
[表 : 8. 返される内容]

{#C-getClusterInfo_O__table_xk3_v3b_rlb}  
次の例は、options オブジェクトパラメーターを設定し、クラスターのフィルタリング結果を印刷する方法を示しています。

    var mlSolution = sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");

    var mlSolutionVersion = mlSolution.getActiveVersion();

    var options = {};
    options.updatedSince = '2020-05-28 02:09:53'; 
    options.updatedUntil = '2020-05-28 03:15:00';
    options.sequenceSince = 1;
    options.limit = 10;

    var results = mlSolutionVersion.getClusterInfo(options);

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

出力：

    [
      {
        "cluster_id": "1",
        "cluster_quality": "100",
        "cluster_size": "17",
        "purity": "",
        "insert_sequence": "8",
        "group_by": "VPN   Customer",
        "sys_updated_on": "2020-05-28 02:09:53",
        "cluster_concept": "vpn instance connection ldap user log unable usability tunnel"
      },
      {
        "cluster_id": "1",
        "cluster_quality": "100",
        "cluster_size": "10",
        "purity": "",
        "insert_sequence": "24",
        "group_by": "Live Feed",
        "sys_updated_on": "2020-05-28 02:09:53",
        "cluster_concept": "feed live user note work disable group default usability sort"
      },
      {
        "cluster_id": "1",
        "cluster_quality": "100",
        "cluster_size": "18",
        "purity": "",
        "insert_sequence": "40",
        "group_by": "Integrations",
        "sys_updated_on": "2020-05-28 02:09:53",
        "cluster_concept": "integrate usability certificate error"
      },
    ...
    ]

## ClusteringSolutionVersion - getProperties() {#ariaid-title6}

ソリューションオブジェクトプロパティを取得します バージョン番号。
{#C-getProperties__table_d2m_zwz_4lb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 9. パラメーター]

{#C-getProperties__table_d2m_zwz_4lb} {#C-getProperties__table_e2m_zwz_4lb__entry__2}{#C-getProperties__solution-obj-group-desc}

| タイプ | 説明 |
|-|-|
| オブジェクト | データセットのコンテンツと [ClusteringSolution](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSol-ClusteringSolution_O "クラスターソリューションを作成します。") バージョン詳細。結果はオブジェクトプロパティのセットアップによって異なります。 { "algorithmConfig": {Object}, "datasetProperties": {Object}, "domainName": "String", "encoder": {Object}, "groupByFieldName": "String", "inputFieldNames": [Array], "isActive": Boolean, "label": "String", "minRecordsPerCluster": Number, "name": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String", "updateFrequency": "String", "versionNumber": Number } |
| \<Object\>.algorithmConfig | アルゴリズム設定プロパティを含む JavaScript オブジェクト。 プロパティの結果は、algorithm プロパティに設定された値によって異なります。 データタイプ: オブジェクト 'algorithmConfig' : { "algorithm": "String", // See algorithmConfig.algorithm setting description for property settings based on algorithm } |
| \<Object\>.algorithmConfig.algorithm | ソリューションをエンコードする方法。 dbscan のプロパティ： 'algorithmConfig': { "algorithm": "dbscan", "distanceMetric": "String", "epsilon": Number, "minimumNeighbours": Number } kmeans のプロパティ： 'algorithmConfig': { "algorithm": "kmeans", "targetCoverage": Number } データタイプ：文字列 |
| \<Object\>.algorithmConfig.distanceMetric | DBSCAN アルゴリズムのみ。類似のデータオブジェクトをスキャンする距離測定基準。 データタイプ：文字列 |
| \<Object\>.algorithmConfig.epsilon | DBSCAN アルゴリズムのみ。近接検索半径のサイズを表す 0 と 1 の間の小数値。 データタイプ：数値 |
| \<Object\>.algorithmConfig.minimumNeighbours | DBSCAN アルゴリズムのみ。ポイントがクラスターの一部となるために必要な近接の最小数。levenshteinDistance の場合、データセットから除外されるポイントがないように、値を 1 にする必要があります。 データタイプ：数値 |
| \<Object\>.algorithmConfig.targetCoverage | K 平均法アルゴリズムのみ。互いにあまり類似していないレコードを除外するためのパーセンタイルフィールド。 データタイプ：数値 |
| \<Object\>.datasetProperties | ソリューションに関連付けられた [DatatsetDefinition](https://www.servicenow.com/docs/kERREiAlGZUL679rFNdNtw#DatasetDefinitionAPI "DatasetDefinition API は、ML トレーニングアルゴリズムの入力として使用する、テーブル名、列、および行の選択基準を含むレコードのセット。データセットには実際のデータは含まれていません。") オブジェクトのプロパティを一覧表示します。 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ: オブジェクト |
| \<Object\>.datasetProperties.encodedQuery | 標準の Glide 形式のエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 データタイプ：文字列 |
| \<Object\>.datasetProperties.fieldDetails | フィールドプロパティを指定する JavaScript オブジェクトのリスト。 データタイプ：オブジェクトのアレイ [ { "name": "String", "type": "String" } ] |
| \<Object\>.datasetProperties.fieldDetails.name | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ：文字列 |
| \<Object\>.datasetProperties.fieldDetails.type | 機械学習フィールドタイプ。 データタイプ：文字列 |
| \<Object\>.datasetProperties.fieldNames | 指定されたテーブルからの文字列としてのフィールド名のリスト。例：`"fieldNames" : ["short_description", "priority"]` データタイプ：アレイ |
| \<Object\>.datasetProperties.tableName | データセットのテーブルの名前。例：`"tableName" : "Incident"` データタイプ：文字列 |
| \<Object\>.domainName | このデータセットに関連付けられたドメイン名。[「ドメインセパレーション」および予測インテリジェンス](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)「」を参照してください。 データタイプ：文字列 |
| Object.encoderProperties | このソリューションに割り当てられるエンコーダーオブジェクト。。「[Encoder - Encoder(オブジェクト config)](https://www.servicenow.com/docs/vZtCHwQ5a_NlIiS99H8RMA#Encoder-Encoder_O "Encoder を作成します。")」を参照してください。 データタイプ: オブジェクト |
| Object.groupByFieldName | レコードを 1 つ以上のクラスターにグループ化するためのフィールド名。 データタイプ：文字列 |
| Object.inputFieldNames | 文字列としての入力フィールド名のリスト。モデルは、次のフィールドを使用して予測を行います。 データタイプ：文字列 |
| \<Object\>.isActive | このバージョンがアクティブかどうかを示すフラグ。 有効な値： * true：バージョンはアクティブです。 * false：バージョンはアクティブではありません。 {#C-getProperties__ul_i5m_lp1_dmb} データタイプ：文字列 |
| \<Object\>.label | 予測タスクを識別します。 { "label": "my first prediction" } データタイプ：文字列 |
| \<Object\>.minRecordsPerCluster | クラスター内で使用可能なレコードの最小数。 データタイプ：数値 |
| \<Object\>.name | システムによって割り当てられた名前。 データタイプ：文字列 |
| \<Object\>.processingLanguage | 2 文字の ISO 639-1 言語コード形式の処理言語。 データタイプ：文字列 |
| \<Object\>.scope | オブジェクトスコープ。現在、有効な値は `global` のみです。 データタイプ：文字列 |
| \<Object\>.stopwords | オプション。language プロパティ設定に基づいて自動的に生成される文字列のプリセットリスト。詳しくは、 [カスタムストップワードリストの作成](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)を参照してください。 データタイプ：アレイ |
| \<Object\>.trainingFrequency | モデルを再トレーニングする頻度。 可能な値： * every_30_days * every_60_days * every_90_days * every_120_days * every_180_days * run_once {#C-getProperties__ul_pmw_523_plb}デフォルト：run_once データタイプ：文字列 |
| \<Object\>.updateFrequency | ソリューション定義のモデルを再構築する必要がある頻度。 可能な値： * do_not_update * every_1_day * every_1_hour * every_6_hours * every_12_hours * every_1_minute * every_15_minutes * every_30_minutes {#C-getProperties__ul_kjm_2jh_3mb}デフォルト：do_not_update データタイプ：文字列 |
| \<Object\>.versionNumber | のバージョン番号 ClusteringSolution オブジェクト。 |
[表 : 10. 返される内容]

{#C-getProperties__table_e2m_zwz_4lb}  
次の例では、ストア内のアクティブなオブジェクトバージョンのプロパティを取得します。

    // Get properties
    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');

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

出力：

    *** 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",
        "isActive": "true",
        "label": "my encoder definition",
        "name": "ml_x_snc_global_global_my_encoder_definition",
        "processingLanguage": "en",
        "stopwords": [
          "Default English Stopwords"
        ],
        "versionNumber": "1"
      },
      "groupByFieldName": "category",
      "inputFieldNames": [
        "short_description"
      ],
      "isActive": "true",
      "label": "clustering solution",
      "minRecordsPerCluster": 2,
      "name": "ml_x_snc_global_global_clustering_solution",
      "processingLanguage": "en",
      "stopwords": [
        "Default English Stopwords"
      ],
      "updateFrequency": "do_not_update",
      "versionNumber": "1"
    }

## ClusteringSolutionVersion - getStatus(ブール includeDetails) {#ariaid-title7}

トレーニング完了ステータスを取得します。
{#C-getStatus_B__table_xfh_vbw_plb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| includeDetails | ブーリアン | ステータス details を返すかどうかを示すフラグ。 有効な値： * true：追加の詳細を返します。 * false:追加の詳細を返しません。 {#C-getStatus_B__ul_n33_ckw_plb} デフォルト：False |
[表 : 11. パラメーター]

{#C-getStatus_B__table_xfh_vbw_plb} {#C-getStatus_B__table_yfh_vbw_plb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | のトレーニングステータス情報を含む JavaScript オブジェクト[ClusteringSolution](https://www.servicenow.com/docs/JNhjnRZEV1U3c4yNCXPo5A#ClusteringSolutionAPI "ClusteringSolution API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") オブジェクト。 { "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {Object} } |
| \<Object\>.state | トレーニング完了ステータス。トレーニングジョブがターミナルステータスに達した場合、ジョブはそのステータスを終了しません。ステータスがターミナルの場合、hasJobEnded プロパティは `true` に設定されます。 可能な値： * fetching_files_for_training * preparing_data * 再試行 * solution_cancelled (terminal) * solution_complete (terminal) * solution_error (terminal) * solution_incomplete * training_request_received * training_request_timed_out (terminal) * training_solution * Uploading_solution * waiting_for_training {#C-getStatus_B__ul_a5q_gh4_vlb} データタイプ：文字列 |
| \<Object\>.hasJobEnded | トレーニングが完了したかどうかを示すフラグ。 有効な値： * true：トレーニングは完了しました。 * false：トレーニングは完了していません。 {#C-getStatus_B__ul_icy_zjx_rlb} データタイプ：文字列としてのブール値 |
| \<Object\>.percentComplete | トレーニング完了率。完了率が 100 未満の場合、ジョブはターミナルステータスである可能性があります。たとえば、トレーニングがタイムアウトした場合などです。 データタイプ：文字列としての数値 範囲: 0 から 100 |
| \<Object\>.details | 追加のトレーニングの詳細のリストを含むオブジェクト。 データタイプ：オブジェクト |
[表 : 12. 返される内容]

{#C-getStatus_B__table_yfh_vbw_plb}  
次の例は、トレーニングが完了して成功した結果を示しています。

    // Get status
    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_cluster_solution');

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

出力：

    {
     "state":"solution_complete",
     "percentComplete":"100",
     "hasJobEnded":"true",
     "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);
    }

次の例は、トレーニングが完了して失敗した結果を示しています。

    // Get status
    var solutionName = 'ml_x_snc_global_global_cluster_solution';
    var mlSolution = sn_ml.ClusteringSolutionStore.get(solutionName);
    var trainingStatus = mlSolution.getLatestVersion().getStatus();

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

出力：

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

## ClusteringSolutionVersion - getTopNPurityInfo(オブジェクト options) {#ariaid-title8}

クラスタリングソリューションの上位の純度結果を取得します。純度測定は、純度の基になるクラスターフィールドにパーセンテージの形でインサイトを提供します。
{#C-getTopNPurityInfo_O__table_q13_tk3_wnb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| オプション | オブジェクト | 上位クラスターの純度結果の数と形式を決定するオプション。 { "clusterIds": [Array], "groupBy": [Array], "purityFields": [Array], "topN": Number, "topNFields": Number } |
| options.clusterIds | アレイ | オプション。文字列として指定されたクラスター ID のリスト。クラスター ID は、クラスターサマリー \[ml_cluster_summary\] テーブルで提供されています。指定された場合、このメソッドは指定された各クラスターの純度クラスター情報を返します。 デフォルト：このメソッドは、すべてのクラスターの純度情報を返します。 |
| options.groupBy | アレイ | オプション。テーブルの group_by フィールド文字列の リストは、システムがクラスター内で最も頻度が高いクラスを特定するのに役立ちます。指定された場合、group_by フィールドを使用してクラスターソリューションの純度情報を返します。クラスターサマリー \[ml_cluster_summary\] テーブルには、クラスターおよび関連する group_by 値が一覧表示されます。 このフィールドは、クラスタリング定義で group by を使用するクラスターにのみ適用されます。対象となるフィールドが Table フィールドに一覧表示されます。グループ化機能の詳細については、「 [クラスタリングソリューションの作成とトレーニング](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)」を参照してください。 |
| options.purityFields | アレイ | オプション。純度フィールド文字列のリスト。指定された場合、このメソッドはこれらの純度フィールドの情報のみを返します。クラスターの純度値は、クラスターサマリー \[ml_cluster_summary\] テーブルリストで表示できます。 注: purity_fields と top_n_fields の両方が指定されている場合、このメソッドは最初に top_n_fields を返し、次に purity_fields からフィールドを選択します。 デフォルト：クラスターに保存されているすべての純度フィールドの純度情報を返します。 |
| options.topN | 番号 | オプション。返される予測の数を各純度フィールドの最高値のみに制限します。 最大値：10 デフォルト：各純度フィールドのすべての純度情報を返します。 |
| options.topNFields | 番号 | オプション。返される純度フィールドの数を、各クラスターの最高純度のフィールドのみに制限します。 最大値：10 デフォルト：クラスター内のすべてのフィールドを返します。 |
[表 : 13. パラメーター]

{#C-getTopNPurityInfo_O__table_q13_tk3_wnb} {#C-getTopNPurityInfo_O__table_r13_tk3_wnb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 純度フィールドおよび詳細を伴うクラスターのリストを含む JSON 形式の文字列。 注: 結果は options 入力パラメーターの設定によって異なります。 次の情報は、クラスター純度の結果がどのようにソートされ、分類されるかを示しています。実際の出力については、例を参照してください。 { "<clusterID>":[ // List sorted by purity per field { "<fieldName>":[ // List sorted by purity per field value {"<field_val1_1>":"<purity>"}, // Additional field values ]}, // Additional fields ], // Additional clusters } |
| String.\<clusterID\> | クラスターごとの純度値の降順に並べられたクラスターのリスト。 データタイプ：アレイ |
| String.\<clusterID\>.\<field\> | フィールドごとの純度値の降順に並べられた純度フィールドを表すオブジェクトのリスト。options.top_n_fields 入力オブジェクトのパラメータープロパティによって、返されるフィールドの数が決まります。 "<field>":[{"<field_val>":"<purity>"}]} データタイプ：アレイ |
| String.\<clusterID\>.\<field\>.\<values\> | フィールド値と純度を含むオブジェクトのリスト。例えば、`{"priority":[{"5":"100"}]}` は、スコアが 5 で純度値が 100 パーセントの優先度フィールドです。結果は純度のパーセンテージの降順に一覧表示されます。options.top_n 入力オブジェクトのパラメータープロパティによって、返される結果の数が決まります。 データタイプ：アレイ |
[表 : 14. 返される内容]

{#C-getTopNPurityInfo_O__table_r13_tk3_wnb}  
次の例は、特定のクラスターソリューションのカテゴリフィールドの上位 2 つの純度の結果を取得する方法を示しています。

    var solution = new GlideRecord('ml_solution');
    solution.addQuery('sys_id', '<clustering_solution_sys_id>');
    solution.addQuery('active', 'true');
    solution.query();

    while (solution.next()) {

      var options = {};
      options.clusterIds = ['1', '3', '5'];
      options.purityFields = ['category'];
      options.topN = '2';
      options.topNFields = '2';

      var clustering = new sn_ml.ClusteringSolutionVersion(solution);
      var results = clustering.getTopNPurityInfo(options);

      gs.info(results);
    }

出力には、options パラメーターで指定された設定に基づいて純度に関するインサイトが表示されます。

    {"1":[{"category":[{"network":"99.96"},{"inquiry":"0.04"}]}],"3":[{"category":[{"Systems Engineering":"100"}]}],
    "5":[{"category":[{"Security":"100"}]}]}

## ClusteringSolutionVersion - getUpdateStatus() {#ariaid-title9}

最新のクラスタリングソリューション更新ジョブのステータスを取得します。
{#C-getUpdateStatus__table_kx2_w3b_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 15. パラメーター]

{#C-getUpdateStatus__table_kx2_w3b_rlb} {#C-getUpdateStatus__table_lx2_w3b_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | クラスタリングソリューションの更新のステータス。 ステータス： * 構成またはネットワークエラー * ソリューション更新中にエラーが発生しました * 更新用のファイルをフェッチしています * データを準備しています * 権限なし * 更新完了 * 更新がキャンセルされました * 更新要求を受信しました * 更新要求タイムアウト * ソリューションを更新しています * アップロード中 * 待機中 {#C-getUpdateStatus__ul_fgs_w54_wlb} |
[表 : 16. 返される内容]

{#C-getUpdateStatus__table_lx2_w3b_rlb}  
次の例は、クラスタリングソリューションの更新ステータスを取得する方法を示しています。

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

    gs.print(JSON.stringify(myCluster.getActiveVersion().getUpdateStatus()));

出力：

    "Update Complete"

## ClusteringSolutionVersion - getVersionNumber() {#ariaid-title10}

ソリューションオブジェクトのバージョン番号を取得します。
{#C-getVersionNumber__table_jsz_sbw_plb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 17. パラメーター]

{#C-getVersionNumber__table_jsz_sbw_plb} {#C-getVersionNumber__table_ksz_sbw_plb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | バージョン番号。 |
[表 : 18. 返される内容]

{#C-getVersionNumber__table_ksz_sbw_plb}  
次の例は、バージョン番号を取得する方法を示しています。

    // Get version number
    var mlSolution = sn_ml.ClusteringSolutionStore.get('ml_x_snc_global_global_clustering_solution');

    gs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));

出力：

    Version number: 1

## ClusteringSolutionVersion - predict(オブジェクト input, オブジェクト options) {#ariaid-title11}

予測の入力データを取得します。
{#C-predict_O_O__table_wwz_pbw_plb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| 入力 | オブジェクト | [GlideRecord](https://www.servicenow.com/docs/UU8iPPWC0AAbYz713AvFjQ#c_GlideRecordAPI "GlideRecord API はデータベース操作に使用されます。") または、キーと値のペアとしてフィールド名と値を含む JSON オブジェクトのアレイ。 |
| オプション | オブジェクト | 予測結果をフィルタリングするためのオプションの値。 { "apply_threshold": Boolean, "top_n": Number } |
| options.apply_threshold | ブーリアン | ソリューションのしきい値をチェックして結果セットに適用するかどうかを示すフラグ。 有効な値： * true：信頼性がしきい値より大きい結果を返します。 * false：すべての結果を返します。 {#C-predict_O_O__ul_f4d_xyx_slb} デフォルト：true |
| options.top_n | 番号 | 指定されている場合、指定された予測の数までの上位の結果を返します |
[表 : 19. パラメーター]

{#C-predict_O_O__table_wwz_pbw_plb} {#C-predict_O_O__table_xwz_pbw_plb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | sys_id または record_number でソートされた予測結果を含む JSON オブジェクト。 { <identifier>: [Array] } |
| \<Object\>.\<識別子\> | 各予測結果の詳細を含むオブジェクトのリスト。 データタイプ：オブジェクトのアレイ <identifier>: [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ] |
| \<Object\>.\<識別子\>.\<object\>.confidence | 予測に関連付けられた信頼性の値。例：53.84。 データタイプ：数値 |
| \<Object\>.\<識別子\>.\<object\>.predictedSysId | 予測値の sys_id。結果は、情報が予測されている任意のテーブルから取得できます。 データタイプ：文字列 |
| \<Object\>.\<識別子\>.\<object\>.predictedValue | 予測結果を表す値。 データタイプ：文字列 |
| \<Object\>.\<識別子\>.\<object\>.threshold | 予測に関連付けられた構成済みのしきい値の値。 データタイプ：数値 |
[表 : 20. 返される内容]

{#C-predict_O_O__table_xwz_pbw_plb}  
次の例は、predict() メソッドの予測結果を表示する方法を示しています。このメソッドは、 sys_id 別の GlideRecord を入力として受け取り、オプションのパラメーターを含めて、上位 3 つの結果に制限してしきい値を除外します。

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

次の例は、predict() メソッドの予測結果を表示する方法を示しています。このメソッドは、 キーと値のペアを入力のフィールド名のアレイとして受け取り、オプションのパラメーターを含めて、上位 3 つの結果に制限してしきい値を除外します。

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

## ClusteringSolutionVersion - submitUpdateJob(オブジェクト options) {#ariaid-title12}

結果を特定のテーブルに絞り込み、一致するレコードをフィルタリングするオプションを使用して、クラスタリング更新ジョブを送信します。
{#C-submitUpdateJob_O__table_gby_x2w_plb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| オプション | オブジェクト | クラスタリングソリューション更新の基になるオプションを含む JavaScript オブジェクト。 { "filter" : "String", "table" : "String" } |
| options.filter | 文字列 | 標準の Glide 形式のエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 指定されたフィルターに基づいて更新ジョブを実行できるようにします。 |
| options.table | 文字列 | 更新ジョブを実行するテーブルの名前。 |
[表 : 21. パラメーター]

{#C-submitUpdateJob_O__table_gby_x2w_plb} {#C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 22. 返される内容]

{#C-submitUpdateJob_O__table_qpm_x3b_rlb}  
次の例は、更新ジョブを送信する方法を示しています。

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

    var options = {"filter" : "precision", "table" : "incident"};

    myCluster.getActiveVersion().submitUpdateJob(options);