feat: add RagEngineConfig update/get APIs to v1

Google APIs · copybara-github · commit d04f530e3d5d · 2025-06-16T14:33:17.000-07:00
feat: add Unprovisioned tier to RagEngineConfig to disable RagEngine service and delete all data within the service.

PiperOrigin-RevId: 772174333
diff --git a/google/cloud/aiplatform/v1/vertex_rag_data.proto b/google/cloud/aiplatform/v1/vertex_rag_data.proto
@@ -513,3 +513,59 @@ message ImportRagFilesConfig {
   // Default is false, i.e., index is not rebuilt.
   bool rebuild_ann_index = 19;
 }
+
+// Configuration message for RagManagedDb used by RagEngine.
+message RagManagedDbConfig {
+  // Scaled tier offers production grade performance along with
+  // autoscaling functionality. It is suitable for customers with large
+  // amounts of data or performance sensitive workloads.
+  message Scaled {}
+
+  // Basic tier is a cost-effective and low compute tier suitable for
+  // the following cases:
+  // * Experimenting with RagManagedDb.
+  // * Small data size.
+  // * Latency insensitive workload.
+  // * Only using RAG Engine with external vector DBs.
+  //
+  // NOTE: This is the default tier if not explicitly chosen.
+  message Basic {}
+
+  // Disables the RAG Engine service and deletes all your data held
+  // within this service. This will halt the billing of the service.
+  //
+  // NOTE: Once deleted the data cannot be recovered. To start using
+  // RAG Engine again, you will need to update the tier by calling the
+  // UpdateRagEngineConfig API.
+  message Unprovisioned {}
+
+  // The tier of the RagManagedDb.
+  oneof tier {
+    // Sets the RagManagedDb to the Scaled tier.
+    Scaled scaled = 4;
+
+    // Sets the RagManagedDb to the Basic tier.
+    Basic basic = 2;
+
+    // Sets the RagManagedDb to the Unprovisioned tier.
+    Unprovisioned unprovisioned = 3;
+  }
+}
+
+// Config for RagEngine.
+message RagEngineConfig {
+  option (google.api.resource) = {
+    type: "aiplatform.googleapis.com/RagEngineConfig"
+    pattern: "projects/{project}/locations/{location}/ragEngineConfig"
+    plural: "ragEngineConfigs"
+    singular: "ragEngineConfig"
+  };
+
+  // Identifier. The name of the RagEngineConfig.
+  // Format:
+  // `projects/{project}/locations/{location}/ragEngineConfig`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // The config of the RagManagedDb used by RagEngine.
+  RagManagedDbConfig rag_managed_db_config = 2;
+}
diff --git a/google/cloud/aiplatform/v1/vertex_rag_data_service.proto b/google/cloud/aiplatform/v1/vertex_rag_data_service.proto
@@ -149,6 +149,28 @@ service VertexRagDataService {
       metadata_type: "DeleteOperationMetadata"
     };
   }
+
+  // Updates a RagEngineConfig.
+  rpc UpdateRagEngineConfig(UpdateRagEngineConfigRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      patch: "/v1/{rag_engine_config.name=projects/*/locations/*/ragEngineConfig}"
+      body: "rag_engine_config"
+    };
+    option (google.api.method_signature) = "rag_engine_config";
+    option (google.longrunning.operation_info) = {
+      response_type: "RagEngineConfig"
+      metadata_type: "UpdateRagEngineConfigOperationMetadata"
+    };
+  }
+
+  // Gets a RagEngineConfig.
+  rpc GetRagEngineConfig(GetRagEngineConfigRequest) returns (RagEngineConfig) {
+    option (google.api.http) = {
+      get: "/v1/{name=projects/*/locations/*/ragEngineConfig}"
+    };
+    option (google.api.method_signature) = "name";
+  }
 }
 
 // Request message for
@@ -388,6 +410,20 @@ message CreateRagCorpusOperationMetadata {
   GenericOperationMetadata generic_metadata = 1;
 }
 
+// Request message for
+// [VertexRagDataService.GetRagEngineConfig][google.cloud.aiplatform.v1.VertexRagDataService.GetRagEngineConfig]
+message GetRagEngineConfigRequest {
+  // Required. The name of the RagEngineConfig resource.
+  // Format:
+  // `projects/{project}/locations/{location}/ragEngineConfig`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/RagEngineConfig"
+    }
+  ];
+}
+
 // Request message for
 // [VertexRagDataService.UpdateRagCorpus][google.cloud.aiplatform.v1.VertexRagDataService.UpdateRagCorpus].
 message UpdateRagCorpusRequest {
@@ -420,3 +456,21 @@ message ImportRagFilesOperationMetadata {
   //    progress_percentage = 100 * (successes + failures + skips) / total
   int32 progress_percentage = 4;
 }
+
+// Request message for
+// [VertexRagDataService.UpdateRagEngineConfig][google.cloud.aiplatform.v1.VertexRagDataService.UpdateRagEngineConfig].
+message UpdateRagEngineConfigRequest {
+  // Required. The updated RagEngineConfig.
+  //
+  // NOTE: Downgrading your RagManagedDb's ComputeTier could temporarily
+  // increase request latencies until the operation is fully complete.
+  RagEngineConfig rag_engine_config = 1
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Runtime operation information for
+// [VertexRagDataService.UpdateRagEngineConfig][google.cloud.aiplatform.v1.VertexRagDataService.UpdateRagEngineConfig].
+message UpdateRagEngineConfigOperationMetadata {
+  // The operation generic information.
+  GenericOperationMetadata generic_metadata = 1;
+}
