모델 개발 및 훈련은 실험 수준에서 발생하며, 실험은 인스턴스, 교육 실행 및 채점 실행으로 구성됩니다.
요청 페이로드에 이름과 유효한 MLInstance ID를 제공하면서 POST 요청을 수행하여 실험을 만들 수 있습니다.
UI의 모델 교육과는 달리, 명시적 API 호출을 통해 실험을 생성해도 교육 실행이 자동으로 생성 및 실행되지 않습니다.
API 형식
POST /experiments
요청
curl -X POST \
https://platform.adobe.io/data/sensei/experiments \
-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: application/vnd.adobe.platform.sensei+json;profile=experiment.v1.json' \
-d '{
"name": "a name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda"
}'
속성 | 설명 |
---|---|
name |
실험에 대해 원하는 이름입니다. 이 실험에 해당하는 교육 실행은 교육 실행 이름으로 UI에 표시될 이 값을 상속합니다. |
mlInstanceId |
유효한 MLInstance ID입니다. |
응답
성공적인 응답은 고유 식별자( )를 포함하여 새로 생성된 실험의 세부 사항이 포함된 페이로드를 반환합니다id
).
{
"id": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
}
POST 요청을 수행하고 유효한 실험 ID를 제공하고 실행 작업을 지정하여 교육 또는 채점 실행을 생성할 수 있습니다. 실험에 기존의 성공적인 교육 실행이 있는 경우에만 채점 실행을 생성할 수 있습니다. 교육 실행을 성공적으로 생성하면 모델 교육 절차가 초기화되고 성공적으로 완료되면 교육된 모델이 생성됩니다. 훈련된 모델을 생성하면 실험이 지정된 시간에 하나의 훈련된 모델만 활용할 수 있도록 이전의 모든 모델을 대체합니다.
API 형식
POST /experiments/{EXPERIMENT_ID}/runs
매개변수 | 설명 |
---|---|
{EXPERIMENT_ID} |
유효한 실험 ID. |
요청
curl -X POST \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b/runs \
-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: application/vnd.adobe.platform.sensei+json;profile=experimentRun.v1.json' \
-d '{
"mode": "{TASK}"
}'
속성 | 설명 |
---|---|
{TASK} |
실행의 작업을 지정합니다. 이 값을 다음 중 하나로 설정합니다. train 교육용, score 점수 지정 또는 featurePipeline 기능 파이프라인용. |
응답
성공한 응답은 상속된 기본 교육 또는 채점 매개 변수를 포함하여 새로 생성된 실행의 세부 사항과 실행의 고유 ID( )가 포함된 페이로드를 반환합니다{RUN_ID}
).
{
"id": "33408593-2871-4198-a812-6d1b7d939cda",
"mode": "{TASK}",
"experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-01T00:00:00.000Z",
"createdBySchedule": false,
"tasks": [
{
"name": "{TASK}",
"parameters": [
{
"key": "parameter",
"value": "parameter value"
}
]
}
]
}
단일 GET 요청을 수행하고 유효한 MLInstance ID를 쿼리 매개 변수로 제공하여 특정 MLInstance에 속하는 실험 목록을 검색할 수 있습니다. 사용 가능한 쿼리 목록은 의 부록 섹션을 참조하십시오. 자산 검색을 위한 쿼리 매개 변수.
API 형식
GET /experiments
GET /experiments?property=mlInstanceId=={MLINSTANCE_ID}
매개변수 | 설명 |
---|---|
{MLINSTANCE_ID} |
해당 특정 MLInstance에 속하는 실험 목록을 검색하려면 올바른 MLInstance ID를 제공하십시오. |
요청
curl -X GET \
https://platform.adobe.io/data/sensei/experiments?property=mlInstanceId==46986c8f-7739-4376-8509-0178bdf32cda \
-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}'
응답
성공적인 응답은 동일한 MLInstance ID( )를 공유하는 실험 목록을 반환합니다.{MLINSTANCE_ID}
).
{
"children": [
{
"id": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
},
{
"id": "6cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "Training Run 1",
"mlInstanceId": "46986c8f-7839-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
},
{
"id": "7cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "Training Run 2",
"mlInstanceId": "46986c8f-7939-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
}
],
"_page": {
"property": "deleted==false",
"count": 3
}
}
요청 경로에 원하는 실험의 ID를 포함하는 GET 요청을 수행하여 특정 실험의 세부 정보를 검색할 수 있습니다.
API 형식
GET /experiments/{EXPERIMENT_ID}
매개변수 | 설명 |
---|---|
{EXPERIMENT_ID} |
유효한 실험 ID. |
요청
curl -X GET \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b \
-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": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-01T00:00:00.000Z",
"createdByService": false
}
단일 GET 요청을 수행하고 유효한 실험 ID를 제공하여 특정 실험에 속하는 교육 또는 채점 실행 목록을 검색할 수 있습니다. 결과를 필터링하기 위해 요청 경로에 쿼리 매개 변수를 지정할 수 있습니다. 사용 가능한 쿼리 매개 변수의 전체 목록에 대해서는 의 부록 섹션을 참조하십시오. 자산 검색을 위한 쿼리 매개 변수.
여러 쿼리 매개 변수를 결합할 때는 앰퍼샌드(&)로 구분해야 합니다.
API 형식
GET /experiments/{EXPERIMENT_ID}/runs
GET /experiments/{EXPERIMENT_ID}/runs?{QUERY_PARAMETER}={VALUE}
GET /experiments/{EXPERIMENT_ID}/runs?{QUERY_PARAMETER_1}={VALUE_1}&{QUERY_PARAMETER_2}={VALUE_2}
매개변수 | 설명 |
---|---|
{EXPERIMENT_ID} |
유효한 실험 ID. |
{QUERY_PARAMETER} |
다음 중 하나 사용 가능한 쿼리 매개 변수 결과를 필터링하는 데 사용됩니다. |
{VALUE} |
이전 쿼리 매개 변수의 값입니다. |
요청
다음 요청은 쿼리를 포함하며 일부 실험에 속하는 교육 실행 목록을 검색합니다.
curl -X GET \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b/runs?property=mode==train \
-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( )를 포함한 실행 목록과 각 세부 사항을 포함하는 페이로드를 반환합니다{RUN_ID}
).
{
"children": [
{
"id": "33408593-2871-4198-a812-6d1b7d939cda",
"mode": "train",
"experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"createdBySchedule": false
}
],
"_page": {
"property": "mode==train,experimentId==5cb25a2d-2cbd-4c99-a619-8ddae5250a7b,deleted==false",
"totalCount": 1,
"count": 1
}
}
요청 경로에 대상 실험의 ID를 포함하는 PUT 요청을 통해 속성을 덮어쓰고 업데이트된 속성이 포함된 JSON 페이로드를 제공하여 기존 실험을 업데이트할 수 있습니다.
이 PUT GET 요청의 성공을 보장하려면 먼저 다음 작업을 수행하는 것이 좋습니다. ID로 실험 검색. 그런 다음 반환된 JSON 개체를 수정 및 업데이트하고 수정된 JSON 개체 전체를 PUT 요청에 대한 페이로드로 적용합니다.
다음 샘플 API 호출은 이러한 속성을 처음 사용하는 동안 실험의 이름을 업데이트합니다.
{
"name": "A name for this Experiment",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"createdByService": false
}
API 형식
PUT /experiments/{EXPERIMENT_ID}
매개변수 | 설명 |
---|---|
{EXPERIMENT_ID} |
유효한 실험 ID. |
요청
curl -X PUT \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b \
-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: application/vnd.adobe.platform.sensei+json;profile=experiments.v1.json' \
-d '{
"name": "An upated name",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"createdByService": false
}'
응답
성공적인 응답은 실험의 업데이트된 세부 사항이 포함된 페이로드를 반환합니다.
{
"id": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
"name": "An updated name",
"mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
"created": "2019-01-01T00:00:00.000Z",
"createdBy": {
"userId": "Jane_Doe@AdobeID"
},
"updated": "2019-01-02T00:00:00.000Z",
"createdByService": false
}
요청 경로에 대상 실험의 ID를 포함하는 DELETE 요청을 수행하여 단일 실험을 삭제할 수 있습니다.
API 형식
DELETE /experiments/{EXPERIMENT_ID}
매개변수 | 설명 |
---|---|
{EXPERIMENT_ID} |
유효한 실험 ID. |
요청
curl -X DELETE \
https://platform.adobe.io/data/sensei/experiments/5cb25a2d-2cbd-4c99-a619-8ddae5250a7b \
-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}'
응답
{
"title": "Success",
"status": 200,
"detail": "Experiment successfully deleted"
}
MLInstance ID를 쿼리 매개 변수로 포함하는 DELETE 요청을 수행하여 특정 MLInstance에 속하는 모든 실험을 삭제할 수 있습니다.
API 형식
DELETE /experiments?mlInstanceId={MLINSTANCE_ID}
매개변수 | 설명 |
---|---|
{MLINSTANCE_ID} |
유효한 MLInstance ID입니다. |
요청
curl -X DELETE \
https://platform.adobe.io/data/sensei/experiments?mlInstanceId=46986c8f-7739-4376-8509-0178bdf32cda \
-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}'
응답
{
"title": "Success",
"status": 200,
"detail": "Experiments successfully deleted"
}