feat: add ImportIndex to IndexService

Google APIs · copybara-github · commit d5cdff26c8dc · 2025-05-23T14:33:58.000-07:00
PiperOrigin-RevId: 762570246
diff --git a/google/cloud/aiplatform/v1beta1/index_service.proto b/google/cloud/aiplatform/v1beta1/index_service.proto
@@ -61,6 +61,18 @@ service IndexService {
     option (google.api.method_signature) = "name";
   }
 
+  // Imports an Index from an external source (e.g., BigQuery).
+  rpc ImportIndex(ImportIndexRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta1/{name=projects/*/locations/*/indexes/*}:import"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "Index"
+      metadata_type: "ImportIndexOperationMetadata"
+    };
+  }
+
   // Lists Indexes in a Location.
   rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse) {
     option (google.api.http) = {
@@ -223,6 +235,117 @@ message UpdateIndexOperationMetadata {
       nearest_neighbor_search_operation_metadata = 2;
 }
 
+// Request message for
+// [IndexService.ImportIndex][google.cloud.aiplatform.v1beta1.IndexService.ImportIndex].
+message ImportIndexRequest {
+  // Configuration for importing data from an external source.
+  message ConnectorConfig {
+    // Mapping of datapoint fields to column names for columnar data sources.
+    message DatapointFieldMapping {
+      // Restrictions on string values.
+      message Restrict {
+        // Required. The namespace of the restrict in the index.
+        string namespace = 1 [(google.api.field_behavior) = REQUIRED];
+
+        // Optional. The columns containing the allow values.
+        repeated string allow_column = 2
+            [(google.api.field_behavior) = OPTIONAL];
+
+        // Optional. The columns containing the deny values.
+        repeated string deny_column = 3
+            [(google.api.field_behavior) = OPTIONAL];
+      }
+
+      // Restrictions on numeric values.
+      message NumericRestrict {
+        // The type of numeric value for the restrict.
+        enum ValueType {
+          // Should not be used.
+          VALUE_TYPE_UNSPECIFIED = 0;
+
+          // Represents 64 bit integer.
+          INT = 1;
+
+          // Represents 32 bit float.
+          FLOAT = 2;
+
+          // Represents 64 bit float.
+          DOUBLE = 3;
+        }
+
+        // Required. The namespace of the restrict.
+        string namespace = 1 [(google.api.field_behavior) = REQUIRED];
+
+        // Optional. The column containing the numeric value.
+        string value_column = 2 [(google.api.field_behavior) = OPTIONAL];
+
+        // Required. Numeric type of the restrict. Must be consistent for
+        // all datapoints within the namespace.
+        ValueType value_type = 3 [(google.api.field_behavior) = REQUIRED];
+      }
+
+      // Required. The column with unique identifiers for each data point.
+      string id_column = 1 [(google.api.field_behavior) = REQUIRED];
+
+      // Required. The column with the vector embeddings for each data point.
+      string embedding_column = 2 [(google.api.field_behavior) = REQUIRED];
+
+      // Optional. List of restricts for string values.
+      repeated Restrict restricts = 3 [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. List of restricts for numeric values.
+      repeated NumericRestrict numeric_restricts = 4
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. List of columns containing metadata to be included in the
+      // index.
+      repeated string metadata_columns = 5
+          [(google.api.field_behavior) = OPTIONAL];
+    }
+
+    // Configuration for importing data from a BigQuery table.
+    message BigQuerySourceConfig {
+      // Required. The path to the BigQuery table containing the index data, in
+      // the format of `bq://<project_id>.<dataset_id>.<table>`.
+      string table_path = 1 [(google.api.field_behavior) = REQUIRED];
+
+      // Required. Mapping of datapoint fields to BigQuery column names.
+      DatapointFieldMapping datapoint_field_mapping = 2
+          [(google.api.field_behavior) = REQUIRED];
+    }
+
+    // The source of the data to import.
+    oneof source {
+      // Configuration for importing data from a BigQuery table.
+      BigQuerySourceConfig big_query_source_config = 1;
+    }
+  }
+
+  // Required. The name of the Index resource to import data to.
+  // Format:
+  // `projects/{project}/locations/{location}/indexes/{index}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/Index"
+    }
+  ];
+
+  // Optional. If true, completely replace existing index data. Must be true for
+  // streaming update indexes.
+  bool is_complete_overwrite = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Required. Configuration for importing data from an external source.
+  ConnectorConfig config = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Runtime operation information for
+// [IndexService.ImportIndex][google.cloud.aiplatform.v1beta1.IndexService.ImportIndex].
+message ImportIndexOperationMetadata {
+  // The operation generic information.
+  GenericOperationMetadata generic_metadata = 1;
+}
+
 // Request message for
 // [IndexService.DeleteIndex][google.cloud.aiplatform.v1beta1.IndexService.DeleteIndex].
 message DeleteIndexRequest {
@@ -348,6 +471,12 @@ message NearestNeighborSearchOperationMetadata {
 
       // Invalid dense embedding.
       INVALID_EMBEDDING = 17;
+
+      // Invalid embedding metadata.
+      INVALID_EMBEDDING_METADATA = 18;
+
+      // Embedding metadata exceeds size limit.
+      EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT = 19;
     }
 
     // The error type of this record.
