Descripción general de la API de Vertex AI

En esta página, se proporciona una descripción general del uso de las APIs instaladas con Vertex AI en Google Distributed Cloud (GDC) aislado y su documentación de referencia.

Extremo de servicio y documento de descubrimiento

Se requiere un extremo de servicio para interactuar de forma programática con las APIs de Vertex AI.

Obtén el extremo y el documento de descubrimiento de Vertex AI Workbench

El extremo de API de la API de KRM de Vertex AI Workbench es el siguiente:

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

Reemplaza ENDPOINT por el extremo de API del servidor de la API de Management.

Para acceder al documento de descubrimiento de Vertex AI Workbench, realiza una de las siguientes acciones:

• Ingresa la URL del extremo en un navegador.

• Ejecuta el comando kubectl proxy en una herramienta como curl para abrir un proxy al servidor de la API de Management en tu máquina local. Después de que se ejecute ese comando, ingresa la siguiente URL en tu navegador:

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

Obtén los extremos de las APIs previamente entrenadas

Para obtener los extremos de las APIs previamente entrenadas, consulta el estado y los extremos del servicio.

REST, gRPC, KRM y bibliotecas cliente

Puedes acceder a las APIs previamente entrenadas con gRPC o una de las bibliotecas cliente proporcionadas. Las bibliotecas cliente se basan en gRPC.

Como alternativa, puedes acceder a algunas APIs previamente entrenadas con REST.

Puedes administrar Vertex AI Workbench con su API del modelo de recursos de Kubernetes (KRM).

Bibliotecas cliente

Vertex AI proporciona bibliotecas cliente de Python para las APIs previamente entrenadas. En la siguiente tabla, se muestra una comparación de las ventajas y desventajas de usar bibliotecas cliente:

Ventajas	Desventajas
Google se encarga de su mantenimiento. Autenticación integrada. Reintentos integrados. Cuerpo de solicitud HTTP de búfer de protocolo eficiente.	No está disponible para todos los lenguajes de programación.

REST

Las APIs de OCR y Translation admiten REST. Para obtener más información, consulta las referencias de la API de REST para estos servicios:

• Referencia de la API de REST de OCR

• Referencia de la API de REST de Translation

Nota: Las APIs de Speech-to-Text y Vertex AI Workbench no admiten REST.

En la siguiente tabla, se muestra una comparación de las ventajas y desventajas de usar REST:

Ventajas	Desventajas
Interfaz JSON simple. Es compatible con muchas herramientas y bibliotecas de Google y de terceros.	Debes compilar tu propio cliente. Debes implementar la autenticación. Debes implementar reintentos. Cuerpo de solicitud HTTP JSON menos eficiente. Estas APIs no admiten la transmisión de REST.

gRPC

Las APIs previamente entrenadas admiten gRPC. Para obtener más información sobre las descripciones genéricas de los tipos, los métodos y los campos generados para una biblioteca de gRPC, consulta la siguiente referencia de gRPC:

• Referencia de gRPC de OCR
• Referencia de gRPC de Speech-to-Text
• Referencia de gRPC de Translation

Nota: La API de Vertex AI Workbench no admite gRPC.

En la siguiente tabla, se muestra una comparación de 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 reintentos.

KRM

La API de Vertex AI Workbench admite KRM. Para obtener más información, consulta la referencia de la API de KRM de Vertex AI Workbench.

Tipo, método y nombres de campo

Según si usas bibliotecas cliente, REST, gRPC o KRM, el tipo, los métodos y los nombres de campo para la API varían de las siguientes maneras:

• REST se organiza por jerarquías de recursos y sus métodos.
• Las bibliotecas cliente y gRPC se organizan por servicios y sus métodos.
• Los nombres de los campos de KRM usan camelCase, pero el servicio de API acepta camelCase o snake_case.
• Los nombres de los campos de REST y gRPC usan snake_case.
• Los nombres de campos de la biblioteca cliente usan camel case o snake case, según el nombre idiomático para el idioma.

REST y búferes de protocolo

Cuando se llama a la API de REST, el comportamiento del valor predeterminado para 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.