Panoramica dell'API Vertex AI

Questa pagina fornisce una panoramica dell'utilizzo delle API installate con Vertex AI su Google Distributed Cloud (GDC) con air gap e della relativa documentazione di riferimento.

Endpoint di servizio e documento di rilevamento

Per interagire in modo programmatico con le API Vertex AI è necessario un endpoint di servizio.

Recupera l'endpoint e il documento di rilevamento di Vertex AI Workbench

L'endpoint API per l'API KRM di Vertex AI Workbench è:

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

Sostituisci ENDPOINT con l'endpoint API del server dell'API Management.

Per accedere al documento di rilevamento di Vertex AI Workbench, esegui una delle seguenti azioni:

• Inserisci l'URL dell'endpoint in un browser.

• Esegui il comando kubectl proxy in uno strumento come curl per aprire un proxy al server dell'API Management sulla tua macchina locale. Dopo aver eseguito il comando, inserisci il seguente URL nel browser:

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

Recuperare gli endpoint delle API preaddestrate

Per ottenere gli endpoint delle API pre-addestrate, visualizza lo stato e gli endpoint del servizio.

REST, gRPC, KRM e librerie client

Puoi accedere alle API preaddestrate utilizzando gRPC o una delle librerie client fornite. Le librerie client sono basate su gRPC.

In alternativa, puoi accedere ad alcune API preaddestrate utilizzando REST.

Puoi gestire Vertex AI Workbench utilizzando la relativa API Kubernetes Resource Model (KRM).

Librerie client

Vertex AI fornisce librerie client Python per le API preaddestrate. La tabella seguente mostra un confronto tra i vantaggi e gli svantaggi dell'utilizzo delle librerie client:

Vantaggi	Svantaggi
Gestito da Google. Autenticazione integrata. Ritentativi integrati. Corpo della richiesta HTTP del buffer del protocollo efficiente.	Non disponibile per tutti i linguaggi di programmazione.

REST

Le API OCR e Translation supportano REST. Per ulteriori informazioni, consulta i riferimenti API REST per questi servizi:

• Riferimento API REST OCR

• Riferimento API REST Translation

Nota: le API Speech-to-Text e Vertex AI Workbench non supportano REST.

La tabella seguente mostra un confronto tra i vantaggi e gli svantaggi dell'utilizzo di REST:

Vantaggi	Svantaggi
Interfaccia JSON semplice. Ben supportato da molti strumenti e librerie Google e di terze parti.	Devi creare il tuo client. Devi implementare l'autenticazione. Devi implementare i tentativi. Corpo della richiesta HTTP JSON meno efficiente. Lo streaming REST non è supportato da queste API.

gRPC

Le API preaddestrate supportano gRPC. Per ulteriori informazioni sulle descrizioni generiche dei tipi, dei metodi e dei campi generati per una libreria gRPC, consulta il seguente riferimento gRPC:

• Riferimento gRPC OCR
• Riferimento gRPC di Speech-to-Text
• Riferimento gRPC per Translation

Nota: l'API Vertex AI Workbench non supporta gRPC.

La tabella seguente mostra un confronto tra i vantaggi e gli svantaggi dell'utilizzo di gRPC:

Vantaggi	Svantaggio
Supporta molti linguaggi di programmazione. Corpo della richiesta HTTP del buffer del protocollo efficiente.	Devi generare il tuo client dai buffer di protocollo forniti da Google. Devi implementare l'autenticazione. Devi implementare i tentativi.

KRM

L'API Vertex AI Workbench supporta KRM. Per ulteriori informazioni, consulta il riferimento API KRM di Vertex AI Workbench.

Tipo, metodo e nomi dei campi

A seconda che utilizzi librerie client, REST, gRPC o KRM, il tipo, il metodo e i nomi dei campi per l'API variano nei seguenti modi:

• REST è organizzato in base alle gerarchie delle risorse e ai relativi metodi.
• Le librerie client e gRPC sono organizzate in base ai servizi e ai relativi metodi.
• I nomi dei campi KRM utilizzano camelCase, ma il servizio API accetta camelCase o snake_case.
• I nomi dei campi REST e gRPC utilizzano snake_case.
• I nomi dei campi delle librerie client utilizzano la notazione title case, camelCase o snake_case, a seconda del nome idiomatico per la lingua.

REST e buffer di protocollo

Quando chiami l'API REST, il comportamento del valore predefinito per i buffer di protocollo potrebbe comportare la mancanza di campi in una risposta JSON. Questi campi sono impostati sul valore predefinito, pertanto non sono inclusi nella risposta.