설명서Experience PlatformData Science Workspace 안내서

Insights 끝점

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

작성 대상:

  • Developer

인사이트에는 관련 평가 지표를 표시하여 데이터 과학자가 최적의 ML 모델을 평가하고 선택할 수 있도록 하는 데 사용되는 지표가 포함되어 있습니다.

인사이트 목록 검색

Insights 끝점에 대한 단일 GET 요청을 수행하여 Insights 목록을 검색할 수 있습니다. 결과를 필터링하기 위해 요청 경로에 쿼리 매개 변수를 지정할 수 있습니다. 사용 가능한 쿼리 목록은 의 부록 섹션을 참조하십시오. 자산 검색을 위한 쿼리 매개 변수.

API 형식

GET /insights

요청

curl -X GET \
  https://platform.adobe.io/data/sensei/insights \
    -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 ). 또한 다음을 받게 됩니다. context Insights 이벤트 및 지표 데이터와 연결된 특정 인사이트와 연결된 고유한 식별자가 들어 있습니다.

{
    "children": [
        {
            "id": "08b8d174-6b0d-4d7e-acd8-1c4c908e14b2",
            "context": {
                "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
                "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
                "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71"
            },
            "events": {
                "name": "fit",
                "eventValues": {
                    "algorithm": null,
                    "ratio": "0.8"
                }
            },
            "metrics": [
                {
                    "name": "MAPE",
                    "value": "0.0111111111111",
                    "valueType": "double"
                }
            ],
            "created": "2019-01-01T00:00:00.000Z",
            "updated": "2019-01-02T00:00:00.000Z"
        },
        {
            "id": "08b8d174-6b0d-4d7e-acd8-1c4c908e14b2",
            "context": {
                "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
                "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
                "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71"
            },
            "events": {
                "name": "fit",
                "eventValues": {
                    "algorithm": null,
                    "ratio": "0.8"
                }
            },
            "metrics": [
                {
                    "name": "MAPE",
                    "value": "0.0111111111111",
                    "valueType": "double"
                }
            ],
            "created": "2019-01-01T00:00:00.000Z",
            "updated": "2019-01-02T00:00:00.000Z"
            }
        ],
    "_page": {
        "count": 2
    }
}
속성
설명
id
인사이트에 해당하는 ID입니다.
experimentId
유효한 실험 ID.
experimentRunId
유효한 실험 실행 ID.
modelId
유효한 모델 ID입니다.

특정 인사이트 검색

특정 인사이트를 조회하려면 GET 요청을 하고 유효한 정보를 제공하십시오 {INSIGHT_ID} 요청 경로에서. 결과를 필터링하기 위해 요청 경로에 쿼리 매개 변수를 지정할 수 있습니다. 사용 가능한 쿼리 목록은 의 부록 섹션을 참조하십시오. 자산 검색을 위한 쿼리 매개 변수.

API 형식

GET /insights/{INSIGHT_ID}
매개변수
설명
{INSIGHT_ID}
Sensei 인사이트에 대한 고유 식별자입니다.

요청

curl -X GET \
  https://platform.adobe.io/data/sensei/insights/08b8d174-6b0d-4d7e-acd8-1c4c908e14b2 \
    -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). 추가로 다음을 받게 됩니다. context Insights 이벤트 및 지표 데이터와 연결된 특정 인사이트에 연결된 고유한 식별자가 들어 있습니다.

{
    "id": "08b8d174-6b0d-4d7e-acd8-1c4c908e14b2",
    "context": {
        "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
        "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
        "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71"
    },
    "events": {
        "name": "fit",
        "eventValues": {
            "algorithm": null,
            "ratio": "0.8"
        }
    },
    "metrics": [
        {
            "name": "MAPE",
            "value": "0.0111111111111",
            "valueType": "double"
        }
    ],
    "created": "2019-01-01T00:00:00.000Z",
    "updated": "2019-01-02T00:00:00.000Z"
}
속성
설명
id
인사이트에 해당하는 ID입니다.
experimentId
유효한 실험 ID.
experimentRunId
유효한 실험 실행 ID.
modelId
유효한 모델 ID입니다.

새 모델 인사이트 추가

새 모델 인사이트에 대한 컨텍스트, 이벤트 및 지표를 제공하는 페이로드와 POST 요청을 수행하여 새 모델 인사이트를 만들 수 있습니다. 새 모델 인사이트를 만드는 데 사용되는 컨텍스트 필드에는 기존 서비스가 첨부되어 있지 않아도 되지만, 해당하는 ID 중 하나 이상을 제공하여 기존 서비스와 함께 새 모델 인사이트를 만들도록 선택할 수 있습니다.

"context": {
    "clientId": "f1ab3164-e688-433d-99ef-077b2be84731",
    "notebookId": "T4ab3164-e658-443d-97ef-022b2be84999",
    "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
    "engineId": "22f4166f-85ba-4130-a995-a2b8e1edde32",
    "mlInstanceId": "46986c8f-7739-4376-8509-0178bdf32cda",
    "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
    "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71",
    "dataSetId": "5ee3cd7f2d34011913c56941"
  }

API 형식

POST /insights

요청

curl -X POST \
  https://platform.adobe.io/data/sensei/insights \
    -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=mlInstance.v1.json`
    -d {
    "context": {
        "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
        "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
        "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71"
    },
    "events": {
        "name": "fit2",
        "eventValues": {
            "algorithm": null,
            "ratio": "0.99"
        }
    },
    "metrics": [
        {
            "name": "MAPE2",
            "value": "0.11111111111",
            "valueType": "double"
        }
    ],
    "created": "2019-01-01T00:00:00.000Z",
    "updated": "2019-01-02T00:00:00.000Z"
}

응답

성공적인 응답은 다음과 같은 페이로드를 반환합니다. {INSIGHT_ID} 및 초기 요청에 제공한 모든 매개 변수입니다.

{
    "id": "08b8d174-6b0d-4d7e-acd8-1c4c908e14b2",
    "context": {
        "experimentId": "5cb25a2d-2cbd-4c99-a619-8ddae5250a7b",
        "experimentRunId": "33408593-2871-4198-a812-6d1b7d939cda",
        "modelId": "15c53796-bd6b-4e09-b51d-7296aa20af71"
    },
    "events": {
        "name": "fit2",
        "eventValues": {
            "algorithm": null,
            "ratio": "0.99"
        }
    },
    "metrics": [
        {
            "name": "MAPE2",
            "value": "0.11111111111",
            "valueType": "double"
        }
    ],
    "created": "2019-01-01T00:00:00.000Z",
    "updated": "2019-01-02T00:00:00.000Z"
}
속성
설명
insightId
성공적인 POST 요청이 수행된 경우 이 특정 인사이트에 대해 생성된 고유 ID입니다.

알고리즘에 대한 기본 지표 목록 검색

지표 끝점에 대한 단일 GET 요청을 수행하여 모든 알고리즘 및 기본 지표 목록을 검색할 수 있습니다. 특정 지표를 쿼리하려면 GET 요청을 하고 유효한 를 제공합니다 {ALGORITHM} 요청 경로에서.

API 형식

GET /insights/metrics
GET /insights/metrics?algorithm={ALGORITHM}
매개변수
설명
{ALGORITHM}
알고리즘 유형의 식별자.

요청

다음 요청은 쿼리를 포함하고 알고리즘 식별자를 사용하여 특정 지표를 검색합니다 {ALGORITHM}

curl -X GET \
  'https://platform.adobe.io/data/sensei/insights/metrics?algorithm={ALGORITHM}' \
    -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}'

응답

성공적인 응답은 다음을 포함하는 페이로드를 반환합니다. algorithm 고유 식별자 및 기본 지표 배열.

{
    "children": [
        {
            "algorithm": "15c53796-bd6b-4e09-b51d-7296aa20af71",
            "defaultMetrics": [
                "f-score",
                "auroc",
                "roc",
                "precision",
                "recall",
                "accuracy",
                "confusion matrix"
            ]
        }
    ]
}
recommendation-more-help
cc79fe26-64da-411e-a6b9-5b650f53e4e9