prediction.aiplatform.gdc.goog/v1
パッケージ v1 には、prediction.aiplatform.gdc.goog v1 API グループの API スキーマ定義が含まれています。
自動スケーリング
デプロイの自動スケーリング パラメータを定義します。
表示場所:
フィールド | 説明 |
---|---|
minReplica 整数 |
レプリカの最小数。デフォルト値は 1 です。次のタグは 5 です。 |
maxReplica 整数 |
レプリカの最大数。 |
cpuTarget 整数 |
Pod をスケールアップするための CPU 使用率のしきい値。 |
gpuDutyCycleTarget 整数 |
Pod をスケールアップするための GPU デューティ サイクル使用率のしきい値。 |
DedicatedResources
リソースプール専用のリソースを定義します。次の ID は 8
です。
表示場所:
フィールド | 説明 |
---|---|
machineSpec |
不要。machineType 値を使用して、単一マシンの構成を指定します。指定しない場合は、デフォルト値が使用されます。予測の場合、デプロイのデフォルトのマシンタイプは n1-standard-2 (GKE ベースのモデル)または n2-standard-2-gdc (CPU ベースのモデル)です。 |
autoscaling 自動スケーリング |
ユーザー ワークロードの自動スケーリング パラメータ(予測の予測子デプロイなど)を指定します。 |
DeployedModel
DeployedModels
API のスキーマを定義します。
表示場所:
フィールド | 説明 |
---|---|
apiVersion 文字列 |
prediction.aiplatform.gdc.goog/v1 |
kind 文字列 |
DeployedModel |
metadata ObjectMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
spec DeployedModelSpec |
|
status DeployedModelStatus |
DeployedModelList
DeployedModel
リソースのリストが含まれます。
フィールド | 説明 |
---|---|
apiVersion 文字列 |
prediction.aiplatform.gdc.goog/v1 |
kind 文字列 |
DeployedModelList |
metadata ListMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
items DeployedModel 配列 |
DeployedModelSpec
DeployedModel
リソースの想定される状態を定義します。
表示場所:
フィールド | 説明 |
---|---|
endpointPath 文字列 |
エンドポイントのリソース名を指定します。形式は projects/{project}/locations/{location}/endpoints/{endpoint-id} です。次のタグは 6 です。 |
modelSpec 無効な型 |
モデルのデプロイ時に必要なモデル仕様を定義します。 |
resourcePoolRef ObjectReference |
この DeployedModel に必要なリソース仕様を含むリソースプールの参照を指定します。 |
sharesResourcePool ブール値 |
DeployedModel が他のモデルとリソースプールを共有するかどうかを指定します。 |
DeployedModelStatus
DeployedModel
リソースの観測状態を定義します。
表示場所:
フィールド | 説明 |
---|---|
ready ブール値 |
リソースが準備完了状態かどうかを示します。 |
primaryCondition |
リソースのプライマリ条件を表します。リソースが使用可能な場合、条件はリソースが使用可能であることを示します。それ以外の場合、この条件はリソースが準備できていない主な理由です。 |
resourceConditions 配列 |
リソースとそのサブリソースの条件のコレクションを表します。これを使用して、リソースとそのサブリソースの全体的な健全性を判断できます。 |
conditions 条件の配列 |
デバッグ用に Kubernetes リソースから入力された未加工のリソース条件を表します。 |
routes ルート |
デプロイされたモデルの予測またはヘルスチェックのコンテナまたはシステムルートを表します。 |
ports ポート |
コンテナの HTTP ポートまたは gRPC ポートを表します。 |
rpcStatus RpcStatus |
デプロイされたモデルのメインの条件の正規 RPC 表現を示します。 |
observedGeneration 整数 |
最後に調整されたリソースのリビジョンを示します。 |
ポート
表示場所:
フィールド | 説明 |
---|---|
predictorPorts 整数配列 |
予測子から公開する HTTP ポートのリストを取得します。リクエストは、最初にリストされたポート以外のポートには転送されません。このフィールドは、Kubernetes コンテナの v1 core API の ports フィールドに対応しています。 |
predictorGRPCPorts 整数配列 |
予測子から公開する gRPC ポートのリスト。このフィールドを省略すると、コンテナへの gRPC リクエストが無効になります。リクエストは、最初にリストされたポート以外のポートには転送されません。このフィールドは、Kubernetes コンテナの v1 core API の ports フィールドに対応しています。 |
ReplicaStatus
ResourcePool
リソースのレプリカ情報を定義します。
表示場所:
フィールド | 説明 |
---|---|
resourceType ResourceType |
リソースのタイプを指定します。 |
resourceName 文字列 |
リソースタイプの Namespace 内の一意のリソース名を示します。たとえば、Deployment ResourceType のリソース名は Kubernetes Deployment 名です。 |
resourceNamespace 文字列 |
リソースの Namespace を示します。このフィールドは、クラスタ スコープのリソースには適用されません。 |
appType 文字列 |
特定の商品によって定義される、リソースのアプリケーション タイプを示します。たとえば、Prediction は predictor と explainer を appType としてサポートしています。 |
availableReplicas 整数 |
使用可能なレプリカの総数を示します。Kubernetes デプロイ リソースタイプの場合、このフィールドは、このデプロイのターゲットとなる、少なくとも最小限の準備秒数で準備が整っている使用可能な Pod の総数を表します。 |
unavailableReplicas 整数 |
利用できないレプリカの合計数を示します。Kubernetes Deployment リソース タイプの場合、Deployment のターゲットとなる使用不可の Pod の合計数を表します。 |
リソースプール
ResourcePools
API のスキーマを定義します。
表示場所:
フィールド | 説明 |
---|---|
apiVersion 文字列 |
prediction.aiplatform.gdc.goog/v1 |
kind 文字列 |
ResourcePool |
metadata ObjectMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
spec ResourcePoolSpec |
|
status ResourcePoolStatus |
ResourcePoolList
ResourcePool
リソースのリストが含まれます。
フィールド | 説明 |
---|---|
apiVersion 文字列 |
prediction.aiplatform.gdc.goog/v1 |
kind 文字列 |
ResourcePoolList |
metadata ListMeta |
metadata のフィールドについては、Kubernetes API のドキュメントをご覧ください。 |
items ResourcePool 配列 |
ResourcePoolSpec
ResourcePool
リソースの想定される状態を定義します。
表示場所:
フィールド | 説明 |
---|---|
resourcePoolID 文字列 |
ResourcePool リソースのシステム生成 ID を表します。このフィールドは、 Google Cloud と GDCE にのみ適用されます。次のタグは 8 です。 |
userProvidedID 文字列 |
ResourcePool リソースのユーザー指定 ID を表します。このフィールドは、 Google Cloud と GDCE にのみ適用されます。 |
dedicatedResources DedicatedResources |
リソースプール専用のリソースの説明が含まれます。 |
enableContainerLogging ブール値 |
ResourcePool でコンテナ ロギングが有効になっているかどうかを示します。 |
userGsa 文字列 |
ユーザー プロジェクトでユーザーが指定した IAM サービス アカウントを示します。指定しない場合は、デフォルトのサービング サービス アカウントが使用されます。 |
customKsaName 文字列 |
オペレーターが作成し、ユーザー ワークロードが使用するカスタム名を指定します(お客様所有サービス アカウント(BYOSA)の場合のみ)。空の場合、システムはデフォルトの命名パターンを使用します。 |
rolloutStrategy 無効な型 |
このプールにデプロイされたモデルをモデルサーバー レプリカに段階的にロールアウトするか、一度にロールアウトするかを指定します。 |
ResourcePoolStatus
ResourcePool
リソースの観測状態を定義します。
表示場所:
フィールド | 説明 |
---|---|
ready ブール値 |
リソースが準備完了状態かどうかを示します。 |
primaryCondition |
リソースのプライマリ条件を表します。リソースが使用可能な場合、条件はリソースが使用可能であることを示します。それ以外の場合、この条件はリソースが準備できていない主な理由です。 |
resourceConditions |
リソースとそのサブリソースの条件のコレクションを表します。これを使用して、リソースとそのサブリソースの全体的な健全性を判断できます。 |
conditions 条件の配列 |
デバッグ用に Kubernetes リソースから入力された未加工のリソース条件を表します。 |
replicaStatuses ReplicaStatus の配列 |
|
rpcStatus RpcStatus |
ResourcePool のプライマリ条件の正規 RPC 表現を示します。 |
observedGeneration 整数 |
リソースのどのリビジョンが最後に調整されたかを示します。 |
ルート
表示場所:
フィールド | 説明 |
---|---|
predictRoute 文字列 |
予測リクエストを送信するコンテナのルーティング パスを表します。Vertex AI は、projects.locations.endpoints.predict を使用して、コンテナの IP アドレスとポートのこのパスにリクエストを転送します。Vertex AI は、コンテナのレスポンスを API レスポンスで返します。 |
predictSystemRoute 文字列 |
クラスタの Ingress に予測リクエストを送信するシステム ルーティング パスを表します。このフィールドは、デプロイ時に deployedModel にコピーされる場合にのみ内部的に入力されます。 |
healthRoute 文字列 |
ヘルスチェックを送信するコンテナのルーティング パスを表します。Vertex AI は、コンテナの IP アドレスとポートのこのパスに GET リクエストを断続的に送信し、コンテナが正常であることを確認します。 |
healthSystemRoute 文字列 |
クラスタ Ingress にヘルスチェック リクエストを送信するシステム ルーティング パスを表します。このフィールドは、デプロイ時に deployedModel にコピーされる場合にのみ内部的に入力されます。 |
RpcStatus
RPC コードとメッセージをカプセル化します。
表示場所:
フィールド | 説明 |
---|---|
code コード |
RPC コードを表します。次のタグは 4 です。 |
message 文字列 |
条件のユーザー向けの説明が含まれています。 |
terminalState ブール値 |
リソースが最終状態に達し、準備完了状態に移行できない場合は、値 true を示します。 |