---
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


---

# SimilaritySolution - グローバル

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

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

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

この API には 予測インテリジェンス プラグイン (com.glide.platform_ml) が必要です。この API は `sn_ml` 名前空間内で提供されます。  
ソリューションのセットアップからトレーニングまでのフローは次のとおりです。

1. [Encoder](https://www.servicenow.com/docs/vZtCHwQ5a_NlIiS99H8RMA#EncoderAPI "Encoder API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトを提供します。このオブジェクトは、Encoder 固有の目標と構成に基づいて、入力データを数値のベクトルに変換します。エンコーダーは、エンコーディングを実行するために個別に使用することも、テキスト列をエンコードするソリューションの一部として構成することもできます。") API を使用してエンコーダーを構築します。
2. [コンストラクタ―](https://www.servicenow.com/docs/3IZ94f09vrxyXV4Bi~9RVg#SimilaritySol-SimilaritySolution_O "類似性ソリューションを作成します。") を使用して、類似性ソリューションオブジェクトを作成します。
3. [SimilaritySolutionStore - add()](https://www.servicenow.com/docs/rNKgysQiY05q5kuMoleqLQ#SimilarityStore-add_O "新しいソリューション オブジェクトをストアに追加し、一意の名前を返します。") メソッドを使用して、ソリューションオブジェクトを類似性ソリューションストアに追加します。
4. [submitTrainingJob()](https://www.servicenow.com/docs/3IZ94f09vrxyXV4Bi~9RVg#SimilaritySol-submitTrainingJob "トレーニングジョブを送信します。") メソッドを使用してソリューションをトレーニングします。これにより、[SimilaritySolutionVersion](https://www.servicenow.com/docs/equ~GRsFSdl8jei5W_KXLw#SimilaritySolutionVersionAPI "SimilaritySolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") API を使用して管理できるオブジェクトのバージョンが作成されます。
5. [SimilaritySolutionVersion -- predict()](https://www.servicenow.com/docs/equ~GRsFSdl8jei5W_KXLw#SimilarityVersion-predict_O_O "予測の入力データを取得します。") メソッドを使用して予測を取得します。

{#SimilaritySolutionAPI__ol_mmm_n1c_dmb}  
注:  
この API は全権限で実行します。ユーザーのアクセスを制限するには、スクリプトにアクセス制御メカニズムを含めます。

使用上のガイドラインについては、「 [ML API の使用](https://www.servicenow.com/docs/access?context=using-ml-apis&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)」を参照してください。

## SimilaritySolution - SimilaritySolution(オブジェクト config) {#ariaid-title2}

類似性ソリューションを作成します。
{#SimilaritySol-SimilaritySolution_O__table_gm2_yt5_flb__entry__3}{#SimilaritySol-SimilaritySolution_O__solution-obj-domainN-default}{#SimilaritySol-SimilaritySolution_O__solution-obj-lang-desc}{#SimilaritySol-SimilaritySolution_O__solution-obj-stop-desc}

| 名前 | タイプ | 説明 |
|-|-|-|
| config | オブジェクト | の構成プロパティを含む JavaScript オブジェクト ソリューション。 { "domainName": "String", "encoder": {Object}, "label": "String", "lookupDataset": {Object}, "minRowCount": "String", "processingLanguage": "String", "stopwords": [Array], "testDataset": {Object}, "trainingFrequency": "String", "updateFrequency": "String" } |
| config.domainName | 文字列 | オプション。このデータセットに関連付けられたドメイン名。[「ドメインセパレーション」および予測インテリジェンス](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)「」を参照してください。 デフォルト：現在のドメイン。例：`"global"`。 |
| config.encoder | オブジェクト | このソリューションに割り当てるトレーニング済みのエンコーダーオブジェクト。「[Encoder - Encoder(オブジェクト config)](https://www.servicenow.com/docs/vZtCHwQ5a_NlIiS99H8RMA#Encoder-Encoder_O "Encoder を作成します。")」を参照してください。 |
| config.label | 文字列 | 予測タスクを識別します。 |
| config.lookupDataset | オブジェクト | ルックアップセットとして使用する [DatasetDefinition](https://www.servicenow.com/docs/kERREiAlGZUL679rFNdNtw#DatasetDefinitionAPI "DatasetDefinition API は、ML トレーニングアルゴリズムの入力として使用する、テーブル名、列、および行の選択基準を含むレコードのセット。データセットには実際のデータは含まれていません。") の名前。 |
| config.minRowCount | 文字列 | オプション。トレーニング用のデータセットに必要なレコードの最小数。 デフォルト：10000 |
| config.processingLanguage | 文字列 | オプション。2 文字の ISO 639-1 言語コード形式の処理言語。 デフォルト値：「en」 |
| config.stopwords | アレイ | オプション。language プロパティ設定に基づいて自動的に生成される文字列のプリセットリスト。詳しくは、 [カスタムストップワードリストの作成](https://www.servicenow.com/docs/access?context=create-custom-stopwords-list&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)を参照してください。 デフォルト：英語のストップワード |
| config.testDataset | オブジェクト | lookupDataset の結果との類似性をスキャンする [DatasetDefinition](https://www.servicenow.com/docs/kERREiAlGZUL679rFNdNtw#DatasetDefinitionAPI "DatasetDefinition API は、ML トレーニングアルゴリズムの入力として使用する、テーブル名、列、および行の選択基準を含むレコードのセット。データセットには実際のデータは含まれていません。") の名前。 |
| config.trainingFrequency | 文字列 | オプション。 モデルを再トレーニングする頻度。 可能な値： * every_30_days * every_60_days * every_90_days * every_120_days * every_180_days * run_once {#SimilaritySol-SimilaritySolution_O__ul_pmw_523_plb}デフォルト：run_once |
| config.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 {#SimilaritySol-SimilaritySolution_O__ul_kjm_2jh_3mb}デフォルト：do_not_update |
[表 : 1. パラメーター]

{#SimilaritySol-SimilaritySolution_O__table_gm2_yt5_flb}  
次の例は、オブジェクトを作成して SimilaritySolution ストア。

    var incidentData = new sn_ml.DatasetDefinition({
            'tableName' : 'incident',
            'fieldNames' : ['category', 'short_description']        
        });
        var kbData = new sn_ml.DatasetDefinition({
            'tableName' : 'kb_knowledge',
            'fieldNames' : ['short_description'],
            'encodedQuery' : 'active=true'
        });
        var encoder = sn_ml.EncoderStore.get('GloVe');
        var mySolution = new sn_ml.SimilaritySolution({
            'label': "similarity solution",
            'lookupDataset' : kbData,
            'testDataset' : incidentData,        
            'encoder' : encoder        
        });
        
        // add solution
        var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);

## SimilaritySolution - cancelTrainingJob() {#ariaid-title3}

トレーニングのために送信されたソリューションオブジェクトのジョブをキャンセルします。
{#SimilaritySol-cancelTrainingJob__table_bpb_k3z_llb__entry__3}

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

{#SimilaritySol-cancelTrainingJob__table_bpb_k3z_llb} {#SimilaritySol-cancelTrainingJob__table_cpb_k3z_llb__entry__2}

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

{#SimilaritySol-cancelTrainingJob__table_cpb_k3z_llb}  
次の例は、既存のトレーニングジョブをキャンセルする方法を示しています。

    var mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity');

    mySolution.cancelTrainingJob();

## SimilaritySolution - getActiveVersion() {#ariaid-title4}

アクティブな SimilaritySolutionVersion オブジェクト。
{#SimilaritySol-getActiveVersion__table_tvl_m3z_llb__entry__3}

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

{#SimilaritySol-getActiveVersion__table_tvl_m3z_llb} {#SimilaritySol-getActiveVersion__table_uvl_m3z_llb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | アクティブな [SimilaritySolutionVersion](https://www.servicenow.com/docs/equ~GRsFSdl8jei5W_KXLw#SimilaritySolutionVersionAPI "SimilaritySolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") オブジェクト。 |
[表 : 5. 返される内容]

{#SimilaritySol-getActiveVersion__table_uvl_m3z_llb}  
次の例は、 SimilaritySolution ストアからアクティブなバージョンを取得し、そのトレーニング状態を返す

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_similarity');

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

出力:

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

## SimilaritySolution - getAllVersions() {#ariaid-title5}

のすべてのバージョンを取得します SimilaritySolution オブジェクト。
{#SimilaritySol-getAllVersions__table_tvl_m3z_llb__entry__3}

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

{#SimilaritySol-getAllVersions__table_tvl_m3z_llb} {#SimilaritySol-getAllVersions__table_uvl_m3z_llb__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | ソリューションオブジェクトの既存のバージョン。関連項目 [SimilaritySolutionVersion](https://www.servicenow.com/docs/equ~GRsFSdl8jei5W_KXLw#SimilaritySolutionVersionAPI "SimilaritySolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") API 。 |
[表 : 7. 返される内容]

{#SimilaritySol-getAllVersions__table_uvl_m3z_llb}  
次の例は、すべての SimilaritySolution バージョンオブジェクトを取得し、それらに対して getVersionNumber() および getStatus() ソリューションバージョンメソッドを呼び出す方法を示しています。

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_Similarity');

    var mlSolutionVersions = mlSolution.getAllVersions();

    for (i = 0; i < mlSolutionVersions.length; i++) {
    gs.print("Version " + mlSolutionVersions[i].getVersionNumber() + " Status: " + mlSolutionVersions[i].getStatus() +"\n");

出力:

    Version 3 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}

    Version 2 Status: {"state":"solution_complete","percentComplete":"100","hasJobEnded":"true"}

    Version 1 Status: {"state":"solution_cancelled","percentComplete":"0","hasJobEnded":"true"}

## SimilaritySolution - getLatestVersion() {#ariaid-title6}

ソリューション の最新バージョンを取得します。
{#SimilaritySol-getLatestVersion__table_tvl_m3z_llb__entry__3}

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

{#SimilaritySol-getLatestVersion__table_tvl_m3z_llb} {#SimilaritySol-getLatestVersion__table_uvl_m3z_llb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | [SimilaritySolutionVersion](https://www.servicenow.com/docs/equ~GRsFSdl8jei5W_KXLw#SimilaritySolutionVersionAPI "SimilaritySolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") の最新バージョンに対応するオブジェクト[SimilaritySolution](https://www.servicenow.com/docs/3IZ94f09vrxyXV4Bi~9RVg#SimilaritySol-SimilaritySolution_O "類似性ソリューションを作成します。")。 |
[表 : 9. 返される内容]

{#SimilaritySol-getLatestVersion__table_uvl_m3z_llb}  
次の例は、ソリューションの最新バージョンを取得して、トレーニングのステータスを返す方法を示しています。{#SimilaritySol-getLatestVersion__mlsol-getLatestVersion-example}

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_Similarity');

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

出力:

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

## SimilaritySolution - getName() {#ariaid-title7}

ストアの操作に使用するオブジェクトの名前を取得します。
{#SimilaritySol-getName__table_pps_43z_llb__entry__3}

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

{#SimilaritySol-getName__table_pps_43z_llb} {#SimilaritySol-getName__table_qps_43z_llb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ソリューションオブジェクトの名前。 |
[表 : 11. 返される内容]

{#SimilaritySol-getName__table_qps_43z_llb}  
次の例は、 SimilaritySolution データセット情報を更新し、オブジェクトの名前を出力

    // Update solution
    var myIncidentData = new sn_ml.DatasetDefinition({
       'tableName' : 'incident',
       'fieldNames' : ['category', 'short_description', 'priority'],
       'encodedQuery' : 'activeANYTHING'
    });

    var eligibleFields = JSON.parse(myIncidentData.getEligibleFields('Similarity'));

    var mySimilarity = new sn_ml.SimilaritySolution({
       'label': "my Similarity solution",
       'dataset' : myIncidentData,
       'inputFieldNames': eligibleFields['eligibleInputFieldNames'],
       'predictedFieldName': 'category'
    });

    // update solution
    sn_ml.SimilaritySolutionStore.update('ml_x_snc_global_global_my_solution_definition_4', mySimilarity);

    // print solution name
    gs.print('Solution Name: '+mySimilarity.getName());

出力:

    Solution Name: ml_x_snc_global_global_my_solution_definition_4

## SimilaritySolution - getProperties() {#ariaid-title8}

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

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

{#SimilaritySol-getProperties__table_pps_43z_llb} {#SimilaritySol-getProperties__table_qps_43z_llb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | [SimilaritySolutionStore](https://www.servicenow.com/docs/rNKgysQiY05q5kuMoleqLQ#SimilaritySolutionStoreAPI "ソリューション の保存と取得を有効にします 。") のデータセットのコンテンツと [SimilaritySolution()](https://www.servicenow.com/docs/3IZ94f09vrxyXV4Bi~9RVg#SimilaritySol-SimilaritySolution_O "類似性ソリューションを作成します。") オブジェクトの詳細。 { "domainName": "String", "encoder": {Object}, "label": "String", "lookupDatasetProperties": {Object}, "name": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "testDatasetProperties": {Object}, "trainingFrequency": "String", "updateFrequency": "String" } |
| \<Object\>.domainName | このデータセットに関連付けられたドメイン名。[「ドメインセパレーション」および予測インテリジェンス](https://www.servicenow.com/docs/access?context=domain-separation-predictive-intelligence&version=xanadu&pubname=xanadu-intelligent-experiences&ft:locale=en-US)「」を参照してください。 データタイプ：文字列。 |
| \<Object\>.encoder | このソリューションに割り当てられるエンコーダーオブジェクト。「[Encoder - Encoder(オブジェクト config)](https://www.servicenow.com/docs/vZtCHwQ5a_NlIiS99H8RMA#Encoder-Encoder_O "Encoder を作成します。")」を参照してください。 データタイプ：オブジェクト。 |
| \<Object\>.label | 予測タスクを識別します。 { "label": "my first prediction" } データタイプ：文字列。 |
| \<Object\>.lookupDatasetProperties | [DatasetDefinition()](https://www.servicenow.com/docs/kERREiAlGZUL679rFNdNtw#DDef-DatasetDefinition_O "DatasetDefinition クラスのインスタンスを作成し、テーブル名、フィールド、およびクエリーでデータセットを定義できるようにします。") ルックアップセットとして使用されるオブジェクト。の詳細 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ：オブジェクト。 |
| \<Object\>.lookupDatasetProperties.tableName | データセットのテーブルの名前。例：`"tableName" : "Incident"` データタイプ：文字列。 |
| \<Object\>.lookupDatasetProperties.fieldNames | 指定されたテーブルからの文字列としてのフィールド名のリスト。例：`"fieldNames" : ["short_description", "priority"]` データタイプ：アレイ。 |
| \<Object\>.lookupDatasetProperties.fieldNames.fieldDetails | フィールドプロパティを指定する JavaScript オブジェクトのリスト。 [ { "name": "String", "type": "String" } ] データタイプ：アレイ。 |
| \<Object\>.lookupDatasetProperties.fieldNames.fieldDetails.\<object\>.name | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ：文字列。 |
| \<Object\>.lookupDatasetProperties.fieldDetails.\<object\>.type | 機械学習フィールドタイプ。 データタイプ：文字列。 |
| \<Object\>.lookupDatasetProperties.fieldDetails.encodedQuery | 標準の Glide 形式のエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 データタイプ：文字列。 |
| \<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\>.testDatasetProperties | [DatasetDefinition()](https://www.servicenow.com/docs/kERREiAlGZUL679rFNdNtw#DDef-DatasetDefinition_O "DatasetDefinition クラスのインスタンスを作成し、テーブル名、フィールド、およびクエリーでデータセットを定義できるようにします。") このモデルで検索された結果と lookupDataset で見つかった結果の間の類似性を取得するために使用されるオブジェクト。の詳細 { "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" } データタイプ：オブジェクト。 |
| \<Object\>.testDatasetProperties.tableName | データセットのテーブルの名前。例：`"tableName" : "Incident"` データタイプ：文字列。 |
| \<Object\>.testDatasetProperties.fieldNames | 指定されたテーブルからの文字列としてのフィールド名のリスト。例：`"fieldNames" : ["short_description", "priority"]` データタイプ：アレイ。 |
| \<Object\>.testDatasetProperties.fieldNames.fieldDetails | フィールドプロパティを指定する JavaScript オブジェクトのリスト。 [ { "name": "String", "type": "String" } ] データタイプ：アレイ。 |
| \<Object\>.testDatasetProperties.fieldNames.fieldDetails.\<object\>.name | このデータセットを制限する情報のタイプを定義するフィールドの名前。 データタイプ：文字列。 |
| \<Object\>.testDatasetProperties.fieldDetails.\<object\>.type | 機械学習フィールドタイプ。 データタイプ：文字列。 |
| \<Object\>.testDatasetProperties.fieldDetails.encodedQuery | 標準の Glide 形式のエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 データタイプ：文字列。 |
| \<Object\>.trainingFrequency | モデルを再トレーニングする頻度。 可能な値： * every_30_days * every_60_days * every_90_days * every_120_days * every_180_days * run_once {#SimilaritySol-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 {#SimilaritySol-getProperties__ul_kjm_2jh_3mb}デフォルト：do_not_update データタイプ：文字列 |
[表 : 13. 返される内容]

{#SimilaritySol-getProperties__table_qps_43z_llb}  
次の例では、ストア内のソリューションオブジェクトのプロパティを取得します。{#SimilaritySol-getProperties__mlsol-getProps-example-other2}

    var mySolution = sn_ml.SimilaritySolutionStore.get('ml_sn_global_global_similarity_solution');

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

データタイプ：数値。

    *** Script: {
      "domainName": "global",
      "encoderProperties": {
        "datasetsProperties": [],
        "name": "wordCorpusA"
      },
      "label": "similarity",
      "lookupDatasetProperties": {
        "tableName": "incident",
        "fieldNames": [
          "short_description"
        ]
      },
      "name": "ml_x_snc_global_global_similarity",
      "processingLanguage": "en",
      "scope": "global",
      "stopwords": [
        "Default English Stopwords"
      ],
      "testDatasetProperties": {
        "tableName": "incident",
        "fieldNames": [
          "short_description"
        ]
      },
      "trainingFrequency": "every_30_days",
      "updateFrequency": "do_not_update"
    }

## SimilaritySolution - getVersion(文字列 version) {#ariaid-title9}

指定されたバージョン番号を使用します。ソリューションを取得します。
{#SimilaritySol-getVersion_S__table_pps_43z_llb__entry__3}{#SimilaritySol-getVersion_S__mlsol-gerversion-returns-other}

| 名前 | タイプ | 説明 |
|-|-|-|
| version | 文字列 | ソリューションの既存のバージョン番号。 |
[表 : 14. パラメーター]

{#SimilaritySol-getVersion_S__table_pps_43z_llb} {#SimilaritySol-getVersion_S__table_qps_43z_llb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | [SimilaritySolutionVersion](https://www.servicenow.com/docs/equ~GRsFSdl8jei5W_KXLw#SimilaritySolutionVersionAPI "SimilaritySolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") API メソッドを呼び出すことができる [SimilaritySolution()](https://www.servicenow.com/docs/3IZ94f09vrxyXV4Bi~9RVg#SimilaritySol-SimilaritySolution_O "類似性ソリューションを作成します。") オブジェクトの指定されたバージョン。 |
[表 : 15. 返される内容]

{#SimilaritySol-getVersion_S__table_qps_43z_llb}  
次の例は、バージョン番号別にソリューションのトレーニングステータスを取得する方法を示しています。{#SimilaritySol-getVersion_S__mlsol-gerversion-example-other}

    var mlSolution = sn_ml.SimilaritySolutionStore.get('ml_x_snc_global_global_similarity');

    gs.print(JSON.stringify(JSON.parse(mlSolution.getVersion('1').getStatus()), null, 2));

出力:

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

## SimilaritySolution - setActiveVersion(文字列 version) {#ariaid-title10}

ストア内の指定されたバージョンのソリューションをアクティブ化します。
{#SimilaritySol-setActiveVersion_S__table_pps_43z_llb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| version | 文字列 | アクティブ化する [SimilaritySolution()](https://www.servicenow.com/docs/3IZ94f09vrxyXV4Bi~9RVg#SimilaritySol-SimilaritySolution_O "類似性ソリューションを作成します。") オブジェクトバージョンの名前。 このバージョンをアクティブ化すると、他のバージョンが非アクティブになります。 |
[表 : 16. パラメーター]

{#SimilaritySol-setActiveVersion_S__table_pps_43z_llb} {#SimilaritySol-setActiveVersion_S__table_qps_43z_llb__entry__2}

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

{#SimilaritySol-setActiveVersion_S__table_qps_43z_llb}  
次の例は、ストア内のソリューションバージョンを有効にする方法を示しています。{#SimilaritySol-setActiveVersion_S__mlsol-setActive-example2}

    sn_ml.SimilaritySolution.setActiveVersion("ml_incident_categorization");

## SimilaritySolution - submitTrainingJob() {#ariaid-title11}

トレーニングジョブを送信します。
注:  
このメソッドを実行する前に、まず [SimilaritySolutionStore - add()](https://www.servicenow.com/docs/rNKgysQiY05q5kuMoleqLQ#SimilarityStore-add_O "新しいソリューション オブジェクトをストアに追加し、一意の名前を返します。") メソッドを使用してストアにソリューションを追加する必要があります。
{#SimilaritySol-submitTrainingJob__table_xmd_33z_llb__entry__3}

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

{#SimilaritySol-submitTrainingJob__table_xmd_33z_llb} {#SimilaritySol-submitTrainingJob__table_ymd_33z_llb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | [SimilaritySolutionVersion](https://www.servicenow.com/docs/equ~GRsFSdl8jei5W_KXLw#SimilaritySolutionVersionAPI "SimilaritySolutionVersion API は、予測インテリジェンス ストアで使用されるスクリプト可能なオブジェクトです。") に対応するオブジェクト [SimilaritySolution](https://www.servicenow.com/docs/3IZ94f09vrxyXV4Bi~9RVg#SimilaritySol-SimilaritySolution_O "類似性ソリューションを作成します。") トレーニング対象 |
[表 : 19. 返される内容]

{#SimilaritySol-submitTrainingJob__table_ymd_33z_llb}  

    // Create a dataset 
    var incidentData = new sn_ml.DatasetDefinition({
        'tableName' : 'incident',
        'fieldNames' : ['category', 'short_description']
    });

    var kbData = new sn_ml.DatasetDefinition({
        'tableName' : 'kb_knowledge',
        'fieldNames' : ['short_description'],
        'encodedQuery' : 'active=true'
    });

    // Create a solution 
    var encoder = sn_ml.EncoderStore.get('GloVe');
    var mySolution = new sn_ml.SimilaritySolution({
        'label': "similarity solution",
        'lookupDataset' : kbData,
        'testDataset' : incidentData,
        'encoder' : encoder,
    });

    // Add solution
    var solutionName = sn_ml.SimilaritySolutionStore.add(mySolution);


    // Train the solution - this is a long running job 
    var mySimilarityVersion = mySolution.submitTrainingJob();