feat: add a ExportPublisherModel API

Google APIs · copybara-github · commit c08fbfa15544 · 2025-03-20T10:27:38.000-07:00
PiperOrigin-RevId: 738854222
diff --git a/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml b/google/cloud/aiplatform/v1beta1/aiplatform_v1beta1.yaml
@@ -91,6 +91,8 @@ types:
 - name: google.cloud.aiplatform.v1beta1.ExportFeatureValuesResponse
 - name: google.cloud.aiplatform.v1beta1.ExportModelOperationMetadata
 - name: google.cloud.aiplatform.v1beta1.ExportModelResponse
+- name: google.cloud.aiplatform.v1beta1.ExportPublisherModelOperationMetadata
+- name: google.cloud.aiplatform.v1beta1.ExportPublisherModelResponse
 - name: google.cloud.aiplatform.v1beta1.Feature
 - name: google.cloud.aiplatform.v1beta1.FeatureGroup
 - name: google.cloud.aiplatform.v1beta1.FeatureOnlineStore
diff --git a/google/cloud/aiplatform/v1beta1/model_garden_service.proto b/google/cloud/aiplatform/v1beta1/model_garden_service.proto
@@ -20,6 +20,7 @@ import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.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/operation.proto";
@@ -82,6 +83,19 @@ service ModelGardenService {
       metadata_type: "DeployPublisherModelOperationMetadata"
     };
   }
+
+  // Exports a publisher model to a user provided Google Cloud Storage bucket.
+  rpc ExportPublisherModel(ExportPublisherModelRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta1/{parent=projects/*/locations/*}/{name=publishers/*/models/*}:export"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "ExportPublisherModelResponse"
+      metadata_type: "ExportPublisherModelOperationMetadata"
+    };
+  }
 }
 
 // View enumeration of PublisherModel.
@@ -414,6 +428,9 @@ message DeployOperationMetadata {
 
   // Output only. The project number where the deploy model request is sent.
   int64 project_number = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The model id to be used at query time.
+  string model_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Runtime operation information for
@@ -447,3 +464,44 @@ message DeployPublisherModelOperationMetadata {
   // Output only. The project number where the deploy model request is sent.
   int64 project_number = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
+
+// Response message for
+// [ModelGardenService.ExportPublisherModel][google.cloud.aiplatform.v1beta1.ModelGardenService.ExportPublisherModel].
+message ExportPublisherModelResponse {
+  // The name of the PublisherModel resource.
+  // Format:
+  // `publishers/{publisher}/models/{publisher_model}@{version_id}`
+  string publisher_model = 1;
+
+  // The destination uri of the model weights.
+  string destination_uri = 2;
+}
+
+// Runtime operation information for
+// [ModelGardenService.ExportPublisherModel][google.cloud.aiplatform.v1beta1.ModelGardenService.ExportPublisherModel].
+message ExportPublisherModelOperationMetadata {
+  // The operation generic information.
+  GenericOperationMetadata generic_metadata = 1;
+}
+
+// Request message for
+// [ModelGardenService.ExportPublisherModel][google.cloud.aiplatform.v1beta1.ModelGardenService.ExportPublisherModel].
+message ExportPublisherModelRequest {
+  // Required. The name of the PublisherModel resource.
+  // Format:
+  // `publishers/{publisher}/models/{publisher_model}@{version_id}`, or
+  // `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The target where we are exporting the model weights to
+  GcsDestination destination = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The Location to export the model weights from
+  // Format: `projects/{project}/locations/{location}`
+  string parent = 3 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "locations.googleapis.com/Location"
+    }
+  ];
+}
