注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。
モデリング目的のAPIを定義する
Foundry内でユーザーやアプリケーションがモデリング目的をどのように使用するかを指定するために、目的のためのAPIを作成することができます。
新しい目的の入力と出力のAPIを定義するには、概要の編集を選択し、APIを追加ボタンを選択します。これにより、以下に示すようなモデリング目的のAPIを定義するページに移動します。
上記の初期目的APIの定義とラベル付けされた左側のパネルでは、モデリング目的のAPIを充実させるために次の方法のいずれかを選択できます（または、右側で入力と出力を手動で定義できます）。
- オブジェクトタイプを選択した場合は、オントロジーに目的APIをマッピングするドキュメントに進んでください。
- すでにこの目的に提出したいモデルがある場合は、モデルを選択して以下の手順に従ってモデルのAPIから始めます。現在、このワークフローはオントロジーをバックアップしたモデルに対してのみサポートされています。
- 既存のFoundryデータセットの列に基づいて目的のAPIに入力や出力を持たせたい場合は、データセットを選択すると、こちらのドキュメントで説明されているように、それらの列に基づいてプロパティを簡単に作成できます。
手動でAPI入力と出力を定義する
APIを手動で定義するには、入力と出力のプロパティを直接指定し、オブジェクトタイプを選択してプロパティをオントロジーにマップします。
「入力の追加」または「出力の追加」ボタンをクリックし、プロパティ名、タイプ、および必要に応じて説明を指定します。タイプは次のいずれかにする必要があります。
booleandatetimedoublelongintegerstring
プロパティのタイプが不明であることが予想される場合は、anyタイプを使用する必要があります。
入力と出力のプロパティを定義した後、次のセクションで説明されているように、オプションでそれらをオブジェクトプロパティにマップすることができます。
APIは、モデリング目的に提出されるモデルの入力と出力の形式を定義します。入力は単一のデータフレームとして与えられ、このデータフレームの列名は、上記の入力セクションに示されている名前と一致する必要があります。同様に、モデリング目的は、出力データフレームの列が出力で指定されたものと一致することを期待します。
目的のAPIをオントロジーにマッピングする
オントロジーのオブジェクトプロパティに各フィールドをマッピング（バインディングとも呼ばれる）することで、目的のAPIの各フィールドに追加のメタデータを提供できます。モデリング目的がオントロジーからのデータを使用する場合や、オントロジーに基づく運用アプリケーションを使用する場合には、プロパティのマッピングが強く推奨されます。
例えば、ワークショップアプリケーションでシナリオを使用するには、目的のAPIがオントロジーにマッピングされている必要があります。これは、シナリオがモデルの実行時に適切な入力データをフェッチするために、これらの入力マッピングを使用し、出力マッピングを使用して上書きするオントロジーのプロパティを決定するからです。
入力プロパティと出力プロパティに対してマッピングが意味することは以下の通りです。
- 入力プロパティの場合、そのプロパティのデータはマッピングされたオブジェクトタイプとプロパティから取得されるべきです。
- 出力プロパティの場合、そのプロパティのモデル出力は、マッピングされたオブジェクトタイプのプロパティと互換性があり、そのプロパティに書き込まれる可能性があります。
オントロジーのマッピングは、運用アプリケーションがモデルの入力をフェッチし、その後モデルの出力でオントロジーのプロパティを上書きするために使用できます。このため、オントロジーのマッピングを追加する場合は、アプリケーションが目的をどのように使用しているかを理解することが非常に重要です。
オブジェクトプロパティにマップするには、左側で「オブジェクトタイプ」を選択するか、右上の「オントロジーにマップ」スイッチを切り替えます。次に、マップする「ルート」オブジェクトタイプを選択します。マッピングで使用できるオブジェクトプロパティは、選択したオブジェクトのプロパティと、多対一の関係で選択したオブジェクトにリンクされているオブジェクトのプロパティです。
オブジェクトタイプを選択すると、そのオブジェクトタイプのすべてのプロパティがマッピング可能になります。プロパティをマップするには、プロパティの隣にあるInまたはOutボタンをクリックします。
プロパティタイプは、プロパティの左側にあるドラッグハンドルを使って、InputsまたはOutputsセクションにドラッグすることもできます。
オブジェクトタイプのすべてのプロパティも、オブジェクトアイコンの左側にあるドラッグハンドルを使って、オブジェクトカード全体をドラッグすることで一度に追加することができます。
リンクされたオブジェクトタイプのプロパティをマップするには、左側のバーの下部までスクロールします。リンクされたオブジェクトが利用可能な場合、リンクされたオブジェクトタイプを追加ボタンが表示されるはずです。そのボタンを選択し、リンクされたオブジェクトタイプを選択します。
リンクされたオブジェクトのプロパティがマッピング可能になります。
デフォルトでは、マッピングされたプロパティは、マッピングされたオブジェクトプロパティタイプと同じ名前、タイプ、説明を持ちます。必要に応じて、名前と説明を変更して目的に合ったものにすることができます。
マッピングが終了したら、Saveボタンを選択して、入力と出力のAPIマッピングを目的に保存します。このAPIは、この目的に提出されるモデルの予想される入力と出力の仕様を文書化することになります。
いつでもSaveを選択すると、目的のAPIプロパティが保存され、メインのモデリング目的ページに戻ります。
データセットの列からプロパティを追加する
左側のドロップダウンからデータセットを選択し、既存のFoundryデータセットから目的のAPIにプロパティを追加し始めます。
データセットの選択ボタンを使用して、ファイルディレクトリを参照し、データセットを探します。
デフォルトのブランチ以外のブランチでデータセットを使用する場合は、ブランチセレクターメニューを使用します。
データセットを選択すると、サイドバーにデータセットのすべての列が表示されます。
InまたはOutボタンを使用して、目的のAPIの入力または出力に列を追加します。プロパティは、列名の左側にあるドラッグハンドルを使ってドラッグインすることもできます。データセットからすべてのプロパティを一度に追加するには、データセット名の左側にあるドラッグハンドルを使って、データセットカード全体をドラッグします。
列の基本プロパティタイプが、モデリング目的のAPIのサポートされるタイプである場合には、それが表示されます。それ以外の場合は、「any」と表示されます。
目的に関連するファイルとして作業中のデータセットを保存するには、目的に関連するファイルとして追加を選択します。いつでも、サイドバーのChangeを選択して別のデータセットを選択することができます。また、オントロジーにマップを選択し、オブジェクトプロパティのマッピングの手順に従ってプロパティをオントロジーにマップすることもできます。
いつでもSaveを選択すると、目的のAPIプロパティが保存され、メインの目的ページに戻ります。
モデルからプロパティを追加する
左側のドロップダウンからモデルを選択し、既存のモデルから目的のAPIにプロパティを追加し始めます。
モデルの選択ボタンを使用して、ファイルディレクトリを参照し、モデルを選択します。
モデルを選択すると、サイドバーにモデルのすべての入力と出力プロパティが表示されます。
InまたはOutボタンを使用して、目的のAPIの入力または出力に列を追加します。プロパティは、列名の左側にあるドラッグハンドルを使ってドラッグインすることもできます。モデルからすべてのプロパティも、モデル名の左側にあるドラッグハンドルを使って、モデルカード全体をドラッグすることで一度に追加することができます。
作業中のモデルを目的に関連するファイルとして保存するには、目的に関連するファイルとして追加を選択します。いつでも、サイドバーのChangeを選択して別のモデルを選択することができます。また、オントロジーにマップを選択し、オブジェクトプロパティのマッピングの手順に従ってプロパティをオントロジーにマップすることもできます。
いつでもSaveをクリックすると、目的のAPIプロパティが保存され、メインの目的ページに戻ります。