DocumentazioneExperience PlatformGuida di Data Science Workspace

Insights endpoint

Last update: Mon Aug 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Sviluppatore
NOTE
Data Science Area di lavoro non è più disponibile per l'acquisto.
Questa documentazione è destinata ai clienti esistenti che dispongono di diritti precedenti su Data Science Workspace.

Gli insights contengono metriche utilizzate per consentire a un data scientist di valutare e scegliere modelli ML ottimali visualizzando metriche di valutazione rilevanti.

Recuperare un elenco di approfondimenti

Per recuperare un elenco di approfondimenti, esegui una singola richiesta di GET all’endpoint "insights". Per filtrare i risultati, puoi specificare i parametri di query nel percorso della richiesta. Per un elenco delle query disponibili, consulta la sezione dell'appendice sui parametri di query per il recupero delle risorse.

Formato API

GET /insights

Richiesta

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}'

Risposta

Una risposta corretta restituisce un payload che include un elenco di informazioni dettagliate e ogni informazione approfondita ha un identificatore univoco ( id ). Inoltre, riceverai context che contiene gli identificatori univoci associati a quel particolare informazione approfondita seguenti con i dati di eventi e metriche 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
    }
}
Proprietà
Descrizione
id
L’ID corrispondente a Insight.
experimentId
Un ID esperimento valido.
experimentRunId
Un ID di esecuzione esperimento valido.
modelId
Un ID modello valido.

Recuperare un approfondimento specifico

Per cercare un particolare approfondimento, effettua una richiesta di GET e fornisci un {INSIGHT_ID} valido nel percorso della richiesta. Per filtrare i risultati, è possibile specificare parametri di query nel percorso richiesta. Per un elenco delle query disponibili, consulta la sezione dell'appendice sui parametri di query per il recupero delle risorse.

Formato API

GET /insights/{INSIGHT_ID}
Parametro
Descrizione
{INSIGHT_ID}
Identificatore univoco di un approfondimento di Sensei.

Richiesta

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}'

Risposta

In caso di esito positivo, la risposta restituisce un payload che include l'identificatore univoco di insights (id). Inoltre, riceverai context, che contiene gli identificatori univoci associati alle informazioni specifiche seguenti con i dati degli eventi e delle metriche di 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"
}
Proprietà
Descrizione
id
ID corrispondente al Insight.
experimentId
Un ID esperimento valido.
experimentRunId
Un ID di esecuzione dell'esperimento valido.
modelId
Un ID modello valido.

Aggiungi un nuovo modello informazione approfondita

Per creare una nuova informazione sul modello, devi eseguire una richiesta POST e un payload che fornisca contesto, eventi e metriche per la nuova informazione sul modello. Il campo di contesto utilizzato per creare una nuova informazione sul modello non richiede che siano associati servizi esistenti, ma puoi scegliere di creare la nuova informazione sul modello con servizi esistenti fornendo uno o più degli ID corrispondenti:

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

Formato API

POST /insights

Richiesta

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

Risposta

In caso di esito positivo, la risposta restituirà un payload con {INSIGHT_ID} e tutti i parametri forniti nella richiesta iniziale.

{
    "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"
}
Proprietà
Descrizione
insightId
ID univoco creato per questo particolare informazione approfondita quando viene effettuata una richiesta POST corretta.

Recuperare un elenco di metriche predefinite per gli algoritmi

È possibile recuperare un elenco di tutte le metriche predefinite e dell'algoritmo eseguendo una singola richiesta GET all'endpoint della metrica. Per eseguire una query su una particolare metrica, effettuare un richiesta GET e fornire un valore valido {ALGORITHM} nel percorso richiesta.

Formato API

GET /insights/metrics
GET /insights/metrics?algorithm={ALGORITHM}
Parametro
Descrizione
{ALGORITHM}
Identificatore del tipo di algoritmo.

Richiesta

La richiesta seguente contiene una query e recupera una metrica specifica utilizzando l'identificatore dell'algoritmo {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}'

Risposta

In caso di esito positivo, la risposta restituisce un payload che include l'identificatore univoco algorithm e un array di metriche predefinite.

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