SimilaritySolution - グローバル

Yokohama API リファレンス

Release

yokohama

ft:locale

ja-JP

ft:publication_title

Yokohama API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

SimilaritySolution - グローバル

リリースバージョン: Yokohama

更新日 2025年01月30日

所要時間：21分

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

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

ソリューションのセットアップからトレーニングまでのフローは次のとおりです。

Encoder API を使用してエンコーダーを構築します。
コンストラクタ― を使用して、類似性ソリューションオブジェクトを作成します。
SimilaritySolutionStore - add() メソッドを使用して、ソリューションオブジェクトを類似性ソリューションストアに追加します。
submitTrainingJob() メソッドを使用してソリューションをトレーニングします。これにより、SimilaritySolutionVersion API を使用して管理できるオブジェクトのバージョンが作成されます。
SimilaritySolutionVersion – predict() メソッドを使用して予測を取得します。

注:

この API は、Washington DC パッチ 7 リリースより前の完全な権限で実行されます。このリリース以降は、ACL を使用してアクセス権を付与します。詳細については、「Query ACLs」を参照してください。

使用上のガイドラインについては、「 ML API の使用」を参照してください。

SimilaritySolution - SimilaritySolution(オブジェクト config)

類似性ソリューションを作成します。

表 : 1. パラメーター
名前	タイプ	説明
config	オブジェクト	の構成プロパティを含む JavaScript オブジェクトソリューション。 `{ "domainName": "String", "encoder": {Object}, "label": "String", "lookupDataset": {Object}, "minRowCount": "String", "processingLanguage": "String", "stopwords": [Array], "testDataset": {Object}, "trainingFrequency": "String", "updateFrequency": "String" }`
config.domainName	文字列	オプション。このデータセットに関連付けられたドメイン名。ドメインセパレーションおよび予測インテリジェンスを参照してください。デフォルト：現在のドメイン。例：`"global"`。
config.encoder	オブジェクト	このソリューションに割り当てるトレーニング済みのエンコーダーオブジェクト。「Encoder - Encoder(オブジェクト config)」を参照してください。
config.label	文字列	予測タスクを識別します。
config.lookupDataset	オブジェクト	ルックアップセットとして使用する DatasetDefinition の名前。
config.minRowCount	文字列	オプション。トレーニング用のデータセットに必要なレコードの最小数。デフォルト：10000
config.processingLanguage	文字列	オプション。2 文字の ISO 639-1 言語コード形式の処理言語。デフォルト値：「en」
config.stopwords	アレイ	オプション。language プロパティ設定に基づいて自動的に生成される文字列のプリセットリスト。詳細については、「カスタムストップワードリストを作成する」を参照してください。デフォルト：英語のストップワード
config.testDataset	オブジェクト	lookupDataset の結果との類似性をスキャンする DatasetDefinition の名前。
config.trainingFrequency	文字列	オプション。モデルを再トレーニングする頻度。可能な値： every_30_days every_60_days every_90_days every_120_days every_180_days run_once デフォルト：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 デフォルト：do_not_update

次の例は、オブジェクトを作成して 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()

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

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

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

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

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

mySolution.cancelTrainingJob();

SimilaritySolution - getActiveVersion()

アクティブな SimilaritySolutionVersion オブジェクト。

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

表 : 5. 返される内容
タイプ	説明
オブジェクト	アクティブな SimilaritySolutionVersion オブジェクト。

次の例は、 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()

のすべてのバージョンを取得します SimilaritySolution オブジェクト。

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

表 : 7. 返される内容
タイプ	説明
アレイ	ソリューションオブジェクトの既存のバージョン。関連項目 SimilaritySolutionVersion API 。

次の例は、すべての 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()

ソリューションの最新バージョンを取得します。

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

表 : 9. 返される内容
タイプ	説明
オブジェクト	SimilaritySolutionVersion の最新バージョンに対応するオブジェクトSimilaritySolution。

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

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

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

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

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

次の例は、 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()

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

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

表 : 13. 返される内容
タイプ	説明
オブジェクト	SimilaritySolutionStore のデータセットのコンテンツと SimilaritySolution() オブジェクトの詳細。 `{ "domainName": "String", "encoder": {Object}, "label": "String", "lookupDatasetProperties": {Object}, "name": "String", "processingLanguage": "String", "scope": "String", "stopwords": [Array], "testDatasetProperties": {Object}, "trainingFrequency": "String", "updateFrequency": "String" }`
<Object>.domainName	このデータセットに関連付けられたドメイン名。ドメインセパレーションおよび予測インテリジェンスを参照してください。データタイプ：文字列。
<Object>.encoder	このソリューションに割り当てられるエンコーダーオブジェクト。「Encoder - Encoder(オブジェクト config)」を参照してください。データタイプ：オブジェクト。
<Object>.label	予測タスクを識別します。 `{ "label": "my first prediction" }` データタイプ：文字列。
<Object>.lookupDatasetProperties	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 形式のエンコードされたクエリ文字列。「エンコードされたクエリ文字列」を参照してください。データタイプ：文字列。
<Object>.name	システムによって割り当てられた名前。データタイプ：文字列。
<Object>.processingLanguage	2 文字の ISO 639-1 言語コード形式の処理言語。データタイプ：文字列。
<Object>.scope	オブジェクトスコープ。現在、有効な値は `global` のみです。データタイプ：文字列
<Object>.stopwords	オプション。language プロパティ設定に基づいて自動的に生成される文字列のプリセットリスト。詳細については、「カスタムストップワードリストを作成する」を参照してください。データタイプ：アレイ。
<Object>.testDatasetProperties	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 形式のエンコードされたクエリ文字列。「エンコードされたクエリ文字列」を参照してください。データタイプ：文字列。
<Object>.trainingFrequency	モデルを再トレーニングする頻度。可能な値： every_30_days every_60_days every_90_days every_120_days every_180_days run_once デフォルト：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 デフォルト：do_not_update データタイプ：文字列

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

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)

指定されたバージョン番号を使用します。ソリューションを取得します。

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

表 : 15. 返される内容
タイプ	説明
オブジェクト	SimilaritySolutionVersion API メソッドを呼び出すことができる SimilaritySolution() オブジェクトの指定されたバージョン。

次の例は、バージョン番号別にソリューションのトレーニングステータスを取得する方法を示しています。

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)

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

表 : 16. パラメーター
名前	タイプ	説明
version	文字列	アクティブ化する SimilaritySolution() オブジェクトバージョンの名前。このバージョンをアクティブ化すると、他のバージョンが非アクティブになります。

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

次の例は、ストア内のソリューションバージョンを有効にする方法を示しています。

sn_ml.SimilaritySolution.setActiveVersion("ml_incident_categorization");

SimilaritySolution - submitTrainingJob()

トレーニングジョブを送信します。

注:

このメソッドを実行する前に、まず SimilaritySolutionStore - add() メソッドを使用してストアにソリューションを追加する必要があります。

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

表 : 19. 返される内容
タイプ	説明
オブジェクト	SimilaritySolutionVersion に対応するオブジェクト類似ソリューショントレーニング対象

// 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();