Présentation de l'API Vertex AI

Cette page présente l'utilisation des API installées avec Vertex AI sur Google Distributed Cloud (GDC) air-gapped et sa documentation de référence.

Point de terminaison du service et document de découverte

Un point de terminaison de service est requis pour interagir de manière programmatique avec les API Vertex AI.

Obtenir le point de terminaison et le document de découverte Vertex AI Workbench

Le point de terminaison de l'API KRM Vertex AI Workbench est le suivant :

https://ENDPOINT/apis/aiplatform.gdc.goog/v1

Remplacez ENDPOINT par le point de terminaison de l'API du serveur de l'API Management.

Pour accéder au document de découverte Vertex AI Workbench, effectuez l'une des actions suivantes :

  • Saisissez l'URL du point de terminaison dans un navigateur.

  • Exécutez la commande kubectl proxy dans un outil tel que curl pour ouvrir un proxy vers le serveur de l'API Management sur votre ordinateur local. Une fois cette commande exécutée, saisissez l'URL suivante dans votre navigateur :

    http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1.

Obtenir les points de terminaison des API pré-entraînées

Pour obtenir les points de terminaison des API pré-entraînées, consultez l'état et les points de terminaison des services.

REST, gRPC, KRM et bibliothèques clientes

Vous pouvez accéder aux API pré-entraînées à l'aide de gRPC ou de l'une des bibliothèques clientes fournies. Les bibliothèques clientes sont basées sur gRPC.

Vous pouvez également accéder à certaines API pré-entraînées à l'aide de REST.

Vous pouvez gérer Vertex AI Workbench à l'aide de son API Kubernetes Resource Model (KRM).

Bibliothèques clientes

Vertex AI fournit des bibliothèques clientes Python pour les API pré-entraînées. Le tableau suivant compare les avantages et les inconvénients de l'utilisation de bibliothèques clientes :

Avantages Inconvénients
Géré par Google.
Authentification intégrée.
Nouvelles tentatives intégrées.
Corps de requête HTTP avec tampon de protocole efficace. 		Non disponible pour tous les langages de programmation.

REST

Les API OCR et Translation sont compatibles avec REST. Pour en savoir plus, consultez la documentation de référence de l'API REST pour ces services :

Le tableau suivant compare les avantages et les inconvénients de l'utilisation de REST :

Avantages Inconvénients
Interface JSON simple.
Pleinement compatible avec de nombreux outils et bibliothèques Google et tiers 		Vous devez créer votre propre client.
Vous devez mettre en œuvre l'authentification.
Vous devez implémenter les nouvelles tentatives.
Corps de requête HTTP JSON moins efficace.
Le streaming REST n'est pas compatible avec ces API.

gRPC

Les API pré-entraînées sont compatibles avec gRPC. Pour en savoir plus sur les descriptions génériques des types, des méthodes et des champs générés pour une bibliothèque gRPC, consultez la documentation de référence gRPC suivante :

Le tableau suivant compare les avantages et les inconvénients de l'utilisation de gRPC :

Avantages Inconvénient
Compatible avec de nombreux langages de programmation.
Corps de requête HTTP avec tampon de protocole efficace. 		Vous devez générer votre propre client à partir des tampons de protocole fournis par Google.
Vous devez mettre en œuvre l'authentification.
Vous devez implémenter les nouvelles tentatives.

KRM

L'API Vertex AI Workbench est compatible avec KRM. Pour en savoir plus, consultez la documentation de référence de l'API KRM Vertex AI Workbench.

Noms de type, de méthode et de champs

Selon que vous utilisez des bibliothèques clientes, REST, gRPC ou KRM, les noms de type, de méthode et de champ de l'API varient comme suit :

  • L'architecture REST est organisée par hiérarchies de ressources et leurs méthodes.
  • Les bibliothèques clientes et gRPC sont organisées par services et par leurs méthodes.
  • Les noms de champs KRM utilisent la convention typographique camelCase, mais le service d'API accepte aussi bien camelCase que snake_case.
  • Les noms de champs REST et gRPC utilisent snake_case.
  • Les noms de champs de la bibliothèque cliente utilisent soit la casse du titre, soit camelCase ou snake_case, selon le caractère idiomatique du nom dans le langage concerné.

REST et Protocol Buffers

Lorsque vous appelez l'API REST, le comportement des valeurs par défaut pour les tampons de protocole peut entraîner l'absence de champs dans une réponse JSON. Ces champs sont définis sur la valeur par défaut et ne sont donc pas inclus dans la réponse.