まとめ: ML API フロー

次のフローを使用して、ソリューション、エンコーダー、予測可能性推定を構成およびトレーニングできます。

注:

エンコーダー定義は複数のデータセット定義をサポートしていますが、トレーニングフローは同じです。

エンコーダーを使用してソリューションをトレーニングするには、まずエンコーダーを作成してから、そのエンコーダーをソリューション構成に含めます。

ML オブジェクト エンコーダーの要件:

• 類似性 API ソリューションでは必須です。
• レーベンシュタイン距離アルゴリズムを使用しない限り、クラスタリング API ソリューションでは必須です。ただし、この場合、エンコーダーはオプションです。
• 分類および回帰ソリューションではオプションです。
• 予測可能性推定には使用できません。

ソリューションの構成とトレーニング

1. DatasetDefinition API を使用してデータセットを定義します。

   var myData = new sn_ml.DatasetDefinition({
   
     'tableName' : 'incident',
     'fieldNames' : ['assignment_group', 'short_description', 'description'],
     'encodedQuery' : 'activeANYTHING'
   
   });

2. コンストラクターを使用して、構成内のデータセットを含むソリューションを定義します。

   var mySolution = new sn_ml.ClassificationSolution({
   
     'label': "my solution definition",
     'dataset' : myData,
     'predictedFieldName' : 'assignment_group',
     'inputFieldNames':['short_description']
   
   });

   • ClassificationSolution()
   • ClusteringSolution()
   • エンコーダ()
   • PredictabilityEstimate()
   • RegressionSolution()
   • SimilaritySolution()
3. add() メソッドを使用して、ソリューション定義をストアに追加します。

   var my_unique_name = sn_ml.ClassificationSolutionStore.add(mySolution);

   • ClassificationSolutionStore - add()
   • ClusteringSolutionStore – add()
   • EncoderStore - add()
   • PredictabilityEstimateStore - add()
   • RegressionSolutionStore - add()
   • SimilaritySolutionStore - add()
4. submitTrainingJob() メソッドを使用してソリューションをトレーニングします。トレーニングが完了したら、ソリューションバージョン API を使用してトレーニング済みソリューションを管理できます。ソリューションは何度でも再トレーニングできます。各トレーニングは、推論を実行できる新しいソリューション "バージョン" になります。

   var myClassifierVersion = mySolution.submitTrainingJob();

   • ClassificationSolution - submitTrainingJob()
   • ClusteringSolutionVersion – submitTrainingJob()
   • Encoder - submitTrainingJob()
   • PredictabilityEstimate - submitTrainingJob()
   • RegressionSolution - submitTrainingJob()
   • SimilaritySolution - submitTrainingJob()

ストア内のすべての分類ソリューションを表示する

ストアの getAllNames() メソッドを使用して、ストアに追加されたすべてのソリューションのリストを表示できます。

gs.print(JSON.stringify(JSON.parse(sn_ml.ClassificationSolutionStore.getAllNames()), null, 2));

出力では、ソリューションに ml_x_snc_global_global_my_solution_definition という名前が付けられ ています。後続の例でこの名前を使用して、バージョン情報を取得します。

*** Script: [
  "ml_incident_assignment",
  "ml_x_snc_global_global_my_solution_definition",
  "ml_incident_categorization"
]

• ClassificationSolutionStore - getAllNames()
• ClusteringSolutionStore – getAllNames()
• EncoderStore - getAllNames()
• PredictabilityEstimateStore - getAllNames()
• RegressionSolutionStore - getAllNames()
• SimilaritySolutionStore - getAllNames()

トレーニングステータスを確認

ストアから分類ソリューションを取得し、バージョンを選択して、そのトレーニングステータスを確認します。トレーニング ステータスの確認に使用される方法は、すべての ML オブジェクト タイプに適用できます。

1. get() メソッドを使用して、分類ソリューションストアからソリューションを取得します。

   // Get the solution created in the previous example from the classification solution store
   var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_my_solution_definition');

   • ClassificationSolutionStore - get()
   • ClusteringSolutionStore – get()
   • EncoderStore - get()
   • PredictabilityEstimateStore - get()
   • RegressionSolutionStore - get()
   • SimilaritySolutionStore - get()
2. getLatestVersion() ソリューションメソッドを使用して最新のソリューションバージョンにアクセスし、getStatus() バージョンメソッドを使用してトレーニングステータスを取得します。

   // Access the latest version of the solution and print its training status
   gs.print(JSON.stringify(JSON.parse(mlSolution.getLatestVersion().getStatus(), null, 2)));

   トレーニング完了時の出力:

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

   getLatestVersion()	getStatus()
   ClassificationSolution - getLatestVersion()	ClassificationSolutionVersion - getStatus()
   ClusteringSolution – getLatestVersion()	ClusteringSolutionVersion – getStatus()
   Encoder - getLatestVersion()	EncoderVersion - getStatus()
   PredictabilityEstimate - getLatestVersion()	PredictabilityEstimateVersion - getStatus()
   RegressionSolution - getLatestVersion()	RegressionSolutionVersion - getStatus()
   SimilaritySolution - getLatestVersion()	SimilaritySolutionVersion - getStatus()

ソリューションバージョンを使用して予測を取得する

ソリューションがトレーニングされたら、トレーニング済みバージョンを取得し、それに対して予測を実行します。作成したソリューションをストアから入手します。次に、トレーニング済みバージョンを選択し、トレーニング済みバージョンを予測します。

注:

エンコーダーと予測可能性推定では予測を行うことができません。

1. get() メソッドを使用して、分類ソリューションストアからソリューションを取得します。

   // Get the solution created in the first example from the classification solution store
   var mlSolution = sn_ml.ClassificationSolutionStore.get('ml_x_snc_global_global_my_solution_definition');

2. GlideRecord API の get() メソッドを使用して、インシデント [incident] テーブルからレコードを提供します。

   // single GlideRecord input
   var input = new GlideRecord("incident");
   input.get("<sys_id>");

3. オプション。上位 3 つの結果を返し、すべての結果を返すように ClassificationSolutionVersion – predict() メソッド options パラメーターを設定します。

   // configure optional parameters
   var options = {};
   options.top_n = 3;
   options.apply_threshold = false;

4. results という変数を宣言し、予測ジョブに割り当てます。予測ジョブを実行するには、 ClassificationSolution – getLatestVersion() メソッドを使用して最新のソリューションバージョンを取得し、そのメソッドに対して ClassificationSolutionVersion – predict() メソッドを呼び出します。

   var results = mlSolution.getLatestVersion().predict(input, options);

   • ClassificationSolutionVersion - predict()
   • ClusteringSolutionVersion – predict()
   • RegressionSolutionVersion - predict()
   • SimilaritySolutionVersion - predict()
5. 予測結果の出力を印刷します。

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

   予測結果の出力例:

   *** Script: {
     "<sys_id>": [
       {
         "confidence": 99,
         "threshold": 24.75,
         "predictedValue": "Email",
         "predictedSysId": ""
       },
       {
         "confidence": 5.88210244009169,
         "threshold": 100,
         "predictedValue": "Email (I/f)",
         "predictedSysId": ""
       },
       {
         "confidence": 2.3461203499840932,
         "threshold": 14.81,
         "predictedValue": "Authentication",
         "predictedSysId": ""
       }
     ]
   }