Vertex AI-APIs – Übersicht

Auf dieser Seite erhalten Sie einen Überblick über die Verwendung der APIs, die mit Vertex AI auf Google Distributed Cloud (GDC) Air-Gapped installiert wurden, sowie die zugehörige Referenzdokumentation.

Dienstendpunkt und Discovery-Dokument

Ein Dienstendpunkt ist erforderlich, um programmatisch mit den Vertex AI APIs zu interagieren.

Vertex AI Workbench-Endpunkt und ‑Dokument zur Ermittlung abrufen

Der API-Endpunkt für die Vertex AI Workbench KRM API lautet:

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

Ersetzen Sie ENDPOINT durch den API-Endpunkt des Management API-Servers.

So greifen Sie auf das Vertex AI Workbench-Discovery-Dokument zu:

  • Geben Sie die Endpunkt-URL in einen Browser ein.

  • Führen Sie den Befehl kubectl proxy in einem Tool wie curl aus, um einen Proxy zum Management API-Server auf Ihrem lokalen Computer zu öffnen. Geben Sie nach Ausführung des Befehls die folgende URL in Ihren Browser ein:

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

Endpunkte der vortrainierten APIs abrufen

Dienststatus und Endpunkte ansehen

REST, gRPC, KRM und Clientbibliotheken

Sie können über gRPC oder eine der bereitgestellten Clientbibliotheken auf die vortrainierten APIs zugreifen. Die Clientbibliotheken basieren auf gRPC.

Alternativ können Sie über REST auf einige vortrainierte APIs zugreifen.

Sie können Vertex AI Workbench mit der KRM-API (Kubernetes Resource Model) verwalten.

Clientbibliotheken

Vertex AI bietet Python-Clientbibliotheken für vortrainierte APIs. In der folgenden Tabelle finden Sie einen Vergleich der Vor- und Nachteile der Verwendung von Clientbibliotheken:

Vorteile Nachteile
Verwaltet von Google.
Integrierte Authentifizierung.
Integrierte Wiederholungsversuche.
Effizienter HTTP-Anfragetext für Protokollzwischenspeicher 		Nicht für alle Programmiersprachen verfügbar.

REST

Die OCR- und Translation APIs unterstützen REST. Weitere Informationen finden Sie in den REST API-Referenzen für diese Dienste:

Die folgende Tabelle zeigt einen Vergleich der Vor- und Nachteile der Verwendung von REST:

Vorteile Nachteile
Einfache JSON-Oberfläche
Viele Tools und Bibliotheken von Google und Drittanbietern werden unterstützt. 		Sie müssen einen eigenen Client erstellen.
Sie müssen die Authentifizierung implementieren.
Sie müssen Wiederholungsversuche implementieren.
Weniger effizienter JSON-HTTP-Anfragetext.
REST-Streaming wird von diesen APIs nicht unterstützt.

gRPC

Vortrainierte APIs unterstützen gRPC. Weitere Informationen zu den allgemeinen Beschreibungen der Typen, Methoden und Felder, die für eine gRPC-Bibliothek generiert wurden, finden Sie in der folgenden gRPC-Referenz:

In der folgenden Tabelle werden die Vor- und Nachteile der Verwendung von gRPC verglichen:

Vorteile Nachteil
Unterstützt viele Programmiersprachen.
Effizienter HTTP-Anfragetext für Protokollzwischenspeicher 		Sie müssen Ihren eigenen Client mithilfe der von Google bereitgestellten Protokollzwischenspeicher generieren.
Sie müssen die Authentifizierung implementieren.
Sie müssen Wiederholungsversuche implementieren.

KRM

Die Vertex AI Workbench API unterstützt KRM. Weitere Informationen finden Sie in der Vertex AI Workbench KRM API-Referenz.

Typ-, Methoden- und Feldnamen

Je nachdem, ob Sie Clientbibliotheken, REST, gRPC oder KRM verwenden, variieren die Typen, Methoden und Feldnamen für die API auf folgende Weise:

  • REST ist nach Ressourcenhierarchien und ihren Methoden angeordnet.
  • Clientbibliotheken und gRPC sind nach Diensten und ihren Methoden angeordnet.
  • KRM-Feldnamen verwenden camelCase, aber der API-Dienst akzeptiert entweder camelCase oder snake_case.
  • REST- und gRPC-Feldnamen verwenden snake_case.
  • In den Namen der Clientbibliotheken wird entweder Groß-/Kleinschreibung, die Camel-Case- oder Snake-Case-Schreibweise verwendet, je nachdem, welcher Name für die Sprache idiomatisch ist.

REST und Protokollpuffer

Beim Aufrufen der REST API kann das Standardwertverhalten für Protokollpuffer dazu führen, dass Felder in einer JSON-Antwort fehlen. Diese Felder sind auf den Standardwert festgelegt und werden daher nicht in die Antwort aufgenommen.