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.

Obtener el endpoint y el documento de descubrimiento de Vertex AI Workbench

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

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

Sustituye ENDPOINT por el endpoint de la API del servidor de la API Management.

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

• Introduce la URL del endpoint en un navegador.

• Ejecuta el comando kubectl proxy en una herramienta como curl para abrir un proxy al servidor de la API Management en tu máquina local. Una vez que se haya ejecutado ese comando, introduce la siguiente URL en el navegador:

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

Obtener los endpoints de las APIs preentrenadas

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

REST, gRPC, KRM y bibliotecas de cliente

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.

Puedes gestionar Vertex AI Workbench con su API Kubernetes Resource Model (KRM).

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:

• Referencia de la API REST de OCR

• Referencia de la API REST de Translation

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

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.

gRPC

Las APIs preentrenadas 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:

• Referencia de gRPC de OCR
• Referencia de gRPC de Speech-to-Text
• Referencia de gRPC de traducción

Nota: La API de Vertex AI Workbench no admite 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.

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.

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.

REST y búferes de protocolo

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.