Vertex AI API 總覽

本頁面將概要說明如何使用 Google Distributed Cloud (GDC) Air-gapped 上的 Vertex AI 安裝的 API，以及相關的參考文件。

服務端點和探索文件

如要以程式輔助方式與 Vertex AI API 互動，必須使用服務端點。

取得 Vertex AI Workbench 端點和探索文件

Vertex AI Workbench KRM API 的 API 端點為：

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

將 ENDPOINT 替換為 Management API 伺服器的 API 端點。

如要存取 Vertex AI Workbench 探索文件，請執行下列其中一項操作：

  • 在瀏覽器中輸入端點網址。

  • 在 curl 等工具中執行 kubectl proxy 指令，在本機上開啟 Management API 伺服器的 Proxy。該指令執行完畢後，請在瀏覽器中輸入下列網址：

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

取得預先訓練的 API 端點

如要取得預先訓練 API 的端點，請查看服務狀態和端點。

REST、gRPC、KRM 和用戶端程式庫

您可以透過 gRPC 或我們提供的其中一個用戶端程式庫，存取預先訓練的 API。用戶端程式庫是根據 gRPC 建立的。

或者，您也可以使用 REST 存取部分預先訓練的 API。

您可以使用 Kubernetes 資源模型 (KRM) API 管理 Vertex AI Workbench。

用戶端程式庫

Vertex AI 提供預先訓練 API 的 Python 用戶端程式庫。下表比較使用用戶端程式庫的優點和缺點：

優點 缺點
由 Google 維護。
內建驗證。
內建重試機制。
效率高的通訊協定緩衝區 HTTP 要求主體。 		不適用於所有程式設計語言。

REST

OCR 和 Translation API 支援 REST。詳情請參閱下列服務的 REST API 參考資料：

下表比較使用 REST 的優缺點：

優點 缺點
簡單的 JSON 介面。
許多 Google 和第三方工具與程式庫都支援這項功能。 		您必須自行建構用戶端。
你必須導入驗證機制。
您必須實作重試機制。
效率較低的 JSON HTTP 要求主體。
這些 API 不支援 REST 串流。

gRPC

預先訓練的 API 支援 gRPC。如要進一步瞭解為 gRPC 程式庫產生的型別、方法和欄位的一般說明，請參閱下列 gRPC 參考資料：

下表比較使用 gRPC 的優缺點：

優點 缺點
支援多種程式設計語言。
效率高的通訊協定緩衝區 HTTP 要求主體。 		您必須從 Google 提供的通訊協定緩衝區產生自己的用戶端。
你必須導入驗證機制。
您必須實作重試機制。

KRM

Vertex AI Workbench API 支援 KRM。詳情請參閱 Vertex AI Workbench KRM API 參考資料。

類型、方法和欄位名稱

視您使用的是用戶端程式庫、REST、gRPC 或 KRM 而定，API 的型別、方法和欄位名稱會有所不同，如下所示：

  • REST API 會依資源階層及其方法排列。
  • 用戶端程式庫和 gRPC 會依服務及其方法排列。
  • KRM 欄位名稱使用 camelCase，但 API 服務接受 camelCase 或 snake_case。
  • REST 和 gRPC 欄位名稱使用 snake_case。
  • 視語言的慣例而定，用戶端程式庫欄位名稱會使用首字大寫、駝峰式大小寫或蛇形命名法。

REST 和通訊協定緩衝區

呼叫 REST API 時，通訊協定緩衝區的預設值行為可能會導致 JSON 回應缺少欄位。這些欄位已設為預設值，因此不會納入回應。