Vertex AI-APIs – Übersicht

Auf dieser Seite finden Sie eine Übersicht über die Verwendung der APIs, die mit Vertex AI in 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 Discovery-Dokument abrufen

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

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

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

Führen Sie einen der folgenden Schritte aus, um auf das Vertex AI Workbench-Discovery-Dokument zuzugreifen:

  • 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. Nachdem der Befehl ausgeführt wurde, geben Sie die folgende URL in Ihren Browser ein:

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

Endpunkte der vortrainierten APIs abrufen

Die Endpunkte für die vortrainierten APIs finden Sie unter Dienststatus und Endpunkte.

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 auf einige vortrainierte APIs über REST zugreifen.

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

Clientbibliotheken

Vertex AI bietet Python-Clientbibliotheken für vortrainierte APIs. In der folgenden Tabelle werden die Vor- und Nachteile der Verwendung von Clientbibliotheken verglichen:

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

REST

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

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

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 Wiederholungen 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 Wiederholungen implementieren.

KRM

Die Vertex AI Workbench API unterstützt KRM. Weitere Informationen finden Sie unter 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 die Camel-Case-Schreibweise, aber der API-Dienst akzeptiert entweder die Camel-Case- oder die Snake-Case-Schreibweise.
  • REST- und gRPC-Feldnamen verwenden die Snake-Case-Schreibweise.
  • 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 Protokollzwischenspeicher

Beim Aufrufen der REST API kann das Standardverhalten für Protokollzwischenspeicher dazu führen, dass Felder in einer JSON-Antwort fehlen. Diese Felder sind auf den Standardwert festgelegt und daher nicht in der Antwort enthalten.