설명서 Experience Platform Data Science Workspace 안내서

모델 엔드포인트

Last update: Wed Feb 28 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
Data Science Workspace

작성 대상:

Developer

모델은 비즈니스 사용 사례를 해결하기 위해 내역 데이터 및 구성을 사용하여 교육되는 머신 러닝 레시피의 인스턴스입니다.

모델 목록 검색

/models에 대한 단일 GET 요청을 수행하여 모든 Models에 속한 Model 세부 사항 목록을 검색할 수 있습니다. 기본적으로 이 목록은 가장 오래 전에 생성된 모델에서 순서를 지정하며 결과를 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

에 POST 요청을 하여 미리 생성된 모델을 등록할 수 있습니다. /models 엔드포인트. 모델을 등록하려면 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} 및 a 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

를 사용하여 GET 요청을 수행함으로써 모델에서 수행된 전환 목록을 검색할 수 있습니다. {MODEL_ID}.

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).

{
    "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

로 GET 요청을 수행하여 특정 코드 변환 모델을 검색할 수 있습니다. {MODEL_ID} 및 코드 변환된 모델의 id입니다.

API 형식

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

매개변수

설명

{MODEL_ID}

교육되었거나 게시된 모델의 고유 식별자입니다.

{TRANSCODING_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