Dieser Leitfaden bietet einen Überblick über die Verwendung der Notebooks API und der zugehörigen Referenzdokumentation.
REST, gRPC und Clientbibliotheken
Sie können über REST, gRPC oder eine der bereitgestellten gRPC-Clientbibliotheken auf die API zugreifen.
Clientbibliotheken
Google bietet Clientbibliotheken für viele gängige Sprachen für den Zugriff auf diese API an. Verwenden Sie diese Option, wenn die gewünschte Programmiersprache von den Clientbibliotheken unterstützt wird.
| Vorteile | Nachteile |
|---|---|
|
Verwaltet von Google.
Integrierte Authentifizierung. Integrierte Wiederholungsversuche. Idiomatisch für jede Sprache. Effizienter HTTP-Anfragetext für Protokollzwischenspeicher |
Nicht für alle Programmiersprachen verfügbar. |
REST
Diese API unterstützt REST. REST-Referenz für diese API Siehe auch Google APIs aufrufen: REST-Version.
| 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 effiziente JSON-HTTP-Anfragetext. REST-Streaming wird von dieser API nicht unterstützt. |
gRPC
Diese API unterstützt gRPC. In der RPC-Referenz für diese API finden Sie eine allgemeine Beschreibung der Typen, Methoden und Felder, die für eine gRPC-Bibliothek generiert wurden. Siehe auch Google-APIs aufrufen: RPC-Version.
| Vorteile | Nachteile |
|---|---|
|
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. |
Typ-, Methoden- und Feldnamen
Je nachdem, ob Sie Clientbibliotheken, REST oder gRPC verwenden, variieren die Typen, Methoden und Feldnamen für die API:
- REST ist nach Ressourcenhierarchien und ihren Methoden angeordnet.
- Clientbibliotheken und gRPC sind nach Diensten und ihren Methoden angeordnet.
- Die Namen der REST-Felder haben eine Camel-Case-Schreibweise, auch wenn der API-Dienst entweder eine Camel- oder Snake-Case-Schreibweise akzeptiert.
- gRPC-Feldnamen nutzen 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.
Log-Puffer
Unabhängig davon, ob Sie Clientbibliotheken, REST oder gRPC verwenden, wird der zugrunde liegende Dienst mit Protokollpuffern definiert. Insbesondere verwendet der Dienst proto3.
Beim Aufrufen der API ist für einige Anfrage- oder Antwortfelder ein grundlegendes Verständnis von bekannten Protokollpuffertypen erforderlich.
Außerdem kann das Standardwertverhalten für Protocol Buffers beim Aufrufen der REST API dazu führen, dass Felder in einer JSON-Antwort fehlen. Diese Felder werden einfach auf den Standardwert gesetzt und sind daher nicht in der Antwort enthalten.
API-Versionen
Folgende API-Versionen sind verfügbar:
- v2 (allgemein verfügbar) dient zur Verwaltung von Gemini Enterprise Agent Platform Workbench-Instanzen.