プログラムによるモデルまたはAIユースケースの更新

ユースケースやファクトシートを追加情報で更新したいかもしれません。 例えば、一部の企業には、モデル・ユース・ケースまたはモデル・ファクトに付随させる必要がある詳細の標準セットがあります。

現在、データおよび AI Common Core API を使用してアセットを更新するユーザー属性を変更することで、テナント レベルのアセット タイプを更新する必要があります。

カスタム資産タイプの更新

以下の手順を実行して、カスタム資産タイプを更新します：

1. getcatalogtypeメソッドにbss_account_idクエリ パラメータを指定します。

2. model_entry の属性を更新する場合は、 model_entry_user として asset_type を提供します。 モデル・ファクトの属性を更新する場合は、 modelfacts_user として asset_type を提供します。

3. getcatalogtypeメソッドを使用して、現在の資産タイプ定義を取得します。ここで、 asset_typeはmodelfacts_userまたはmodel_entry_userのいずれかです。

4. API 資料で定義されているスキーマに従って、カスタム属性をプロパティー JSON オブジェクトに追加することにより、現在の資産タイプ定義をカスタム属性で更新します。 モデル・ユース・ケースまたはモデルのユーザー・インターフェースから表示および編集するために、以下のタイプの属性がサポートされています。

   • ストリング
   • 日付
   • 整数

5. JSON が新しいプロパティで更新されたら、 replaceassettypeメソッドを使用して変更を開始します。 asset_type 、 bss_account_id、および要求ペイロードを指定します。

更新が完了すると、AI ユース・ケースの詳細ページおよびモデルの詳細ページでカスタム属性を表示できます。

例 1: model_entry_user アセット・タイプの取得と更新

以下の curl コマンドは、資産タイプ model_entry_user を取得します：

curl -X GET --header 'Accept: application/json' --header "Authorization: ZenApiKey ${MY_TOKEN}"  'https://api.dataplatform.cloud.ibm.com:443/v2/asset_types/model_entry_user?bss_account_id=<bss_account_id>'

このスニペットは、モデル・ユース・ケースのユーザー詳細のサンプル応答ペイロードです。

{
    "description": "The model use case to capture user defined attributes.",
    "fields": [],
    "relationships": [],
    "properties": {},
    "decorates": [{
        "asset_type_name": "model_entry"
    }],
    "global_search_searchable": [],
    "localized_metadata_attributes": {
        "name": {
            "default": "Additional details",
            "en": "Additional details"
        }
    },
    "attribute_only": false,
    "name": "model_entry_user",
    "version": 1,
    "scope": "ACCOUNT"
}

以下の curl コマンドは、 model_entry_user アセット・タイプを更新します：

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header "Authorization: ZenApiKey ${MY_TOKEN}"  -d '@requestbody.json' 'https://api.dataplatform.cloud.ibm.com:443/v2/asset_types/model_entry_user?bss_account_id=<bss_account_id>'

requestbody.json の内容は、以下のようになります。

{
    "description": "The model use case to capture user defined attributes.",
    "fields": [],
    "relationships": [],
    "properties": {
        "user_attribute1": {
            "type": "string",
            "description": "User attribute1",
            "placeholder": "User attribute1",
            "is_array": false,
            "required": true,
            "hidden": false,
            "readonly": false,
            "default_value": "None",
            "label": {
                "default": "User attribute1"
            }
        },
        "user_attribute2": {
            "type": "integer",
            "description": "User attribute2",
            "placeholder": "User attribute2",
            "is_array": false,
            "required": true,
            "hidden": false,
            "readonly": false,
            "label": {
                "default": "User attribute2"
            }
        },
        "user_attribute3": {
            "type": "date",
            "description": "User attribute3",
            "placeholder": "User attribute3",
            "is_array": false,
            "required": true,
            "hidden": false,
            "readonly": false,
            "default_value": "None",
            "label": {
                "default": "User attribute3"
            }
        
    }
    "decorates": [{
        "asset_type_name": "model_entry"
    }],
    "global_search_searchable": [],
    "attribute_only": false,
    "localized_metadata_attributes": {
        "name": {
            "default": "Additional details",
            "en": "Additional details"
        }
    }
}

カスタム・ファクトの表示順序の割り当て

カスタム・ファクト定義の作成" メソッドのフィールド 'Orderでは、カスタム・ファクトの表示順を割 り当てることができます。 これにより、ファクトシート上の事実の構成をより自由にコントロールすることができます。

以下の手順に従って、注文をカスタムファクトに割り当てます。

1. カスタム・ファクト定義ファイルを編集し、順序を制御するために割り当てられた整数を持つOrderフィールドを追加します。 例 :
2. このメソッドを使って定義ファイルをロードする：

facts_client.assets.create_custom_facts_definitions("Asset_type_definition.csv", overwrite=True)

Python クライアントを使用したユーザー詳細の更新

Python スクリプトを使用して、資産タイプを更新し、プロパティーで置き換えることもできます。 詳細については、ファクトシートの要素の説明を参照してください。

カスタム属性を使用して資産タイプ定義を更新した後、モデル・ユース・ケースの概要ページおよびモデル詳細ページからそれらの属性の値を指定できます。 これらの Python API クライアント・メソッドを使用するカスタム属性の値を更新することもできます。

• モデル資産ユーティリティー
• モデル入力ユーティリティー

モデルのセル・ファクトのキャプチャー

データ・サイエンティストは、ノートブックでモデルを開発すると、ROC 曲線、コンフュージョン・マトリックス、パンダ・プロファイル・レポート、セル実行の出力など、主要なモデル詳細の視覚化を生成します。 これらのファクトをモデル・ユース・ケースの一部として取り込むには、 AI Factsheets Python クライアント・ライブラリーで ' capture_cell_facts ` 関数を使用します。

カスタム・フィールドのトラブルシューティング

フィールドをカスタマイズしてユーザーが使用できるようにした後に、モデルの詳細の 「追加の詳細」 セクションのフィールドを更新しようとすると、以下のエラーが発生することがあります。

Update failed. To update an asset attribute, you must be a catalog Admin or an asset owner or member with the Editor role. Ask a catalog Admin to update your catalog role or ask an asset member with the Editor role to add you as a member.

ユーザーが既にモデルに対する編集権限を持っていて、それでもエラー・メッセージが表示される場合は、以下の手順に従って解決してください。

1. createassetattributenewv2の API コマンドを呼び出します。

2. 次のコマンドでこのペイロードを使用します。

   
   {
     "name": "modelfacts_system",
     "entity": {
     }
   }
   

   ここで、 asset_id は model_idです。 モデルが存在する project_id 、 space_id 、または catalog_id のいずれかを入力します。

詳細情報

IBM_AIGOV_FACTS_CLIENT ドキュメントを使用して、プログラムでインベントリーを操作する方法について説明します。

親トピック: AI アセットの管理