---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference
Release :
- australia
ft:locale :
- ja-JP
ft:publication_title :
- オーストラリア API リファレンス
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# ClusteringSolutionVersion - グローバル
# ClusteringSolutionVersion - グローバル {#ariaid-title1}
* リリースバージョン: Australia
*
* 更新日 2026年03月12日
*
*  所要時間：35分
ClusteringSolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。
この API には 予測インテリジェンス プラグイン (com.glide.platform_ml) が必要で、 `sn_ml` 名前空間内で提供されます。
これは、[ClusteringSolution ストア](https://servicenow-prod.fluidtopics.net/9sz5q4NjGL8cODgFLb01KA#ClusteringSolutionStoreAPI "ソリューション の保存と取得を可能にします 。")内の [ClusteringSolution API](https://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#ClusteringSolutionAPI "ClusteringSolution API は、予測インテリジェンスストアで使用されるスクリプト可能なオブジェクトです。") オブジェクトに基づくソリューションバージョンを操作するために使用されます。
ソリューション定義をトレーニングするたびに、ソリューションバージョンが作成されます。ほとんどのバージョンは、スケジュールされたソリューショントレーニング中に作成されます。
この API のメソッドには、次の ClusteringSolution メソッドを使用してアクセスできます。
* [getActiveVersion()](https://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#ClusteringSol-getActiveVersion "アクティブを取得します ClusteringSolutionVersion オブジェクト。")
* [getAllVersions()](https://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#ClusteringSol-getAllVersions "のすべてのバージョンを取得します クラスタリングソリューション。")
* [getLatestVersion()](https://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#ClusteringSol-getLatestVersion "の最新バージョンを取得します 解決策。")
* [getVersion()](https://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#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://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#ClusteringSol-submitTrainingJob "トレーニングジョブを送信します。") メソッドを使用して送信されたアクティブなトレーニングジョブをキャンセルする方法を示しています。
var myCluster = new sn_ml.ClusteringSolutionStore.get("ml_x_snc_global_global_clustering_solution");
var mlSolutionVersion = myCluster.getActiveVersion();
mlSolutionVersion.cancelUpdateJob();
## ClusteringSolutionVersion - deleteClusterAssignments(オブジェクトオプション) {#ariaid-title3}
テーブルシーケンスまたは GlideDateTime 内の位置によって行からクラスターアサインを削除します。
{#C-deleteClusterAssignments_O__table_cwv_r3b_rlb__entry__3}
| 名前 | タイプ | 説明 |
|-|-|-|
| オプション | オブジェクト | クラスターアサインを削除するためのオプションを 1 つ定義するオブジェクト。 注: 有効な削除オプションは 1 つだけです。 |
| options.updatedUntil | 文字列 | この値より前に発生する updated_since 値を持つクラスターの行を削除します。形式は [GlideDateTime](https://servicenow-prod.fluidtopics.net/sX6jx~y7CQmLmvE~regDqg#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 時間が 「2020-06-28 02:50:53」より前のクラスターの行を削除する方法を示しています。
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
次の例は、1000 より前に順番に配置されたupdated_sinceを持つクラスターの行を削除する方法を示しています。
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(オブジェクトオプション) {#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 など) を識別します。 このフィールドは、クラスターリング定義フォームの \[グループを使用 (Use Group By)\] チェックボックスで提供されるオプションと同じグループ化を提供します。提供される情報は、\[ テーブル\] フィールドで選択したテーブルによって異なります。詳細については、「 [クラスタリングソリューションの作成とトレーニング](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=australia&pubname=australia-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 | 文字列 | オプション。日付と時刻。で指定された値より後の sys_updated_on を持つクラスターの情報を返します [GlideDateTime](https://servicenow-prod.fluidtopics.net/sX6jx~y7CQmLmvE~regDqg#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対して操作を実行するためのメソッドを提供します。")。 |
| options.updatedUntil | 文字列 | オプション。日付と時刻。で指定された値よりも前の sys_updated_on を持つクラスターの情報を返します [GlideDateTime](https://servicenow-prod.fluidtopics.net/sX6jx~y7CQmLmvE~regDqg#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" } ] |
| \.cluster_id | クラスターのソリューション内の一意のクラスター番号。 |
| \.group_by | グループ化されている場合、このクラスターに関連付けられているセグメンテーションフィールドの名前。 |
| \.rec_display_id | レコードのタイプと番号。 |
| \.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(オブジェクトオプション) {#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 など) を識別します。 このフィールドは、クラスターリング定義フォームの \[グループを使用 (Use Group By)\] チェックボックスで提供されるオプションと同じグループ化を提供します。提供される情報は、\[ テーブル\] フィールドで選択したテーブルによって異なります。詳細については、「 [クラスタリングソリューションの作成とトレーニング](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=australia&pubname=australia-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 | 文字列 | オプション。日付と時刻。で指定された値より後の sys_updated_on を持つクラスターの情報を返します [GlideDateTime](https://servicenow-prod.fluidtopics.net/sX6jx~y7CQmLmvE~regDqg#c_GlideDateTimeAPI "GlideDateTime クラスは、GlideDateTime オブジェクトに対して操作を実行するためのメソッドを提供します。") 形式。 |
| options.updatedUntil | 文字列 | オプション。日付と時刻。で指定された値よりも前の sys_updated_on を持つクラスターの情報を返します [GlideDateTime](https://servicenow-prod.fluidtopics.net/sX6jx~y7CQmLmvE~regDqg#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" } ] |
| \.cluster_concept | クラスターを頻度の降順で説明する単語のセット。 データタイプ：文字列 |
| \.cluster_id | クラスターのソリューション内の一意のクラスター番号。 |
| \.cluster_quality | 0 〜 100 の数値。数値が大きいほど、クラスター密度が高いことを示します。 データタイプ：文字列 |
| \.cluster_size | クラスター内のレコードの数。 データタイプ：文字列 |
| \.group_by | グループ化されている場合、このクラスターに関連付けられているセグメンテーションフィールドの名前。 データタイプ：文字列 |
| \.insert_sequence | クラスターサマリー \[ml_cluster_summary\] テーブル内のクラスターの順次位置の番号。 データタイプ：文字列 |
| \.purity | クラスター品質の純度を表すパーセンテージ値。 |
| \.sys_updated_on | このクラスターが最後に更新された日時を表すシステム [GlideDateTime](https://servicenow-prod.fluidtopics.net/wTaFwoqoHkaw5dRdDfoOpA#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}
| タイプ | 説明 |
|-|-|
| オブジェクト | Dataset と [ClusteringSolution](https://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#ClusteringSol-ClusteringSolution_O "クラスターソリューションを作成します。") バージョンの詳細のコンテンツ。結果は、オブジェクトプロパティの設定によって異なります。 { "algorithmConfig": {Object}, "datasetProperties": {Object}, "domainName": "String", "groupByFieldName": "String", "inputFieldNames": [Array], "isActive": Boolean, "label": "String", "minRecordsPerCluster": Number, "name": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "trainingFrequency": "String", "updateFrequency": "String", "versionNumber": Number } |
| \.algorithmConfig | アルゴリズム構成プロパティを含む JavaScript オブジェクト。 プロパティの結果は、 algorithm プロパティに設定された値によって異なります。 データタイプ: オブジェクト 'algorithmConfig' : { "algorithm": "String", // See algorithmConfig.algorithm setting description for property settings based on algorithm } |
| \.algorithmConfig.algorithm | ソリューションをエンコードする方法。 dbscanのプロパティ: 'algorithmConfig': { "algorithm": "dbscan", "distanceMetric": "String", "epsilon": Number, "minimumNeighbours": Number } kmeansのプロパティ: 'algorithmConfig': { "algorithm": "kmeans", "targetCoverage": Number } データタイプ：文字列 |
| \.algorithmConfig.distanceMetric | DBSCAN アルゴリズムのみ。類似のデータオブジェクトをスキャンするための距離メトリクス。 データタイプ：文字列 |
| \.algorithmConfig.epsilon | DBSCAN アルゴリズムのみ。近隣検索半径のサイズを表す 0 〜 1 の 10 進数値。 データタイプ：数値 |
| \.algorithmConfig.minimumNeighbours | DBSCAN アルゴリズムのみ。クラスターに含めるためにポイントに必要な近傍の最小数。levenshteinDistance の場合、データセットからポイントが除外されないように、値は 1 である必要があります。 データタイプ：数値 |
| \.algorithmConfig.targetCoverage | K-means アルゴリズムのみ。互いに類似性の低いレコードを除外するためのパーセンタイルフィールド。 データタイプ：数値 |
| \.datasetProperties | ソリューションに関連付けられた [DatatsetDefinition](https://servicenow-prod.fluidtopics.net/_Y4D37G2Ep8vLiDiwFGIhA#DatasetDefinitionAPI "DatasetDefinition API は、識別するメソッドを提供しますML トレーニングアルゴリズムの入力として使用する、テーブル名、列、行選択基準を含む一連のレコード。データセットには実際のデータは含まれていません。") オブジェクトのプロパティを一覧表示します。 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ: オブジェクト |
| \.datasetProperties.encodedQuery | 標準の Glide 形式でエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列」](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US)を参照してください。 データタイプ：文字列 |
| \.datasetProperties.fieldDetails | フィールドのプロパティを指定する JavaScript オブジェクトのリスト。 データタイプ：オブジェクトのアレイ [ { "name": "String", "type": "String" } ] |
| \.datasetProperties.fieldDetails.name | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ：文字列 |
| \.datasetProperties.fieldDetails.type | 機械学習フィールドタイプ。 データタイプ：文字列 |
| \.datasetProperties.fieldNames | 指定されたテーブルのフィールド名を文字列としてリストします。例:"`fieldNames" : ["short_description", "priority"]。` データタイプ：アレイ |
| \.datasetProperties.tableName | データセットのテーブルの名前。たとえば、「 `tableName」:「インシデント」`です。 データタイプ：文字列 |
| \.domainName | このデータセットに関連付けられたドメイン名。「 [ドメインセパレーション」および 予測インテリジェンス](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=australia&pubname=australia-intelligent-experiences&ft:locale=en-US)を参照してください。 データタイプ：文字列 |
| Object.groupByFieldName | レコードを 1 つ以上のクラスターにグループ化するためのフィールド名。 データタイプ：文字列 |
| Object.inputFieldNames | 文字列としての入力フィールド名のリスト。モデルは、これらのフィールドを使用して予測を行います。 データタイプ：文字列 |
| \.isActive | このバージョンがアクティブかどうかを示すフラグ。 有効な値： * true:バージョンはアクティブです。 * false:バージョンはアクティブではありません。 {#C-getProperties__ul_i5m_lp1_dmb} データタイプ：文字列 |
| \.label | 予測タスクを識別します。 { "label": "my first prediction" } データタイプ：文字列 |
| \.minRecordsPerCluster | クラスターで許可するレコードの最小数。 データタイプ：数値 |
| \.name | システムによって割り当てられた名前。 データタイプ：文字列 |
| \.processingLanguage | 2 文字の ISO 639-1 言語コード形式の処理言語。 データタイプ：文字列 |
| \.scope | オブジェクトスコープ。現時点で有効な値は `グローバル`値のみです。 データタイプ：文字列 |
| \.stopwords | オプション。languageプロパティ設定に基づいてシステムが自動的に生成する文字列のプリセットリスト。詳細については、「 [カスタムストップワードリストの作成](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=australia&pubname=australia-intelligent-experiences&ft:locale=en-US)」を参照してください。 データタイプ：アレイ |
| \.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 データタイプ：文字列 |
| \.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 データタイプ：文字列 |
| \.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",
"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://servicenow-prod.fluidtopics.net/tBToEcfVl5FEzyDf8ZT6XA#ClusteringSolutionAPI "ClusteringSolution API は、予測インテリジェンスストアで使用されるスクリプト可能なオブジェクトです。") オブジェクト。 { "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {Object} } |
| \.state | トレーニング完了ステータス。トレーニングジョブがターミナルステータスに達しても、ジョブはそのステータスを終了しません。ステータスが \[ターミナル\] の場合、 hasJobEnded プロパティは `true` に設定されます。 可能な値： * fetching_files_for_training * preparing_data * 再試行 * solution_cancelled (端末) * solution_complete (ターミナル) * solution_error (端末) * solution_incomplete * training_request_received * training_request_timed_out (ターミナル) * training_solution * uploading_solution * waiting_for_training {#C-getStatus_B__ul_a5q_gh4_vlb} データタイプ：文字列 |
| \.hasJobEnded | トレーニングが完了したかどうかを示すフラグ。 有効な値： * true:トレーニングが完了しました。 * false:トレーニングが不完全です。 {#C-getStatus_B__ul_icy_zjx_rlb} データタイプ:文字列としてのブール値 |
| \.percentComplete | トレーニング完了率。完了率が 100 未満の場合、ジョブはターミナル状態である可能性があります。たとえば、トレーニングがタイムアウトした場合などです。 データタイプ:文字列としての数値 範囲:0〜100 |
| \.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(オブジェクトオプション) {#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\] テーブルには、クラスターと関連する \[グループ\] の値が一覧表示されます。 このフィールドは、クラスタリング定義でグループ化を使用するクラスターにのみ適用されます。対象となるフィールドが \[テーブル \] フィールドに一覧表示されます。グループ化機能の詳細については、「 [クラスタリングソリューションの作成とトレーニング](https://www.servicenow.com/docs/access?context=create-clustering-solution&version=australia&pubname=australia-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 入力パラメーターの設定によって異なります。 次の情報は、クラスターの純度の結果がどのようにソートおよび分類されるかを示しています。実際の出力については、例を参照してください。 { "":[ // List sorted by purity per field { "":[ // List sorted by purity per field value {"":""}, // Additional field values ]}, // Additional fields ], // Additional clusters } |
| String.\ | クラスターあたりの純度値によって降順に配置されたクラスターのリスト。 データタイプ：アレイ |
| String.\.\ | フィールドごとの純度値ごとに降順に並べられた純度フィールドを表すオブジェクトのリスト。options.top_n_fields入力オブジェクトパラメータープロパティは、返されるフィールドの数を決定します。 "":[{"":""}]} データタイプ：アレイ |
| String.\.\.\ | フィールド値と純度を含むオブジェクトのリスト。たとえば、 `{"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', '');
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);
}
出力には、オプションパラメーターで指定された設定に基づいて純度のインサイトが表示されます。
{"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 - submitUpdateJob (オブジェクトオプション) {#ariaid-title11}
結果を特定のテーブルに絞り込み、一致するレコードをフィルタリングするオプションを使用して、クラスタリング更新ジョブを送信します。
{#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=australia&pubname=australia-platform-user-interface&ft:locale=en-US)を参照してください。 指定されたフィルターに基づいて更新ジョブを実行できるようにします。 |
| options.table | 文字列 | 更新ジョブを実行するテーブルの名前。 |
[表 : 19. パラメーター]
{#C-submitUpdateJob_O__table_gby_x2w_plb} {#C-submitUpdateJob_O__table_qpm_x3b_rlb__entry__2}
| タイプ | 説明 |
|-|-|
| なし | |
[表 : 20. 返される内容]
{#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);