Información general sobre la API Vertex AI

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

Punto de conexión de servicio y documento de descubrimiento

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

Para obtener los endpoints de las APIs preentrenadas, consulta el estado y los endpoints del servicio.

Acceso a la API

Puedes acceder a las APIs preentrenadas 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 preentrenadas mediante REST.

Bibliotecas de cliente

Vertex AI proporciona bibliotecas de cliente de Python para APIs preentrenadas. En la siguiente tabla se comparan las ventajas y las desventajas de usar bibliotecas de cliente:

Ventajas Desventajas
Mantenido por Google.
Autenticación integrada.
Reintentos integrados.
Cuerpo de la solicitud HTTP de búfer de protocolo eficiente.
No está disponible en todos los lenguajes de programación.

REST

Las APIs OCR y Translation 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.
Es compatible con muchas herramientas y bibliotecas de Google y de terceros.
Debes crear tu propio cliente.
Debes implementar la autenticación.
Debes implementar reintentos.
Cuerpo de solicitud HTTP JSON menos eficiente. Estas APIs no admiten el streaming de
REST.

Al llamar a la API REST, el comportamiento predeterminado de los búferes de protocolo puede provocar que falten campos en una respuesta JSON. Estos campos tienen el valor predeterminado, por lo que no se incluyen en la respuesta.

gRPC

Las APIs preentrenadas y la API de Gemini 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
Es compatible con muchos lenguajes de programación.
Cuerpo de la 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.

Tipos, métodos y nombres de campos

Según si usas bibliotecas de cliente, REST, gRPC o KRM, el tipo, el método y los nombres de los 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 los campos de KRM usan camelCase, pero el servicio de la API acepta camelCase o snake_case.
  • Los nombres de los campos REST y gRPC usan snake_case.
  • Los nombres de los campos de la biblioteca de cliente usan mayúsculas iniciales, camelCase o snake_case, según el nombre que sea idiomático para el lenguaje.