Show Menu
SUJETS×

Expériences

Le développement et la formation de modèles se déroulent au niveau Expérience, où une Expérience se compose d’une instance de la MLI, de sessions de formation et d’exécutions de notation.

Création d’une expérience

Vous pouvez créer une expérience en exécutant une requête POST tout en fournissant un nom et un ID d'instance MLInstance valide dans la charge utile de la requête.
Contrairement à la formation de modèle dans l’interface utilisateur, la création d’une expérience par le biais d’un appel d’API explicite ne crée pas et n’exécute pas automatiquement une session de formation.
Format d’API
POST /experiments

Requête
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: {IMS_ORG}' \
    -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"
    }'

Propriété
Description
name
Nom de l’expérience souhaité. L'exécution de formation correspondant à cette expérience hérite de cette valeur à afficher dans l'interface utilisateur comme nom de l'exécution de formation.
mlInstanceId
ID d'instance MLInstance valide.
Réponse
Une réponse réussie renvoie une charge utile contenant les détails de l'expérience nouvellement créée, y compris son identifiant unique ( 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
}

Créer et exécuter une formation ou une série de notation

Vous pouvez créer des exécutions de formation ou de notation en exécutant une requête POST et en fournissant un ID d’expérience valide et en spécifiant la tâche d’exécution. Les exécutions de score ne peuvent être créées que si l’expérience a une exécution de formation existante et réussie. La création réussie d'un cycle de formation initialise la procédure de formation du modèle et sa réussite génère un modèle formé. La création de modèles formés remplacera ceux qui existaient déjà, de sorte qu'une expérience ne peut utiliser qu'un seul modèle formé à un moment donné.
Format d’API
POST /experiments/{EXPERIMENT_ID}/runs

Paramètre
Description
{EXPERIMENT_ID}
ID d’expérience valide.
Requête
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'content-type: application/vnd.adobe.platform.sensei+json;profile=experimentRun.v1.json' \
    -d '{
        "mode": "{TASK}"
    }'

Propriété
Description
{TASK}
Indique la tâche de l’exécution. Définissez cette valeur comme train pour la formation, score pour la notation ou featurePipeline pour le pipeline de fonctionnalités.
Réponse
Une réponse réussie renvoie une charge utile contenant les détails de l'exécution nouvellement créée, y compris les paramètres de formation ou d'évaluation par défaut hérités et l'identifiant unique de l'exécution ( {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"
                }
            ]
        }
    ]
}

Récupérer une liste d'expériences

Vous pouvez récupérer une liste d'expériences appartenant à une instance MLInstance particulière en exécutant une seule requête GET et en fournissant un ID MLInstance valide en tant que paramètre de requête. Pour une liste des requêtes disponibles, reportez-vous à la section de l'annexe sur les paramètres de requête pour la récupération des ressources.
Format d’API
GET /experiments
GET /experiments?property=mlInstanceId=={MLINSTANCE_ID}

Paramètre
Description
{MLINSTANCE_ID}
Fournissez un ID d'instance de liste de mesure valide pour récupérer une liste d'expériences appartenant à cette instance particulière.
Requête
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
Une réponse réussie renvoie une liste d’expériences partageant le même ID d’instance de la liste ( {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
    }
}

Récupérer une expérience spécifique

Vous pouvez récupérer les détails d’une expérience spécifique en exécutant une requête GET qui inclut l’ID de l’expérience souhaitée dans le chemin de la requête.
Format d’API
GET /experiments/{EXPERIMENT_ID}

Paramètre
Description
{EXPERIMENT_ID}
ID d’expérience valide.
Requête
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
Une réponse réussie renvoie une charge utile contenant les détails de l'expérience demandée.
{
    "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
}

Récupération d’une liste d’exécutions d’expérience

Vous pouvez récupérer une liste d’exécutions de formation ou de notation appartenant à une expérience particulière en exécutant une seule demande GET et en fournissant un ID d’expérience valide. Pour faciliter le filtrage des résultats, vous pouvez spécifier des paramètres de requête dans le chemin d’accès à la requête. Pour une liste complète des paramètres de requête disponibles, voir la section de l'annexe sur les paramètres de requête pour la récupération des ressources.
Lors de la combinaison de plusieurs paramètres de requête, ils doivent être séparés par des esperluettes (&).
Format d’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}

Paramètre
Description
{EXPERIMENT_ID}
ID d’expérience valide.
{QUERY_PARAMETER}
L'un des paramètres de requête disponibles utilisés pour filtrer les résultats.
{VALUE}
Valeur du paramètre de requête précédent.
Requête
La requête suivante contient une requête et récupère une liste d'exécutions de formation appartenant à une expérience.
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
Une réponse réussie renvoie une charge utile contenant une liste d'exécutions et chacun de leurs détails, y compris leur ID d'exécution d'expérience ( {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
    }
}

Mettre à jour une expérience

Vous pouvez mettre à jour une expérience existante en remplaçant ses propriétés par une requête PUT qui inclut l’ID de l’expérience de cible dans le chemin de la requête et fournit une charge utile JSON contenant des propriétés mises à jour.
Afin d’assurer le succès de cette requête PUT, il est conseillé d’effectuer d’abord une requête GET pour récupérer l’expérience par ID . Ensuite, modifiez et mettez à jour l’objet JSON renvoyé et appliquez l’intégralité de l’objet JSON modifié comme charge utile pour la demande PUT.
L’exemple d’appel d’API suivant met à jour le nom d’une expérience alors que ces propriétés étaient au départ les suivantes :
{
    "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
}

Format d’API
PUT /experiments/{EXPERIMENT_ID}

Paramètre
Description
{EXPERIMENT_ID}
ID d’expérience valide.
Requête
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: {IMS_ORG}' \
    -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
    }'

Réponse
Une réponse réussie renvoie une charge utile contenant les détails mis à jour de l’expérience.
{
    "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
}

Suppression d’une expérience

Vous pouvez supprimer une seule expérience en exécutant une requête de DELETE qui inclut l’ID de l’expérience de cible dans le chemin de la requête.
Format d’API
DELETE /experiments/{EXPERIMENT_ID}

Paramètre
Description
{EXPERIMENT_ID}
ID d’expérience valide.
Requête
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
{
    "title": "Success",
    "status": 200,
    "detail": "Experiment successfully deleted"
}

Supprimer des expériences par ID d'instance de liste

Vous pouvez supprimer toutes les expériences appartenant à une instance MLInstance particulière en exécutant une demande de DELETE qui inclut l'ID MLInstance en tant que paramètre de requête.
Format d’API
DELETE /experiments?mlInstanceId={MLINSTANCE_ID}

Paramètre
Description
{MLINSTANCE_ID}
ID d'instance MLInstance valide.
Requête
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
{
    "title": "Success",
    "status": 200,
    "detail": "Experiments successfully deleted"
}