Show Menu
トピック×

モデル

モデルは、機械学習手法のインスタンスで、過去のデータと構成を使用してトレーニングを受け、ビジネスの使用事例に対して解決します。

モデルのリストの取得

/modelsに対して1回の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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功した応答は、各モデル固有の識別子( id )を含むモデルの詳細を含むペイロードを返します。
{
    "children": [
        {
            "id": "{MODEL_ID}",
            "name": "A name for this Model",
            "experimentId": "{EXPERIMENT_ID}",
            "experimentRunId": "{EXPERIMENT_RUN_ID}",
            "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": "{MODEL_ID}",
            "name": "Model 2",
            "experimentId": "{EXPERIMENT_ID}",
            "experimentRunId": "{EXPERIMENT_RUN_ID}",
            "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": "{MODEL_ID}",
            "name": "Model 3",
            "experimentId": "{EXPERIMENT_ID}",
            "experimentRunId": "{EXPERIMENT_RUN_ID}",
            "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}
テスト実行の識別子。
リクエスト
次のリクエストにはクエリが含まれ、同じtestRunID ()を共有するトレーニングを受けたモデルのリストが取得されます。
curl -X GET \
  https://platform.adobe.io/data/sensei/models/?property=experimentRunId=={EXPERIMENT_RUN_ID} \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功した応答は、モデル固有の識別子( id )を含むモデルの詳細を含むペイロードを返します。
{
    "children": [
        {
            "id": "{MODEL_ID}",
            "name": "A name for this Model",
            "experimentId": "{EXPERIMENT_ID}",
            "experimentRunId": "{EXPERIMENT_RUN_ID}",
            "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=={EXPERIMENT_RUN_ID},deleted==false",
        "count": 1
    }
}

プロパティ
説明
id
モデルに対応するID。
modelArtifactUri
モデルが保存されている場所を示すURI。 URIの末尾はモデルの name 値です。
experimentId
有効なテストID。
experimentRunId
有効なテスト実行ID。

IDによるモデルの更新

リクエストパスにターゲットモデルのIDを含むPUT要求を介してプロパティを上書きし、更新されたプロパティを含むJSONペイロードを提供することで、既存のモデルを更新できます。
このPUT要求を確実に成功させるために、最初にGET要求を実行して、IDでモデルを取得することをお勧めします。 次に、返されたJSONオブジェクトを変更および更新し、変更されたJSONオブジェクト全体をPUT要求のペイロードとして適用します。
API形式
PUT /models/{MODEL_ID}

パラメーター
説明
{MODEL_ID}
トレーニングを受けたモデルまたはパブリッシュされたモデルの識別子。
リクエスト
curl -X PUT \
  https://platform.adobe.io/data/sensei/models/{MODEL_ID} \
    -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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -d '{
        "id": "{MODEL_ID}",
        "name": "A name for this Model",
        "experimentId": "{EXPERIMENT_ID}",
        "experimentRunId": "{EXPERIMENT_RUN_ID}",
        "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": "{MODEL_ID}",
        "name": "A name for this Model",
        "experimentId": "{EXPERIMENT_ID}",
        "experimentRunId": "{EXPERIMENT_RUN_ID}",
        "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リクエストを実行すると、1つのモデルを削除できます。
API形式
DELETE /models/{MODEL_ID}

パラメーター
説明
{MODEL_ID}
トレーニングを受けたモデルまたはパブリッシュされたモデルの識別子。
リクエスト
curl -X DELETE \
  https://platform.adobe.io/data/sensei/models/{MODEL_ID} \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功した応答は、モデルの削除を確認する200ステータスを含むペイロードを返します。
{
    "title": "Success",
    "status": 200,
    "detail": "Model deletion was successful"
}