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

モデルエンドポイント

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 開発者

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

モデルのリストの取得

/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
作成する必要がある 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
cc79fe26-64da-411e-a6b9-5b650f53e4e9