feat: expose RecommendSpecs api to vertex python SDK for Custom Weights Model deployment

Google APIs · copybara-github · commit 79a8512f559e · 2025-08-11T16:18:18.000-07:00
PiperOrigin-RevId: 793835739
diff --git a/google/cloud/aiplatform/v1beta1/model_service.proto b/google/cloud/aiplatform/v1beta1/model_service.proto
@@ -24,6 +24,7 @@ import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
 import "google/cloud/aiplatform/v1beta1/evaluated_annotation.proto";
 import "google/cloud/aiplatform/v1beta1/explanation.proto";
 import "google/cloud/aiplatform/v1beta1/io.proto";
+import "google/cloud/aiplatform/v1beta1/machine_resources.proto";
 import "google/cloud/aiplatform/v1beta1/model.proto";
 import "google/cloud/aiplatform/v1beta1/model_evaluation.proto";
 import "google/cloud/aiplatform/v1beta1/model_evaluation_slice.proto";
@@ -261,6 +262,14 @@ service ModelService {
     };
     option (google.api.method_signature) = "parent";
   }
+
+  // Gets a Model's spec recommendations.
+  rpc RecommendSpec(RecommendSpecRequest) returns (RecommendSpecResponse) {
+    option (google.api.http) = {
+      post: "/v1beta1/{parent=projects/*/locations/*}:recommendSpec"
+      body: "*"
+    };
+  }
 }
 
 // Request message for
@@ -966,3 +975,84 @@ message ListModelEvaluationSlicesResponse {
   // to obtain that page.
   string next_page_token = 2;
 }
+
+// Request message for
+// [ModelService.RecommendSpec][google.cloud.aiplatform.v1beta1.ModelService.RecommendSpec].
+message RecommendSpecRequest {
+  // Required. The resource name of the Location from which to recommend specs.
+  // The users must have permission to make a call in the project.
+  // Format:
+  // `projects/{project}/locations/{location}`.
+  string parent = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "locations.googleapis.com/Location"
+    }
+  ];
+
+  // Required. The Google Cloud Storage URI of the custom model, storing weights
+  // and config files (which can be used to infer the base model).
+  string gcs_uri = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. If true, check machine availability for the recommended regions.
+  // Only return the machine spec in regions where the machine is available.
+  bool check_machine_availability = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. If true, check user quota for the recommended regions.
+  // Returns all the machine spec in regions they are available, and also the
+  // user quota state for each machine type in each region.
+  bool check_user_quota = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response message for
+// [ModelService.RecommendSpec][google.cloud.aiplatform.v1beta1.ModelService.RecommendSpec].
+message RecommendSpecResponse {
+  // A machine and model container spec.
+  message MachineAndModelContainerSpec {
+    // Output only. The machine spec.
+    MachineSpec machine_spec = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The model container spec.
+    ModelContainerSpec container_spec = 2
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Recommendation of one deployment option for the given custom weights model
+  // in one region.
+  // Contains the machine and container spec, and user accelerator quota state.
+  message Recommendation {
+    // The user accelerator quota state.
+    enum QuotaState {
+      // Unspecified quota state. Quota information not available.
+      QUOTA_STATE_UNSPECIFIED = 0;
+
+      // User has enough accelerator quota for the machine type.
+      QUOTA_STATE_USER_HAS_QUOTA = 1;
+
+      // User does not have enough accelerator quota for the machine type.
+      QUOTA_STATE_NO_USER_QUOTA = 2;
+    }
+
+    // The region for the deployment spec (machine).
+    string region = 1;
+
+    // Output only. The machine and model container specs.
+    MachineAndModelContainerSpec spec = 2
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The user accelerator quota state.
+    QuotaState user_quota_state = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Output only. The base model used to finetune the custom model.
+  string base_model = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Recommendations of deployment options for the given custom
+  // weights model.
+  repeated Recommendation recommendations = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The machine and model container specs.
+  repeated MachineAndModelContainerSpec specs = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
