Vertex AI API の概要

Google Distributed Cloud(GDC)エアギャップの Vertex AI API を使用すると、事前トレーニング済みの ML モデルをアプリケーションにプログラムで統合し、Vertex AI Workbench リソースを管理できます。サービスに応じて、gRPC、REST、Python クライアント ライブラリ、または Kubernetes Resource Model(KRM)を使用して、これらの 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 リクエスト本文。
これらの API では REST ストリーミングはサポートされていません。

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、スネークケース のいずれかが使用されます。

REST とプロトコル バッファ

REST API を呼び出すと、プロトコル バッファのデフォルト値の動作により、JSON レスポンスにフィールドが欠落する可能性があります。これらのフィールドはデフォルト値に設定されているため、レスポンスには含まれません。