--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # PredictabilityEstimateVersion - グローバル # PredictabilityEstimateVersion - グローバル {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：13分 PredictabilityEstimateVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。 この API には 予測インテリジェンス プラグイン (com.glide.platform_ml) が必要です。この API は `sn_ml` 名前空間内で提供されます。 この API は、[PredictabilityEstimate ストア](https://servicenow-prod.fluidtopics.net/_Brz6nwhtkWCZaWcHI2qCw#PredictabilityEstimateStoreAPI "の保存と取得を有効にします予測可能性推定。")内の [PredictabilityEstimate API](https://servicenow-prod.fluidtopics.net/cfwmprw04noTW3x1hEXr4w#PredictabilityEstimateAPI "PredictabilityEstimate API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。このオブジェクトは、データセットのフィールドがどの程度予測可能か、またそのフィールドの予測にどの機能が役立つかという推定を提供します。") オブジェクトに基づいて予測可能性推定バージョンを操作する場合に使用します。 トレーニングを完了すると、最新バージョンの予測可能性推定がアクティブ化され、一度に 1 つのバージョンのみがアクティブになります。ただし、予測を行うために使用したい以前にトレーニングされたバージョンをアクティブ化することができます。 この API のメソッドは、次の PredictabiltyEstimate メソッドを使用してアクセスできます。 * [getActiveVersion()](https://servicenow-prod.fluidtopics.net/cfwmprw04noTW3x1hEXr4w#PrdctbltE-getActiveVersion "アクティブな PredictabilityEstimateVersion オブジェクト。") * [getAllVersions()](https://servicenow-prod.fluidtopics.net/cfwmprw04noTW3x1hEXr4w#PrdctbltE-getAllVersions "のすべてのバージョンを取得します 予測可能性推定。") * [getLatestVersion()](https://servicenow-prod.fluidtopics.net/cfwmprw04noTW3x1hEXr4w#PrdctbltE-getLatestVersion "の最新バージョンを取得します 予測可能性推定。") * [getVersion()](https://servicenow-prod.fluidtopics.net/cfwmprw04noTW3x1hEXr4w#PrdctbltE-getVersion_S "指定されたバージョン番号を使用します。予測可能性推定を取得します。") {#PredictabilityEstimateVersionAPI__ul_ycl_fzf_tlb} ## PredictabilityEstimateVersion - getProperties() {#ariaid-title2} 予測可能性推定オブジェクトのプロパティバージョン番号を取得します。 {#PredictbltyEstV-getProperties__table_d2m_zwz_4lb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 1. パラメーター] {#PredictbltyEstV-getProperties__table_d2m_zwz_4lb} {#PredictbltyEstV-getProperties__table_e2m_zwz_4lb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | データセットと [PredictabilityEstimate](https://servicenow-prod.fluidtopics.net/cfwmprw04noTW3x1hEXr4w#PrdctbltE-PredictabilityEstimate_O "予測可能性推定を作成します。") バージョンの詳細の内容。結果はオブジェクトプロパティのセットアップによって異なります。 { "datasetProperties": {Object}, "domainName": "String", "inputFieldNames": [Array], "label": "String", "name": "String", "predictedFieldName": "String", "scope": "String", "trainingFrequency": "String", "versionNumber": "Number" } | | \.datasetProperties | 予測可能性推定に関連付けられた [DatasetDefinition()](https://servicenow-prod.fluidtopics.net/kERREiAlGZUL679rFNdNtw#DDef-DatasetDefinition_O "DatasetDefinition クラスのインスタンスを作成し、テーブル名、フィールド、およびクエリーでデータセットを定義できるようにします。") オブジェクトのプロパティを一覧表示します。 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ：オブジェクト。 | | \.datasetProperties.tableName | データセットのテーブルの名前。例：`"tableName" : "Incident"` データタイプ：文字列。 | | \.datasetProperties.fieldNames | 指定されたテーブルからの文字列としてのフィールド名のリスト。例：`"fieldNames" : ["short_description", "priority"]` データタイプ：アレイ。 | | \.datasetProperties.fieldNames.fieldDetails | フィールドプロパティを指定する JavaScript オブジェクトのリスト。 [ { "name": "String", "type": "String" } ] データタイプ：アレイ。 | | \.datasetProperties.fieldNames.fieldDetails.\.name | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ：文字列。 | | \.datasetProperties.fieldDetails.\.type | 機械学習フィールドタイプ。 データタイプ：文字列。 | | \.datasetProperties.fieldDetails.encodedQuery | 標準の Glide 形式のエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 データタイプ：文字列。 | | \.domainName | このデータセットに関連付けられたドメイン名。[「ドメインセパレーション」および予測インテリジェンス](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)「」を参照してください。 データタイプ：文字列。 | | \.inputFieldNames | 推定の際に考慮される入力フィールド候補 (文字列) のリスト。 データタイプ：文字列。 | | \.isActive | このバージョンがアクティブかどうかを示すフラグ。 有効な値： * true：バージョンはアクティブです。 * false：バージョンはアクティブではありません。 {#PredictbltyEstV-getProperties__ul_i5m_lp1_dmb} データタイプ：文字列 | | \.label | 予測タスクを識別します。 { "label": "my first prediction" } データタイプ：文字列。 | | \.name | システムによって割り当てられた名前。 データタイプ：文字列。 | | \.predictedFieldName | 予測可能性についてトレーニングするフィールドを識別します。 データタイプ：文字列。 | | \.scope | オブジェクトスコープ。現在、有効な値は `global` のみです。 データタイプ：文字列 | | \.trainingFrequency | モデルを再トレーニングする頻度。 可能な値： * every_30_days * every_60_days * every_90_days * every_120_days * every_180_days * run_once {#PredictbltyEstV-getProperties__ul_pmw_523_plb}デフォルト：run_once データタイプ：文字列。 | | \.versionNumber | のバージョン番号 PredictabilityEstimate オブジェクト。 データタイプ：文字列。 | [表 : 2. 返される内容] {#PredictbltyEstV-getProperties__table_e2m_zwz_4lb} 次の例では、ストア内のアクティブなオブジェクトバージョンのプロパティを取得します。 // 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() {#ariaid-title3} 出力フィールドに対して提案された入力フィールドを含む JSON の結果を返します。 {#PredictbltyEstV-getResults__table_ytt_1xz_qlb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 3. パラメーター] {#PredictbltyEstV-getResults__table_ytt_1xz_qlb} {#PredictbltyEstV-getResults__table_ztt_1xz_qlb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | 出力フィールドに対して提案された入力フィールドオプションを含む JSON オブジェクトの結果。 | | \.\ | 提案された入力フィールドを含む出力フィールド名 (例：category)。 { "": { "nominalInputFields": [Array], "textInputFields": [Array] } } データタイプ：オブジェクト | | \.\.nominalInputFields | 標準的な入力フィールドの詳細。 "nominalInputFields": [ { "fieldName": "String", "modelImprovement": "String" } ] データタイプ：アレイ。 | | \.\.nominalInputFields.fieldName | 標準的な入力フィールド名。 データタイプ：文字列。 | | \.\.nominalInputFields.modelImprovement | このフィールドが結果を改善する可能性を相対的に示すスコア。 データタイプ：文字列としての数字。 | | \.textInputFields | テキスト入力フィールドの詳細。 "textInputFields": [ { "fieldName": "String", "density": "String" } ] データタイプ：アレイ。 | | \.textInputFields.fieldName | テキスト入力フィールドの名前。 データタイプ：文字列。 | | \.textInputFields.density | フィールドが空でない頻度を表す 0 〜 1.0 の値。1.0 の値はフィールドがすべての行で空でないことを意味し、0 の値はフィールドがすべての行で空であることを示します。 データタイプ：文字列としての数字。 | [表 : 4. 返される内容] {#PredictbltyEstV-getResults__table_ztt_1xz_qlb} 次の例は、ストア内にある選択したバージョンの予測可能性推定に対する結果を取得する方法を示しています。 // 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) {#ariaid-title4} トレーニング完了ステータスを取得します。 {#PredictbltyEstV-getStatus_B__table_xfh_vbw_plb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | includeDetails | ブーリアン | ステータス details を返すかどうかを示すフラグ。 有効な値： * true：追加の詳細を返します。 * false:追加の詳細を返しません。 {#PredictbltyEstV-getStatus_B__ul_n33_ckw_plb} デフォルト：False | [表 : 5. パラメーター] {#PredictbltyEstV-getStatus_B__table_xfh_vbw_plb} {#PredictbltyEstV-getStatus_B__table_yfh_vbw_plb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | [PredictabilityEstimate](https://servicenow-prod.fluidtopics.net/cfwmprw04noTW3x1hEXr4w#PredictabilityEstimateAPI "PredictabilityEstimate API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。このオブジェクトは、データセットのフィールドがどの程度予測可能か、またそのフィールドの予測にどの機能が役立つかという推定を提供します。") オブジェクト のトレーニングステータス情報を含む JavaScript オブジェクト。 { "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 (terminal) * solution_complete (terminal) * solution_error (terminal) * solution_incomplete * training_request_received * training_request_timed_out (terminal) * training_solution * Uploading_solution * waiting_for_training {#PredictbltyEstV-getStatus_B__ul_a5q_gh4_vlb} データタイプ：文字列 | | \.hasJobEnded | トレーニングが完了したかどうかを示すフラグ。 有効な値： * true：トレーニングは完了しました。 * false：トレーニングは完了していません。 {#PredictbltyEstV-getStatus_B__ul_icy_zjx_rlb} データタイプ：文字列としてのブール値 | | \.percentComplete | トレーニング完了率。完了率が 100 未満の場合、ジョブはターミナルステータスである可能性があります。たとえば、トレーニングがタイムアウトした場合などです。 データタイプ：文字列としての数値 範囲: 0 から 100 | | \.details | 追加のトレーニングの詳細のリストを含むオブジェクト。 データタイプ：オブジェクト | [表 : 6. 返される内容] {#PredictbltyEstV-getStatus_B__table_yfh_vbw_plb} 次の例は、トレーニングが完了して成功した結果を示しています。 // 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() {#ariaid-title5} 予測可能性推定オブジェクトのバージョン番号を取得します。 {#PredictbltyEstV-getVersionNumber__table_jsz_sbw_plb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 7. パラメーター] {#PredictbltyEstV-getVersionNumber__table_jsz_sbw_plb} {#PredictbltyEstV-getVersionNumber__table_ksz_sbw_plb__entry__2} | タイプ | 説明 | |-|-| | 文字列 | バージョン番号。 | [表 : 8. 返される内容] {#PredictbltyEstV-getVersionNumber__table_ksz_sbw_plb} 次の例は、バージョン番号を取得する方法を示しています。 // 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