--- 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 --- # SimilaritySolutionVersion - グローバル # SimilaritySolutionVersion - グローバル {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：18分 SimilaritySolutionVersion API は、予測インテリジェンスストアで使用されるスクリプト可能なオブジェクトです。 この API には 予測インテリジェンス プラグイン (com.glide.platform_ml) が必要で、 `sn_ml` 名前空間内で提供されます。 この API は、[SimilaritySolution ストア](https://servicenow-prod.fluidtopics.net/ByXaTP0NXoSjurAS_q~xiw#SimilaritySolutionStoreAPI "ソリューション の保存と取得を可能にします 。")の [SimilaritySolution API](https://servicenow-prod.fluidtopics.net/SByiMqFOsibdVzpG_zwp8g#SimilaritySolutionAPI "SimilaritySolution API は、予測インテリジェンスストアで使用されるスクリプト可能なオブジェクトです。") オブジェクトに基づくソリューションバージョンを操作するために使用されます。 ソリューション定義をトレーニングするたびに、ソリューションバージョンが作成されます。ほとんどのバージョンは、スケジュールされたソリューショントレーニング中に作成されます。 この API のメソッドには、次の SimilaritySolution メソッドを使用してアクセスできます。 * [getActiveVersion()](https://servicenow-prod.fluidtopics.net/SByiMqFOsibdVzpG_zwp8g#SimilaritySol-getActiveVersion "アクティブを取得します SimilaritySolutionVersion オブジェクト。") * [getAllVersions()](https://servicenow-prod.fluidtopics.net/SByiMqFOsibdVzpG_zwp8g#SimilaritySol-getAllVersions "のすべてのバージョンを取得しますSimilaritySolution オブジェクト。") * [getLatestVersion()](https://servicenow-prod.fluidtopics.net/SByiMqFOsibdVzpG_zwp8g#SimilaritySol-getLatestVersion "の最新バージョンを取得します 解決策。") * [getVersion()](https://servicenow-prod.fluidtopics.net/SByiMqFOsibdVzpG_zwp8g#SimilaritySol-getVersion_S "ソリューションを取得します 指定されたバージョン番号で。") {#SimilaritySolutionVersionAPI__ul_ycl_fzf_tlb} ## SimilaritySolutionVersion:getProperties() {#ariaid-title2} ソリューションオブジェクトプロパティを取得します およびバージョン番号。 {#SimilarityVersion-getProperties__table_d2m_zwz_4lb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 1. パラメーター] {#SimilarityVersion-getProperties__table_d2m_zwz_4lb} {#SimilarityVersion-getProperties__table_e2m_zwz_4lb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | データセットの内容と [SimilaritySolution](https://servicenow-prod.fluidtopics.net/SByiMqFOsibdVzpG_zwp8g#SimilaritySolutionAPI "SimilaritySolution API は、予測インテリジェンスストアで使用されるスクリプト可能なオブジェクトです。") バージョンの詳細。結果は、オブジェクトプロパティの設定によって異なります。 { "domainName": "String", "isActive": "String", "label": "String", "lookupDatasetProperties": {Object}, "name": "String", "predictedFieldName": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "testDatasetProperties": {Object}, "trainingFrequency": "String", "updateFrequency": "String", "versionNumber": "String" } | | \.domainName | このデータセットに関連付けられたドメイン名。「 [ドメインセパレーション」および 予測インテリジェンス](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=australia&pubname=australia-intelligent-experiences&ft:locale=en-US)を参照してください。 データタイプ:文字列。 | | \.isActive | このバージョンがアクティブかどうかを示すフラグ。 有効な値： * true:バージョンはアクティブです。 * false:バージョンはアクティブではありません。 {#SimilarityVersion-getProperties__ul_i5m_lp1_dmb} データタイプ：文字列 | | \.label | 予測タスクを識別します。 { "label": "my first prediction" } データタイプ:文字列。 | | \.lookupDatasetProperties | [DatasetDefinition()](https://servicenow-prod.fluidtopics.net/_Y4D37G2Ep8vLiDiwFGIhA#DDef-DatasetDefinition_O "DatasetDefinition クラスのインスタンスを作成し、テーブル名、フィールド、およびクエリでデータセットを定義できるようにします。") ルックアップセットとして使用されるオブジェクト。 の詳細 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ:オブジェクト。 | | \.lookupDatasetProperties.tableName | データセットのテーブルの名前。たとえば、「 `tableName」:「インシデント」`です。 データタイプ:文字列。 | | \.lookupDatasetProperties.fieldNames | 指定されたテーブルのフィールド名を文字列としてリストします。例:"`fieldNames" : ["short_description", "priority"]。` データタイプ:アレイ。 | | \.lookupDatasetProperties.fieldNames.fieldDetails | フィールドのプロパティを指定する JavaScript オブジェクトのリスト。 [ { "name": "String", "type": "String" } ] データタイプ:アレイ。 | | \.lookupDatasetProperties.fieldNames.fieldDetails.\.名前 | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ:文字列。 | | \.lookupDatasetProperties.fieldDetails.\.タイプ | 機械学習フィールドタイプ。 データタイプ:文字列。 | | \.lookupDatasetProperties.fieldDetails.encodedQuery | 標準の Glide 形式でエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列」](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US)を参照してください。 データタイプ:文字列。 | | \.name | システムによって割り当てられた名前。 データタイプ:文字列。 | | \.predictedFieldName | 予測可能性のためにトレーニングするフィールドを識別します。 データタイプ:文字列。 | | \.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)」を参照してください。 データタイプ:アレイ。 | | \.testDatasetProperties | [DatasetDefinition()](https://servicenow-prod.fluidtopics.net/_Y4D37G2Ep8vLiDiwFGIhA#DDef-DatasetDefinition_O "DatasetDefinition クラスのインスタンスを作成し、テーブル名、フィールド、およびクエリでデータセットを定義できるようにします。") このモデルで検索された結果と lookupDatasetで見つかった結果の類似性を取得するために使用されるオブジェクト。 の詳細 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ:オブジェクト。 | | \.testDatasetProperties.tableName | データセットのテーブルの名前。たとえば、「 `tableName」:「インシデント」`です。 データタイプ:文字列。 | | \.testDatasetProperties.fieldNames | 指定されたテーブルのフィールド名を文字列としてリストします。例:"`fieldNames" : ["short_description", "priority"]。` データタイプ:アレイ。 | | \.testDatasetProperties.fieldNames.fieldDetails | フィールドのプロパティを指定する JavaScript オブジェクトのリスト。 [ { "name": "String", "type": "String" } ] データタイプ:アレイ。 | | \.testDatasetProperties.fieldNames.fieldDetails.\.名前 | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ:文字列。 | | \.testDatasetProperties.fieldDetails.\.タイプ | 機械学習フィールドタイプ。 データタイプ:文字列。 | | \.testDatasetProperties.fieldDetails.encodedQuery | 標準の Glide 形式でエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列」](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US)を参照してください。 データタイプ:文字列。 | | \.trainingFrequency | モデルを再トレーニングする頻度。 可能な値： * every_30_days * every_60_days * every_90_days * every_120_days * every_180_days * run_once {#SimilarityVersion-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 {#SimilarityVersion-getProperties__ul_kjm_2jh_3mb}デフォルト値:do_not_update データタイプ:文字列 | | \.versionNumber | のバージョン番号 SimilaritySolution オブジェクト。 データタイプ:文字列。 | [表 : 2. 返される内容] {#SimilarityVersion-getProperties__table_e2m_zwz_4lb} 次の例では、ストア内のアクティブなオブジェクトバージョンのプロパティを取得します。 // Get properties var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_similarity_solution'); gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2)); 出力： *** Script: { "domainName": "global", "encoderProperties": { "datasetsProperties": [], "name": "wordCorpusA" }, "isActive": "true", "label": "similarity", "lookupDatasetProperties": { "encodedQuery": "", "fieldNames": [ "short_description" ], "tableName": "incident" }, "name": "ml_x_snc_global_global_similarity", "processingLanguage": "en", "stopwords": [ "Default English Stopwords" ], "testDatasetProperties": { "fieldNames": [ "short_description" ], "tableName": "incident" }, "versionNumber": "3" } ## SimilaritySolutionVersion:getStatus(ブール値 includeDetails) {#ariaid-title3} トレーニング完了ステータスを取得します。 {#SimilarityVersion-getStatus_B__table_xfh_vbw_plb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | includeDetails | ブーリアン | ステータスを details にするかどうかを示すフラグ。 有効な値： * true:追加の詳細を返します。 * false:追加の詳細を返しません。 {#SimilarityVersion-getStatus_B__ul_n33_ckw_plb} デフォルト値：False | [表 : 3. パラメーター] {#SimilarityVersion-getStatus_B__table_xfh_vbw_plb} {#SimilarityVersion-getStatus_B__table_yfh_vbw_plb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | のトレーニングステータス情報を含む JavaScript オブジェクト[SimilaritySolution](https://servicenow-prod.fluidtopics.net/SByiMqFOsibdVzpG_zwp8g#SimilaritySolutionAPI "SimilaritySolution 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 {#SimilarityVersion-getStatus_B__ul_a5q_gh4_vlb} データタイプ：文字列 | | \.hasJobEnded | トレーニングが完了したかどうかを示すフラグ。 有効な値： * true:トレーニングが完了しました。 * false:トレーニングが不完全です。 {#SimilarityVersion-getStatus_B__ul_icy_zjx_rlb} データタイプ:文字列としてのブール値 | | \.percentComplete | トレーニング完了率。完了率が 100 未満の場合、ジョブはターミナル状態である可能性があります。たとえば、トレーニングがタイムアウトした場合などです。 データタイプ:文字列としての数値 範囲:0〜100 | | \.details | 追加のトレーニング詳細のリストを含むオブジェクト。 データタイプ: オブジェクト | [表 : 4. 返される内容] {#SimilarityVersion-getStatus_B__table_yfh_vbw_plb} 次の例は、トレーニングが完了した正常な結果を示しています。 // Get status var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_similarity_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_similarity_solution'; var mlSolution = sn_ml.SimilaritySolutionStore.get(solutionName); var trainingStatus = JSON.parse(mlSolution.getLatestVersion().getStatus()); gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2)); 出力： { "state":"solution_error", "percentComplete":"100", "hasJobEnded":"true" } ## SimilaritySolutionVersion:getVersionNumber() {#ariaid-title4} のバージョン番号を取得します ソリューションオブジェクト。 {#SimilarityVersion-getVersionNumber__table_jsz_sbw_plb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | なし | | | [表 : 5. パラメーター] {#SimilarityVersion-getVersionNumber__table_jsz_sbw_plb} {#SimilarityVersion-getVersionNumber__table_ksz_sbw_plb__entry__2} | タイプ | 説明 | |-|-| | 文字列 | バージョン番号。 | [表 : 6. 返される内容] {#SimilarityVersion-getVersionNumber__table_ksz_sbw_plb} 次の例は、バージョン番号を取得する方法を示しています。 // Get version number var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_similarity_solution'); gs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2)); 出力： Version number: 1 ## SimilaritySolutionVersion - predict(オブジェクト入力, オブジェクトオプション) {#ariaid-title5} 予測の入力データを取得します。 {#SimilarityVersion-predict_O_O__table_wwz_pbw_plb__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | input | オブジェクト | [GlideRecord](https://servicenow-prod.fluidtopics.net/k3bj5xjwIDZp86NECoEt2A#c_GlideRecordAPI "GlideRecord API はデータベース操作に使用されます。") または、フィールド名と値をキーと値のペアとして含む JSON オブジェクトのアレイ。 | | オプション | オブジェクト | 予測結果をフィルタリングするためのオプションの値。 { "apply_threshold": Boolean, "top_n": Number } | | options.apply_threshold | ブーリアン | ソリューションのしきい値を確認し、結果セットに適用するかどうかを示すフラグ。 有効な値： * true:信頼性がしきい値より大きい結果を返します。 * false:すべての結果を返します。 {#SimilarityVersion-predict_O_O__ul_f4d_xyx_slb} デフォルト：True | | options.top_n | 数値 | 指定した場合、指定された数の予測まで、上位の結果を返します。 | [表 : 7. パラメーター] {#SimilarityVersion-predict_O_O__table_wwz_pbw_plb} {#SimilarityVersion-predict_O_O__table_xwz_pbw_plb__entry__2} | タイプ | 説明 | |-|-| | オブジェクト | sys_idまたはrecord_numberでソートされた予測結果を含む JSON オブジェクト。 { : [Array] } | | \.\ | 各予測結果の詳細を含むオブジェクトのリスト。 データタイプ：オブジェクトのアレイ : [ { "confidence": Number, "predictedSysId": "String", "predictedValue": "String", "threshold": Number } ] | | \.\.\.信頼性 | 予測に関連付けられた信頼度の値。例:53.84。 データタイプ：数値 | | \.\.\.predictedSysId | 予測値のsys_id。結果は、情報が予測されている任意のテーブルから取得できます。 データタイプ：文字列 | | \.\.\.予測値 | 予測結果を表す値。 データタイプ：文字列 | | \.\.\.しきい値 | 予測に関連付けられた構成済みのしきい値の値。 データタイプ：数値 | [表 : 8. 返される内容] {#SimilarityVersion-predict_O_O__table_xwz_pbw_plb} 次の例は、入力に GlideRecord をsys_id別に取得し、上位 3 件の結果に制限し、しきい値を除外するオプションのパラメーターを含む predict() メソッドの予測結果を表示する方法を示しています。 var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_similarity_solution'); // single GlideRecord input var input = new GlideRecord("incident"); input.get(""); // 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)); { "": [ { "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": "" } ] } 次の例は、フィールド名のアレイを入力のキーと値のペアとして受け取り、上位 3 つの結果に制限し、しきい値を除外するオプションのパラメーターを含む predict() メソッドの予測結果を表示する方法を示しています。 var mlSolution = sn_ml.SimilaritySolutionStore.get("ml_x_snc_global_similarity_solution"); // 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": "" } ] }