DokumentationExperience PlatformHandbuch zum Datenwissenschafts-Arbeitsbereich

Modelle-Endpunkt

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

Erstellt für:

  • Entwickler
NOTE
Data Science Workspace ist nicht mehr erhältlich.
Diese Dokumentation richtet sich an Bestandskunden mit vorherigen Berechtigungen für Data Science Workspace.

Ein Modell ist eine Instanz eines Rezepts für maschinelles Lernen, das mithilfe von historischen Daten und Konfigurationen dazu trainiert wird, eine geschäftliche Fragestellung zu lösen.

Abrufen einer Liste von Modellen

Sie können eine Liste mit Details zu den verfügbaren Modellen mittels GET-Anfrage an „/models“ abrufen. Standardmäßig wird diese Liste beginnend beim ältesten erstellten Modell sortiert und ist auf 25 Ergebnisse beschränkt. Sie können die Ergebnisse durch Angabe von Abfrageparametern filtern. Eine Liste der verfügbaren Abfragen finden Sie im Anhang zu den Abfrageparametern für den Asset-Abruf.

API-Format

GET /models

Anfrage

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

Antwort

Bei erfolgreicher Antwort wird eine Payload mit Details zu Ihren Modellen einschließlich der eindeutigen Kennung (id) jedes einzelnen Modells zurückgegeben.

{
    "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
    }
}
Eigenschaft
Beschreibung
id
Die dem Modell zugehörige ID.
modelArtifactUri
Ein URI, der angibt, wo das Modell gespeichert ist. Der URI endet mit dem Wert für name des Modells.
experimentId
Eine gültige Experiment-ID.
experimentRunId
Eine gültige Experimentablauf-ID.

Abrufen eines einzelnen Modells

Sie können eine Liste mit Details zu einem einzelnen Modell Modelldetails abrufen, indem Sie eine GET-Anfrage unter Angabe einer gültigen Modell-ID im Anfragepfad ausführen. Sie können die Ergebnisse filtern, indem Sie im Anfragepfad Abfrageparameter angeben. Eine Liste der verfügbaren Abfragen finden Sie im Anhang zu den Abfrageparametern für den Asset-Abruf.

API-Format

GET /models/{MODEL_ID}
GET /models/?property=experimentRunID=={EXPERIMENT_RUN_ID}
Parameter
Beschreibung
{MODEL_ID}
Die Kennung des trainierten oder veröffentlichten Modells.
{EXPERIMENT_RUN_ID}
Die Kennung des Experiment-Laufs.

Anfrage

Die nachfolgende Anfrage enthält eine Abfrage und ruft eine Liste trainierter Modelle ab, die dieselbe experimentRunID ({EXPERIMENT_RUN_ID}) verwenden.

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

Antwort

Bei erfolgreicher Antwort wird eine Payload mit Details zu Ihrem Modell einschließlich der eindeutigen Kennung (id) des Modells zurückgegeben.

{
    "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
    }
}
Eigenschaft
Beschreibung
id
Die dem Modell zugehörige ID.
modelArtifactUri
Ein URI, der angibt, wo das Modell gespeichert ist. Der URI endet mit dem Wert für name des Modells.
experimentId
Eine gültige Experiment-ID.
experimentRunId
Eine gültige Experimentablauf-ID.

Vorgeneriertes Modell registrieren register-a-model

Sie können ein vorgeneriertes Modell registrieren, indem Sie eine POST-Anfrage an den /models -Endpunkt senden. Um Ihr Modell zu registrieren, müssen die Eigenschaftswerte modelArtifact und model im Hauptteil der Anfrage enthalten sein.

API-Format

POST /models

Anfrage

Die folgende POST enthält die erforderlichen Eigenschaftswerte für modelArtifact und model. Weitere Informationen zu diesen Werten finden Sie in der Tabelle unten.

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"
    }'
Parameter
Beschreibung
modelArtifact
Der Speicherort des vollständigen Modellartefakts, das Sie einbeziehen möchten.
model
Die Formulardaten des Modellobjekts, das erstellt werden muss.

Antwort

Bei erfolgreicher Antwort wird eine Payload mit Details zu Ihrem Modell einschließlich der eindeutigen Kennung (id) des Modells zurückgegeben.

{
  "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
}
Eigenschaft
Beschreibung
id
Die dem Modell zugehörige ID.
modelArtifactUri
Ein URI, der angibt, wo das Modell gespeichert ist. Der URI endet mit dem id -Wert für Ihr Modell.

Aktualisieren des Modells nach ID

Sie können ein vorhandenes Modell aktualisieren, indem Sie seine Eigenschaften anhand einer PUT-Anfrage überschreiben, in der Sie die ID des entsprechenden Modells im Anfragepfad sowie eine JSON-Payload mit aktualisierten Eigenschaften angeben.

TIP
Um sicherzustellen, dass diese PUT-Anfrage erfolgreich ausgeführt wird, wird empfohlen, zunächst eine GET-Anfrage zum Abrufen des Modells anhand der Kennung auszuführen. Ändern und aktualisieren Sie dann das zurückgegebene JSON-Objekt und übernehmen Sie die Gesamtheit des geänderten JSON-Objekts als Payload für die PUT-Anfrage.

API-Format

PUT /models/{MODEL_ID}
Parameter
Beschreibung
{MODEL_ID}
Die Kennung des trainierten oder veröffentlichten Modells.

Anfrage

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

Antwort

Bei erfolgreicher Antwort wird eine Payload mit den aktualisierten Details des Experiments zurückgegeben.

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

Löschen des Modells nach ID

Sie können ein einzelnes Modell löschen, indem Sie eine DELETE-Anfrage ausführen, in der Sie die ID des entsprechenden Modells im Anfragepfad angeben.

API-Format

DELETE /models/{MODEL_ID}
Parameter
Beschreibung
{MODEL_ID}
Die Kennung des trainierten oder veröffentlichten Modells.

Anfrage

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

Antwort

Bei erfolgreicher Antwort wird eine Payload mit Status-Code 200 zurückgegeben, der das Löschen des Modells bestätigt.

{
    "title": "Success",
    "status": 200,
    "detail": "Model deletion was successful"
}

Neue Transkodierung für ein Modell erstellen create-transcoded-model

Transcodierung ist die direkte digitale Konvertierung einer Kodierung in eine andere. Sie erstellen eine neue Transkodierung für ein Modell, indem Sie die {MODEL_ID} und die targetFormat angeben, in denen die neue Ausgabe enthalten sein soll.

API-Format

POST /models/{MODEL_ID}/transcodings
Parameter
Beschreibung
{MODEL_ID}
Die Kennung des trainierten oder veröffentlichten Modells.

Anfrage

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

Antwort

Eine erfolgreiche Antwort gibt eine Payload zurück, die ein JSON-Objekt mit den Informationen Ihrer Transkodierung enthält. Dazu gehört die eindeutige Kennung (id) der Transkodierungen, die beim Abrufen eines bestimmten transkodierten Modells verwendet wird 🔗.

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

Liste von Transkodierungen für ein Modell abrufen retrieve-transcoded-model-list

Sie können eine Liste von Transkodierungen abrufen, die für ein Modell durchgeführt wurden, indem Sie eine GET-Anfrage mit Ihrem {MODEL_ID} ausführen.

API-Format

GET /models/{MODEL_ID}/transcodings
Parameter
Beschreibung
{MODEL_ID}
Die Kennung des trainierten oder veröffentlichten Modells.

Anfrage

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

Antwort

Eine erfolgreiche Antwort gibt eine Payload zurück, die ein JSON-Objekt mit einer Liste jeder auf dem Modell durchgeführten Transkodierung enthält. Jedes transkodierte Modell erhält eine eindeutige Kennung (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
    }
}

Abrufen eines bestimmten transkodierten Modells retrieve-transcoded-model

Sie können ein bestimmtes transkodiertes Modell abrufen, indem Sie eine GET-Anfrage mit Ihrem {MODEL_ID} und der ID eines transkodierten Modells ausführen.

API-Format

GET /models/{MODEL_ID}/transcodings/{TRANSCODING_ID}
Parameter
Beschreibung
{MODEL_ID}
Die eindeutige Kennung eines trainierten oder veröffentlichten Modells.
{TRANSCODING_ID}
Die eindeutige Kennung eines transkodierten Modells.

Anfrage

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

Antwort

Eine erfolgreiche Antwort gibt eine Payload zurück, die ein JSON-Objekt mit den Daten des transkodierten Modells enthält.

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