ドキュメント Experience Platform データサイエンスワークスペースガイド

モデルエンドポイント

最終更新日： 2024年8月5日

トピック：
{"id":"c132d929-fa62-4271-803e-b823be07b914"}

作成対象：

{"id":"ff6a42d2-313e-452e-93a6-792e4fad9ff8"}

NOTE

Data Science Workspaceは購入できなくなりました。

このドキュメントは、Data Science Workspaceの使用権限を以前に持つ既存のお客様向けです。

モデルは、履歴データと構成を使用してビジネス使用例を解決するために訓練される機械学習レシピのインスタンスです。

モデルのリストの取得

/models に対して単一の GET リクエストを実行することにより、すべてのモデルに属するモデル詳細のリストを取得できます。デフォルトでは、このリストは最も古く作成されたモデルから自動的に並べ替えられ、結果は 25 に制限されます。クエリパラメーターを指定して、結果をフィルターできます。使用可能なクエリのリストについては、付録の「アセット取得のためのクエリパラメーター」の節を参照してください。

API 形式

GET /models

リクエスト

curl -X GET \
  https://platform.adobe.io/data/sensei/models/ \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、各モデルの固有な識別子（id）を含むモデルの詳細を含むペイロードを返します。

{
    "children": [
        {
            "id": "15c53796-bd6b-4e09-b51d-7296aa20af71",
            "name": "A name for this Model",
            "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
            "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
            "description": "A description for this Model",
            "modelArtifactUri": "wasb://test-models@mlpreprodstorage.blob.core.windows.net/model-name",
            "created": "2019-01-01T00:00:00.000Z",
            "createdBy": {
                "userId": "Jane_Doe@AdobeID"
            },
            "updated": "2019-01-02T00:00:00.000Z"
       },
        {
            "id": "27c53796-bd6b-4u59-b51d-7296aa20er23",
            "name": "Model 2",
            "experimentId": "3cb25a2d-2cbd-4d34-a619-8ddae5259a5t",
            "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
            "description": "A description for Model2",
            "modelArtifactUri": "wasb://test-models@mlpreprodstorage.blob.core.windows.net/model-name",
            "created": "2019-01-01T00:00:00.000Z",
            "createdBy": {
                "userId": "Jane_Doe@AdobeID"
            },
            "updated": "2019-01-02T00:00:00.000Z"
       },
        {
            "id": "15c53796-bd6b-4e09-b51d-7296aa20af71",
            "name": "Model 3",
            "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
            "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
            "description": "A description for Model3",
            "modelArtifactUri": "wasb://test-models@mlpreprodstorage.blob.core.windows.net/model-name",
            "created": "2019-01-01T00:00:00.000Z",
            "createdBy": {
                "userId": "Jane_Doe@AdobeID"
            },
            "updated": "2019-01-02T00:00:00.000Z"
       },
    ],
    "_page": {
        "property": "deleted==false",
        "count": 3
    }
}

プロパティ

説明

id

モデルに対応する ID。

modelArtifactUri

モデルが保存されている場所を示す URI。 URI はモデルの name 値で終わります。

experimentId

有効な実験 ID。

experimentRunId

有効な実験実行 ID。

特定のモデルの取得

単一の GET リクエストを実行し、リクエストパスに有効なモデル ID を指定することで、特定のモデルに属するモデルの詳細のリストを取得できます。結果のフィルタリングに役立つように、リクエストパスでクエリパラメーターを指定できます。使用可能なクエリのリストについては、「アセット取得のためのクエリーパラメーター」の付録の節を参照してください。

API 形式

GET /models/{MODEL_ID}
GET /models/?property=experimentRunID=={EXPERIMENT_RUN_ID}

パラメーター

説明

{MODEL_ID}

訓練済みまたは公開済みモデルの識別子。

{EXPERIMENT_RUN_ID}

実験実行の識別子。

リクエスト

次のリクエストにはクエリが含まれており、同じexperimentRunID （{EXPERIMENT_RUN_ID}）を共有するトレーニング済みモデルのリストを取得します。

curl -X GET \
  https://platform.adobe.io/data/sensei/models/?property=experimentRunId==33408593-2871-4198-a812-6d1b7d939cda \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、モデル固有の識別子（id）を含むモデルの詳細を含むペイロードを返します。

{
    "children": [
        {
            "id": "15c53796-bd6b-4e09-b51d-7296aa20af71",
            "name": "A name for this Model",
            "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
            "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
            "description": "A description for this Model",
            "modelArtifactUri": "wasb://test-models@mlpreprodstorage.blob.core.windows.net/model-name",
            "created": "2019-01-01T00:00:00.000Z",
            "createdBy": {
                "userId": "Jane_Doe@AdobeID"
            },
            "updated": "2019-01-02T00:00:00.000Z"
       }
    ],
    "_page": {
        "property": "experimentRunId==33408593-2871-4198-a812-6d1b7d939cda,deleted==false",
        "count": 1
    }
}

プロパティ

説明

id

モデルに対応する ID。

modelArtifactUri

モデルが保存されている場所を示す URI。 URI はモデルの name 値で終わります。

experimentId

有効な実験 ID。

experimentRunId

有効な実験実行 ID。

事前生成モデルの登録 register-a-model

/models エンドポイントにPOST リクエストを行うことで、事前生成されたモデルを登録できます。モデルを登録するには、modelArtifact ファイルとmodel プロパティ値をリクエストの本文に含める必要があります。

API 形式

POST /models

リクエスト

次のPOSTには、必要なmodelArtifact ファイルとmodel プロパティ値が含まれています。これらの値について詳しくは、以下の表を参照してください。

curl -X POST \
  https://platform.adobe.io/data/sensei/models \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -F 'modelArtifact=@/Users/yourname/Desktop/model.onnx' \
    -F 'model={
            "name": "Your Model - 0615-1342-45",
            "originType": "offline"
    }'

パラメーター

説明

modelArtifact

含める完全なモデルアーティファクトの場所。

model

作成する必要があるモデルオブジェクトのフォームデータ。

応答

正常な応答は、モデル固有の識別子（id）を含むモデルの詳細を含むペイロードを返します。

{
  "id": "a28f151a-597a-4a7e-87e9-1c1dbc9c2af7",
  "name": "Your Model - 0615-1342-45",
  "originType": "offline",
  "modelArtifactUri": "http://storageblobml.blob.core.windows.net/prod-models/a28f151a-597a-4a7e-87e9-1c1dbc9c2af7",
  "created": "2020-06-15T20:55:41.520Z",
  "updated": "2020-06-15T20:55:41.520Z",
  "deprecated": false
}

プロパティ

説明

id

モデルに対応する ID。

modelArtifactUri

モデルが保存されている場所を示す URI。 URIは、モデルのid値で終わります。

ID によるモデルの更新

既存のモデルを更新するには、リクエストパスにターゲットモデルの ID を含む PUT リクエストを使用してプロパティを上書きし、更新されたプロパティを含む JSON ペイロードを提供します。

TIP

このPUT リクエストの成功を確実にするために、最初にGET リクエストを実行してIDでモデルを取得することをお勧めします。次に、返された JSON オブジェクトを変更および更新し、変更された JSON オブジェクト全体を PUT リクエストのペイロードとして指定します。

API 形式

PUT /models/{MODEL_ID}

パラメーター

説明

{MODEL_ID}

訓練済みまたは公開済みモデルの識別子。

リクエスト

curl -X PUT \
  https://platform.adobe.io/data/sensei/models/15c53796-bd6b-4e09-b51d-7296aa20af71 \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'Content-Type: application/vnd.adobe.platform.sensei+json;profile=mlInstance.v1.json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -d '{
        "id": "15c53796-bd6b-4e09-b51d-7296aa20af71",
        "name": "A name for this Model",
        "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
        "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
        "description": "An updated description for this Model",
        "modelArtifactUri": "wasb://test-models@mlpreprodstorage.blob.core.windows.net/model-name",
        "created": "2019-01-01T00:00:00.000Z",
        "createdBy": {
            "userId": "Jane_Doe@AdobeID"
        },
        "updated": "2019-01-02T00:00:00.000Z"
    }'

応答

正常な応答は、実験の更新された詳細を含むペイロードを返します。

{
        "id": "15c53796-bd6b-4e09-b51d-7296aa20af71",
        "name": "A name for this Model",
        "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
        "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
        "description": "An updated description for this Model",
        "modelArtifactUri": "wasb://test-models@mlpreprodstorage.blob.core.windows.net/model-name",
        "created": "2019-01-01T00:00:00.000Z",
        "createdBy": {
            "userId": "Jane_Doe@AdobeID"
        },
        "updated": "2019-01-02T00:00:00.000Z"
    }

ID によるモデルの削除

リクエストパスにターゲットモデルの ID を含む DELETE リクエストを実行すると、単一のモデルを削除できます。

API 形式

DELETE /models/{MODEL_ID}

パラメーター

説明

{MODEL_ID}

訓練済みまたは公開済みモデルの識別子。

リクエスト

curl -X DELETE \
  https://platform.adobe.io/data/sensei/models/15c53796-bd6b-4e09-b51d-7296aa20af71 \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、モデルの削除を確認する 200 ステータスを含むペイロードを返します。

{
    "title": "Success",
    "status": 200,
    "detail": "Model deletion was successful"
}

モデルの新しいトランスコーディングの作成 create-transcoded-model

トランスコーディングとは、あるエンコーディングから別のエンコーディングへの直接デジタル変換です。モデルの新しいトランスコードを作成するには、新しい出力を入力する{MODEL_ID}とtargetFormatを指定します。

API 形式

POST /models/{MODEL_ID}/transcodings

パラメーター

説明

{MODEL_ID}

訓練済みまたは公開済みモデルの識別子。

リクエスト

curl -X POST \
  https://platform.adobe.io/data/sensei/models/15c53796-bd6b-4e09-b51d-7296aa20af71/transcodings \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: text/plain' \
    -D '{
 "id": "491a3be5-1d32-4541-94d5-cd1cd07affb5",
 "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71",
 "targetFormat": "CoreML",
 "created": "2019-12-16T19:59:08.360Z",
 "createdBy": {
    "userId": "FDD760CD5CD467380A495FE2@AdobeID"
 },
 "updated": "2019-12-19T18:37:43.696Z",
 "deleted": false,
}'

応答

応答が成功すると、トランスコードの情報を含むJSON オブジェクトを含むペイロードが返されます。これには、特定のトランスコードされたモデルの取得に使用されるトランスコード一意の識別子（id）が含まれます。

{
  "id": "491a3be5-1d32-4541-94d5-cd1cd07affb5",
  "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71",
  "targetFormat": "CoreML",
  "created": "2020-06-12T22:01:55.886Z",
  "createdBy": {
    "userId": "FDD760CD5CD467380A495FE2@AdobeID"
  },
  "updated": "2020-06-12T22:01:55.886Z",
  "deleted": false
}

モデルのトランスコードのリストの取得 retrieve-transcoded-model-list

モデルで実行されたトランスコードのリストを取得するには、{MODEL_ID}でGET リクエストを実行します。

API 形式

GET /models/{MODEL_ID}/transcodings

パラメーター

説明

{MODEL_ID}

訓練済みまたは公開済みモデルの識別子。

リクエスト

curl -X GET \
  https://platform.adobe.io/data/sensei/models/15c53796-bd6b-4e09-b51d-7296aa20af71/transcodings \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、モデルで実行された各トランスコーディングのリストを含むjson オブジェクトを含むペイロードが返されます。トランスコードされた各モデルは、一意のID （id）を受け取ります。

{
    "children": [
        {
            "id": "460aa5a1-e972-455d-b8dc-4bc6cd91edb6",
            "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71",
            "created": "2019-12-20T01:07:50.978Z",
            "createdBy": {
                "userId": "FDD760CD5CD467380A495FE2@AdobeID"
            },
            "updated": "2019-12-20T01:07:50.978Z",
            "deprecated": false
        },
        {
            "id": "bdb3e4c2-4702-4045-86b4-17ee40df91cc",
            "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71",
            "created": "2019-12-20T17:48:26.473Z",
            "createdBy": {
                "userId": "FDD760CD5CD467380A495FE2@AdobeID"
            },
            "updated": "2019-12-20T17:48:26.473Z",
            "deprecated": false
        }
    ],
    "_page": {
        "property": "modelId==15c53796-bd6b-4e09-b51d-7296aa20af71,deleted==false,deprecated==false",
        "count": 2
    }
}

特定のトランスコードされたモデルの取得 retrieve-transcoded-model

{MODEL_ID}とトランスコードされたモデルのIDでGET リクエストを実行すると、特定のトランスコードされたモデルを取得できます。

API 形式

GET /models/{MODEL_ID}/transcodings/{TRANSCODING_ID}

パラメーター

説明

{MODEL_ID}

トレーニング済みまたは公開されたモデルの一意のID。

{TRANSCODING_ID}

トランスコードされたモデルの一意のID。

リクエスト

curl -X GET \
  https://platform.adobe.io/data/sensei/models/15c53796-bd6b-4e09-b51d-7296aa20af71/transcodings/460aa5a1-e972-455d-b8dc-4bc6cd91edb6 \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、トランスコードされたモデルのデータを含むJSON オブジェクトを含むペイロードが返されます。

{
    "id": "460aa5a1-e972-455d-b8dc-4bc6cd91edb6",
    "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71",
    "created": "2019-12-20T01:07:50.978Z",
    "createdBy": {
        "userId": "FDD760CD5CD467380A495FE2@AdobeID"
    },
    "updated": "2019-12-20T01:07:50.978Z",
    "deprecated": false
}

recommendation-more-help

experience-platform-help-data-science-workspace