PredictabilityEstimateVersion :グローバル

オーストラリア API リファレンス

Release

australia

ft:locale

ja-JP

ft:publication_title

オーストラリア API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

PredictabilityEstimateVersion :グローバル

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：13分

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

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

この API は、PredictabilityEstimate ストア内の PredictabilityEstimate API オブジェクトに基づく予測可能性の推定バージョンを操作するときに使用します。

バージョンのソリューションをアクティブ化予測可能性の推定トレーニング完了時に最新バージョンのソリューションをアクティブ化し、一度にアクティブにできるのは 1 つのバージョンのみです。ただし、予測に使用する、以前にトレーニングしたバージョンをアクティブ化することはできます。

この API のメソッドには、次の PredictabiltyEstimate メソッドを使用してアクセスできます。

PredictabilityEstimateVersion:getProperties()

予測可能性推定オブジェクトプロパティおよびバージョン番号を取得します。

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

表 : 2. 返される内容
タイプ	説明
オブジェクト	データセットの内容と PredictabilityEstimate バージョンの詳細。結果は、オブジェクトプロパティの設定によって異なります。 `{ "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String", "versionNumber": "Number" }`
<Object>.datasetProperties	予測可能性の推定に関連付けられた DatasetDefinition() オブジェクトのプロパティを一覧表示します。 `{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }` データタイプ:オブジェクト。
<Object>.datasetProperties.tableName	データセットのテーブルの名前。たとえば、「 `tableName」:「インシデント」`です。データタイプ:文字列。
<Object>.datasetProperties.fieldNames	指定されたテーブルのフィールド名を文字列としてリストします。例:"`fieldNames" : ["short_description", "priority"]。` データタイプ:アレイ。
<Object>.datasetProperties.fieldNames.fieldDetails	フィールドのプロパティを指定する JavaScript オブジェクトのリスト。 `[ { "name": "String", "type": "String" } ]` データタイプ:アレイ。
<Object>.datasetProperties.fieldNames.fieldDetails.<object>.名前	このデータセットを制限する情報のタイプを定義するフィールドの名前。データタイプ:文字列。
<Object>.datasetProperties.fieldDetails.<object>.タイプ	機械学習フィールドタイプ。データタイプ:文字列。
<Object>.datasetProperties.fieldDetails.encodedQuery	標準の Glide 形式でエンコードされたクエリ文字列。「エンコードされたクエリ文字列」を参照してください。データタイプ:文字列。
<Object>.domainName	このデータセットに関連付けられたドメイン名。「ドメインセパレーション」および予測インテリジェンスを参照してください。データタイプ:文字列。
<Object>.inputFieldNames	推定対象として考慮される文字列としての候補入力フィールドのリスト。データタイプ:文字列。
<Object>.isActive	このバージョンがアクティブかどうかを示すフラグ。有効な値： true:バージョンはアクティブです。 false:バージョンはアクティブではありません。データタイプ：文字列
<Object>.label	予測タスクを識別します。 `{ "label": "my first prediction" }` データタイプ:文字列。
<Object>.name	システムによって割り当てられた名前。データタイプ:文字列。
<Object>.predictedFieldName	予測可能性のためにトレーニングするフィールドを識別します。データタイプ:文字列。
<Object>.scope	オブジェクトスコープ。現時点で有効な値は `グローバル`値のみです。データタイプ：文字列
<Object>.trainingFrequency	モデルを再トレーニングする頻度。可能な値： every_30_days every_60_days every_90_days every_120_days every_180_days run_once デフォルト:run_once データタイプ:文字列。
<Object>.versionNumber	のバージョン番号 PredictabilityEstimate オブジェクト。データタイプ:文字列。

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

// Get properties
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

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

出力：

"datasetProperties": {
    "encodedQuery": "activeANYTHING^EQ",
    "fieldNames": [
      "short_description",
      "category"
    ],
    "tableName": "incident"
  },
  "domainName": "global",
  "inputFieldNames": [
    "short_description"
  ],
  "isActive": "true",
  "label": "Incident Categorization_Trainer",
  "name": "ml_incident_categorization",
  "predictedFieldName": "category",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

PredictabilityEstimateVersion:getResults()

出力フィールドの提案された入力フィールドを含む JSON 結果を返します。

表 : 3. パラメーター
名前	タイプ	説明
なし

表 : 4. 返される内容
タイプ	説明
オブジェクト	出力フィールドの提案された入力フィールドオプションを含む JSON オブジェクトの結果。
<Object>。<output field name>	提案された入力フィールドを含む出力フィールド名 ( `カテゴリ`など)。 `{ "<output field name>": { "nominalInputFields": [Array], "textInputFields": [Array] } }` データタイプ: オブジェクト
<Object>.<output field name>。名義入力フィールド	名義入力フィールドの詳細。 `"nominalInputFields": [ { "fieldName": "String", "modelImprovement": "String" } ]` データタイプ:アレイ。
<Object>.<output field name>。nominalInputFields.fieldName	名目上の入力フィールド名。データタイプ:文字列。
<Object>.<output field name>。nominalInputFields.modelImprovement	このフィールドで結果が改善される可能性がどの程度あるかを示す相対的な指標としてのスコア。データタイプ:文字列としての数値。
<Object>.textInputFields	テキスト入力フィールドの詳細。 `"textInputFields": [ { "fieldName": "String", "density": "String" } ]` データタイプ:アレイ。
<Object>.textInputFields.fieldName	テキスト入力フィールド名。データタイプ:文字列。
<Object>.textInputFields.density	フィールドが空でない頻度を表す 0 〜 1.0 の値。値 1.0 はフィールドがすべての行が空ではないことを意味し、値 0 はフィールドがすべての行が空であることを示します。データタイプ:文字列としての数値。

次の例は、ストアで選択したバージョンの予測可能性の推定結果を取得する方法を示しています。

// Get results
var estimateName = "ml_x_snc_global_global_predictability_estimate;"
var mlEstimate = sn_ml.PredictabilityEstimateStore.get(estimateName);

var results = mlEstimate.getActiveVersion().getResults();

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

出力：

{
  "category": {
    "nominalInputFields": [
      {
        "fieldName": "number",
        "modelImprovement": "0.167052396325189"
      },
      {
        "fieldName": "task_effective_number",
        "modelImprovement": "0.167052396325189"
      }
    ],
    "textInputFields": [
      {
        "fieldName": "short_description",
        "density": "1.0"
      }
    ]
  }
}

PredictabilityEstimateVersion:getStatus(ブール値 includeDetails)

トレーニング完了ステータスを取得します。

表 : 5. パラメーター
名前	タイプ	説明
includeDetails	ブーリアン	ステータスを details にするかどうかを示すフラグ。有効な値： true:追加の詳細を返します。 false:追加の詳細を返しません。デフォルト値：False

表 : 6. 返される内容
タイプ	説明
オブジェクト	のトレーニングステータス情報を含む JavaScript オブジェクトPredictabilityEstimate オブジェクト。 `{ "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` (端末) `solution_complete` (ターミナル) `solution_error` (端末) `solution_incomplete` `training_request_received` `training_request_timed_out` (ターミナル) `training_solution` `uploading_solution` `waiting_for_training` データタイプ：文字列
<Object>.hasJobEnded	トレーニングが完了したかどうかを示すフラグ。有効な値： true:トレーニングが完了しました。 false:トレーニングが不完全です。データタイプ:文字列としてのブール値
<Object>.percentComplete	トレーニング完了率。完了率が 100 未満の場合、ジョブはターミナル状態である可能性があります。たとえば、トレーニングがタイムアウトした場合などです。データタイプ:文字列としての数値範囲:0〜100
<Object>.details	追加のトレーニング詳細のリストを含むオブジェクト。データタイプ: オブジェクト

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

// Get status
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlEstimate.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 mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_my_estimate_definition');
var trainingStatus = mlEstimate.getLatestVersion().getStatus();

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

出力：

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

PredictabilityEstimateVersion:getVersionNumber()

のバージョン番号を取得します予測可能性の推定オブジェクト。

表 : 7. パラメーター
名前	タイプ	説明
なし

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

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

// Get version number
var mlEstimate = sn_ml.PredictabilityEstimateStore.get('ml_x_snc_global_global_predictability_estimate');

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

出力：

Version number: 1