このページでは、Google Distributed Cloud（GDC）エアギャップに 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 検出ドキュメントにアクセスするには、次のいずれかの操作を行います。
ブラウザにエンドポイント URL を入力します。
curl などのツールで
kubectl proxyコマンドを実行して、ローカルマシンの Management API サーバーへのプロキシを開きます。このコマンドの実行後、ブラウザに次の URL を入力します。http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1。
事前トレーニング済み API のエンドポイントを取得する
事前トレーニング済み API のエンドポイントを取得するには、サービス ステータスとエンドポイントを表示します。
REST、gRPC、KRM、クライアント ライブラリ
事前トレーニング済み API には、gRPC または指定されたクライアント ライブラリのいずれかを使用してアクセスできます。クライアント ライブラリは gRPC で構築されています。
また、REST を使用して一部の事前トレーニング済み API にアクセスすることもできます。
Vertex AI Workbench は、Kubernetes Resource Model（KRM）API を使用して管理できます。
クライアント ライブラリ
Vertex AI には、事前トレーニング済み API 用の Python クライアント ライブラリが用意されています。次の表に、クライアント ライブラリを使用するメリットとデメリットの比較を示します。
| 利点 | 欠点 |
|---|---|
|
Google が保守。 組み込み認証。 組み込み再試行。 効率的なプロトコル バッファ HTTP リクエスト本文。 |
一部のプログラミング言語ではご利用いただけません。 |
REST
OCR API と Translation API は REST をサポートしています。詳細については、次のサービスの REST API リファレンスをご覧ください。
次の表に、REST を使用する利点と欠点の比較を示します。
| 利点 | 欠点 |
|---|---|
|
シンプルな JSON インターフェース。 Google とサードパーティのツールやライブラリで十分にサポートされています。 |
独自のクライアントを構築する必要があります。 認証を実装する必要があります。 再試行を実装する必要があります。 効率の悪い JSON HTTP リクエスト本文。 REST ストリーミングは、これらの API ではサポートされていません。 |
gRPC
事前トレーニング済み API は gRPC をサポートしています。gRPC ライブラリ用に生成される型、メソッド、フィールドの一般的な説明については、次の gRPC リファレンスをご覧ください。
次の表に、gRPC を使用するメリットとデメリットの比較を示します。
| 利点 | デメリット |
|---|---|
|
多くのプログラミング言語に対応しています。 効率的なプロトコル バッファ HTTP リクエスト本文。 |
Google 提供のプロトコル バッファから独自のクライアントを生成する必要があります。 認証を実装する必要があります。 再試行を実装する必要があります。 |
KRM（KRM）
Vertex AI Workbench API は KRM をサポートしています。詳細については、Vertex AI Workbench KRM API リファレンスをご覧ください。
型、メソッド、フィールドの名前
クライアント ライブラリ、REST、gRPC、KRM のいずれを使用するかによって、API のタイプ、メソッド、フィールド名は次のように異なります。
- REST は、リソース階層とそのメソッド別に配置されます。
- クライアント ライブラリと gRPC は、サービスとそのメソッド別に配置されます。
- KRM フィールド名では camelCase が使用されますが、API サービスでは camelCase または snake_case のいずれかが認められます。
- REST と gRPC のフィールド名ではスネークケースが使用されます。
- クライアント ライブラリのフィールド名は、その言語でどの名前が慣用的であるかに応じて、タイトルケース、camelCase、snake_case のいずれかを使用します。
REST とプロトコル バッファ
REST API を呼び出すと、プロトコル バッファのデフォルト値の動作により、JSON レスポンスでフィールドが欠落する可能性があります。これらのフィールドはデフォルト値に設定されているため、レスポンスには含まれません。