Gérer les types d'entités

Pour en savoir plus, exécutez le notebook Jupyter "Example Feature Store workflow with sample data" (exemple de workflow Feature Store avec des exemples de données) dans l'un des environnements suivants :

• Exécutez le notebook dans Colab.
• Exécutez le notebook dans une instance de notebook gérée par l'utilisateur Vertex AI Workbench.
• Affichez le notebook sur GitHub.

Découvrez comment créer, répertorier et supprimer des types d'entités.

Créer un type d'entité

Créez un type d'entité afin de pouvoir créer ses caractéristiques associées.

UI Web

1. Dans la section "Vertex AI" de Google Cloud Console, accédez à la page Caractéristiques.

   Accéder à la page "Caractéristiques"

2. Dans la barre d'action, cliquez sur Créer un type d'entité pour ouvrir le volet Créer un type d'entité.
3. Dans la liste déroulante Région, sélectionnez une région incluant le magasin de caractéristiques dans lequel vous souhaitez créer un type d'entité.
4. Sélectionnez un magasin de caractéristiques.
5. Indiquez le nom du type d'entité.
6. Si vous le souhaitez, vous pouvez saisir la description du type d'entité.
7. Pour activer la surveillance des valeurs de fonctionnalités (Bêta), définissez la surveillance sur Activé, puis spécifiez l'intervalle d'instantanés en jours. Cette configuration de surveillance s'applique à toutes les fonctionnalités de ce type d'entité. Pour plus d'informations, consultez la page Surveillance des valeurs de fonctionnalités.
8. Cliquez sur Create (Créer).

API REST et ligne de commande

Pour créer un type d'entité, envoyez une requête POST à l'aide de la méthode featurestores.entityTypes.create.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

• LOCATION : région où se trouve le featurestore, par exemple us-central1.
• PROJECT: ID de votre projet ou numéro de projet.
• FEATURESTORE_ID : ID du featurestore.
• ENTITY_TYPE_ID : ID du type d'entité.
• DESCRIPTION : description du type d'entité.

Méthode HTTP et URL :

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes?entityTypeId=ENTITY_TYPE_ID

Corps JSON de la requête :

{
  "description": "DESCRIPTION"
}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Remarque : Assurez-vous d'avoir défini la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès au fichier de clé privée de votre compte de service.

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes?entityTypeId=ENTITY_TYPE_ID"

PowerShell

Remarque : Assurez-vous d'avoir défini la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès au fichier de clé privée de votre compte de service.

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method POST `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -InFile request.json `
  -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes?entityTypeId=ENTITY_TYPE_ID" | Select-Object -Expand Content

Des résultats semblables aux lignes suivantes devraient s'afficher : Vous pouvez utiliser OPERATION_ID dans la réponse pour obtenir l'état de l'opération.

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes/bikes/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1.CreateEntityTypeOperationMetadata",
    "genericMetadata": {
      "createTime": "2021-03-02T00:04:13.039166Z",
      "updateTime": "2021-03-02T00:04:13.039166Z"
    }
  }
}

Python

Pour savoir comment installer et utiliser la bibliothèque cliente pour Vertex AI, consultez la page Bibliothèques clientes Vertex AI. Pour en savoir plus, consultez la documentation de référence de l'API Vertex AI en langage Python.

Afficher sur GitHub Commentaires

from google.cloud import aiplatform

def create_entity_type_sample(
    project: str,
    featurestore_id: str,
    entity_type_id: str,
    description: str = "sample entity type",
    location: str = "us-central1",
    api_endpoint: str = "us-central1-aiplatform.googleapis.com",
    timeout: int = 300,
):
    # The AI Platform services require regional API endpoints, which need to be
    # in the same region or multi-region overlap with the Feature Store location.
    client_options = {"api_endpoint": api_endpoint}
    # Initialize client that will be used to create and send requests.
    # This client only needs to be created once, and can be reused for multiple requests.
    client = aiplatform.gapic.FeaturestoreServiceClient(client_options=client_options)
    parent = f"projects/{project}/locations/{location}/featurestores/{featurestore_id}"
    create_entity_type_request = aiplatform.gapic.CreateEntityTypeRequest(
        parent=parent,
        entity_type_id=entity_type_id,
        entity_type=aiplatform.gapic.EntityType(description=description),
    )
    lro_response = client.create_entity_type(request=create_entity_type_request)
    print("Long running operation:", lro_response.operation.name)
    create_entity_type_response = lro_response.result(timeout=timeout)
    print("create_entity_type_response:", create_entity_type_response)

Langages supplémentaires

Vous pouvez installer et utiliser les bibliothèques clientes Vertex AI suivantes pour appeler l'API Vertex AI. Les bibliothèques clientes Cloud offrent une expérience de développement optimisée en utilisant les conventions et styles naturels de chaque langage compatible.

• SDK Vertex AI pour Python
• Java
• Node.js

Répertorier des types d'entités

Répertoriez tous les types d'entités d'un magasin de caractéristiques.

UI Web

1. Dans la section "Vertex AI" de Google Cloud Console, accédez à la page Caractéristiques.

   Accéder à la page "Caractéristiques"

2. Sélectionnez une région dans la liste déroulante Région.
3. Dans la table des caractéristiques, affichez la colonne Type d'entité pour afficher les types d'entités de votre projet dans la région sélectionnée.

API REST et ligne de commande

Pour répertorier les types d'entités, envoyez une requête GET à l'aide de la méthode featurestores.entityTypes.list.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

• LOCATION : région où se trouve le featurestore, par exemple us-central1.
• PROJECT: ID de votre projet ou numéro de projet.
• FEATURESTORE_ID: ID du featurestore.

Méthode HTTP et URL :

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Remarque : Assurez-vous d'avoir défini la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès au fichier de clé privée de votre compte de service.

Exécutez la commande suivante :

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
"https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes"

PowerShell

Remarque : Assurez-vous d'avoir défini la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès au fichier de clé privée de votre compte de service.

Exécutez la commande suivante :

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method GET `
  -Headers $headers `
  -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "entityTypes": [
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE_ID_1",
      "description": "ENTITY_TYPE_DESCRIPTION",
      "createTime": "2021-02-25T01:20:43.082628Z",
      "updateTime": "2021-02-25T01:20:43.082628Z",
      "etag": "AMEw9yOBqKIdbBGZcxdKLrlZJAf9eTO2DEzcE81YDKA2LymDMFB8ucRbmKwKo2KnvOg="
    },
    {
      "name": "projects/PROJECT_NUMBER/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE_ID_2",
      "description": "ENTITY_TYPE_DESCRIPTION",
      "createTime": "2021-02-25T01:34:26.198628Z",
      "updateTime": "2021-02-25T01:34:26.198628Z",
      "etag": "AMEw9yNuv-ILYG8VLLm1lgIKc7asGIAVFErjvH2Cyc_wIQm7d6DL4ZGv59cwZmxTumU="
    }
  ]
}

Langages supplémentaires

Vous pouvez installer et utiliser les bibliothèques clientes Vertex AI suivantes pour appeler l'API Vertex AI. Les bibliothèques clientes Cloud offrent une expérience de développement optimisée en utilisant les conventions et styles naturels de chaque langage compatible.

• SDK Vertex AI pour Python
• Java
• Node.js

Supprimer un type d'entité

Supprimez un type d'entité. Si vous utilisez Cloud Console, Vertex AI Feature Store supprime le type d'entité et tout son contenu. Si vous utilisez l'API, activez le paramètre de requête force pour supprimer le type d'entité et tout son contenu.

UI Web

1. Dans la section "Vertex AI" de Google Cloud Console, accédez à la page Caractéristiques.

   Accéder à la page "Caractéristiques"

2. Sélectionnez une région dans la liste déroulante Région.
3. Dans la table des caractéristiques, affichez la colonne Type d'entité et recherchez le type d'entité à supprimer.
4. Cliquez sur le nom du type d'entité.
5. Dans la barre d'action, cliquez sur Supprimer.
6. Cliquez sur Confirmer pour supprimer le type d'entité.

API REST et ligne de commande

Pour supprimer un type d'entité, envoyez une requête DELETE à l'aide de la méthode featurestores.entityTypes.delete.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

• LOCATION : région où se trouve le featurestore, par exemple us-central1.
• PROJECT: ID de votre projet ou numéro de projet.
• FEATURESTORE_ID : ID du featurestore.
• ENTITY_TYPE_ID: ID du type d'entité.
• BOOLEAN : indique si le type d'entité doit être supprimé, même s'il contient des caractéristiques. Le paramètre de requête force est facultatif et est false par défaut.

Méthode HTTP et URL :

DELETE https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE_ID?force=BOOLEAN

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Remarque : Assurez-vous d'avoir défini la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès au fichier de clé privée de votre compte de service.

Exécutez la commande suivante :

curl -X DELETE \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
"https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE_ID?force=BOOLEAN"

PowerShell

Remarque : Assurez-vous d'avoir défini la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès au fichier de clé privée de votre compte de service.

Exécutez la commande suivante :

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method DELETE `
  -Headers $headers `
  -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT/locations/LOCATION/featurestores/FEATURESTORE_ID/entityTypes/ENTITY_TYPE_ID?force=BOOLEAN" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/featurestores/FEATURESTORE_ID/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1.DeleteOperationMetadata",
    "genericMetadata": {
      "createTime": "2021-02-26T17:32:56.008325Z",
      "updateTime": "2021-02-26T17:32:56.008325Z"
    }
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.protobuf.Empty"
  }
}

Langages supplémentaires

Vous pouvez installer et utiliser les bibliothèques clientes Vertex AI suivantes pour appeler l'API Vertex AI. Les bibliothèques clientes Cloud offrent une expérience de développement optimisée en utilisant les conventions et styles naturels de chaque langage compatible.

• SDK Vertex AI pour Python
• Java
• Node.js

Étape suivante

• Découvrez comment gérer les caractéristiques.
• Découvrez comment surveiller les valeurs des caractéristiques ingérées au fil du temps.
• Consultez le quota des types d'entités dans Vertex AI Feature Store.
• Résolvez les problèmes courants liés à Vertex AI Feature Store.