En esta página se ofrece una descripción general del uso de las APIs instaladas con Vertex AI en Google Distributed Cloud (GDC) air-gapped y su documentación de referencia.
Punto de conexión de servicio y documento de descubrimiento
Se necesita un punto de conexión de servicio para interactuar mediante programación con las APIs de Vertex AI.
Obtener el punto de conexión y el documento de descubrimiento de Vertex AI Workbench
El endpoint de API KRM de Vertex AI Workbench es el siguiente:
https://ENDPOINT/apis/aiplatform.gdc.goog/v1
Sustituye ENDPOINT por el endpoint de API del servidor de API Management.
Para acceder al documento de descubrimiento de Vertex AI Workbench, realiza una de las siguientes acciones:
Introduce la URL del punto de conexión en un navegador.
Ejecuta el comando
kubectl proxyen una herramienta como curl para abrir un proxy al servidor de la API de gestión en tu máquina local. Una vez que se esté ejecutando el comando, introduce la siguiente URL en tu navegador:http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1.
Obtener los puntos de conexión de las APIs entrenadas previamente
Para obtener los puntos de conexión de las APIs entrenadas previamente, consulta el estado y los puntos de conexión de los servicios.
REST, gRPC, KRM y bibliotecas de cliente
Puedes acceder a las APIs entrenadas previamente mediante gRPC o una de las bibliotecas de cliente proporcionadas. Las bibliotecas de cliente se basan en gRPC.
También puedes acceder a algunas APIs entrenadas previamente mediante REST.
Puedes gestionar Vertex AI Workbench mediante su API de modelo de recursos de Kubernetes (KRM).
Bibliotecas de cliente
Vertex AI proporciona bibliotecas de cliente de Python para las APIs entrenadas previamente. En la siguiente tabla se comparan las ventajas y desventajas de usar bibliotecas de cliente:
| Ventajas | Desventajas |
|---|---|
|
Mantenidas por Google.
Autenticación integrada. Reintentos integrados. Cuerpo de solicitud HTTP de búfer de protocolo eficiente. |
No disponibles para todos los lenguajes de programación. |
REST
Las APIs de OCR y de traducción admiten REST. Para obtener más información, consulta las referencias de la API REST de estos servicios:
En la siguiente tabla se comparan las ventajas y desventajas de usar REST:
| Ventajas | Desventajas |
|---|---|
|
Interfaz JSON sencilla.
Bien admitida por muchas herramientas y bibliotecas de Google y de terceros. |
Debes crear tu propio cliente.
Debes implementar la autenticación. Debes implementar los reintentos. Cuerpo de solicitud HTTP JSON menos eficiente. Estas APIs no admiten el streaming REST. |
gRPC
Las APIs entrenadas previamente admiten gRPC. Para obtener más información sobre las descripciones genéricas de los tipos, métodos y campos generados para una biblioteca de gRPC, consulta la siguiente referencia de gRPC:
En la siguiente tabla se comparan las ventajas y desventajas de usar gRPC:
| Ventajas | Desventaja |
|---|---|
|
Admite muchos lenguajes de programación.
Cuerpo de solicitud HTTP de búfer de protocolo eficiente. |
Debes generar tu propio cliente a partir de los búferes de protocolo proporcionados por Google.
Debes implementar la autenticación. Debes implementar los reintentos. |
KRM
La API de Vertex AI Workbench admite KRM. Para obtener más información, consulta la referencia de la API KRM de Vertex AI Workbench.
Nombres de tipos, métodos y campos
En función de si usas bibliotecas de cliente, REST, gRPC o KRM, los nombres de tipos, métodos y campos de la API varían de las siguientes formas:
- REST se organiza por jerarquías de recursos y sus métodos.
- Las bibliotecas de cliente y gRPC se organizan por servicios y sus métodos.
- Los nombres de campos de KRM usan camelCase, pero el servicio de la API acepta camelCase o snake_case.
- Los nombres de campos de REST y gRPC usan snake_case.
- Los nombres de campos de las bibliotecas de cliente usan title case, camelCase o snake_case, en función del nombre que sea idiomático para el lenguaje.
REST y búferes de protocolo
Al llamar a la API REST, el comportamiento del valor predeterminado de los búferes de protocolo puede provocar que falten campos en una respuesta JSON. Estos campos se establecen en el valor predeterminado, por lo que no se incluyen en la respuesta.