googleapis
diff --git a/‎google/cloud/aiplatform/v1beta1/vertex_rag_data.proto‎
Lines changed: 177 additions & 3 deletions b/‎google/cloud/aiplatform/v1beta1/vertex_rag_data.proto‎
Lines changed: 177 additions & 3 deletions
@@ -668,10 +668,12 @@ message UploadRagFileConfig {
   // Specifies the transformation config for RagFiles.
   RagFileTransformationConfig rag_file_transformation_config = 3;
 
-  // Specifies the metadata config for RagFiles.
+  // Optional. Specifies the metadata config for RagFiles.
   // Including paths for metadata schema and metadata.
   // Alteratively, inline metadata schema and metadata can be provided.
-  RagFileMetadataConfig rag_file_metadata_config = 4;
+  // Deprecated: Not in use.
+  RagFileMetadataConfig rag_file_metadata_config = 4
+      [deprecated = true, (google.api.field_behavior) = OPTIONAL];
 
   // Optional. Specifies the parsing config for RagFiles.
   // RAG will use the default parser if this field is not set.
@@ -748,7 +750,8 @@ message ImportRagFilesConfig {
 
   // Specifies the metadata config for RagFiles.
   // Including paths for metadata schema and metadata.
-  RagFileMetadataConfig rag_file_metadata_config = 17;
+  // Deprecated: Not in use.
+  RagFileMetadataConfig rag_file_metadata_config = 17 [deprecated = true];
 
   // Optional. The max number of queries per minute that this job is allowed to
   // make to the embedding model specified on the corpus. This value is specific
@@ -875,3 +878,174 @@ message RagEngineConfig {
   // The config of the RagManagedDb used by RagEngine.
   RagManagedDbConfig rag_managed_db_config = 2;
 }
+
+// The schema of the user specified metadata.
+message RagDataSchema {
+  option (google.api.resource) = {
+    type: "aiplatform.googleapis.com/RagDataSchema"
+    pattern: "projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}"
+    plural: "ragDataSchemas"
+    singular: "ragDataSchema"
+  };
+
+  // Identifier. Resource name of the data schema in the form of:
+  // `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`
+  // where the {rag_data_schema} part should be the same as the `key` field
+  // below.
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Required. The key of this data schema. This key should be matching the key
+  // of user specified metadata and unique inside corpus. This value can be up
+  // to 63 characters, and valid characters are /[a-z][0-9]-/. The first
+  // character must be a letter, the last could be a letter or a number.
+  string key = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // The schema details mapping to the key.
+  RagMetadataSchemaDetails schema_details = 3;
+}
+
+// Data schema details indicates the data type and the data struct corresponding
+// to the key of user specified metadata.
+message RagMetadataSchemaDetails {
+  // Config for List data type.
+  message ListConfig {
+    // The value's data type in the list.
+    RagMetadataSchemaDetails value_schema = 1;
+  }
+
+  // The search strategy for the metadata value of the `key`.
+  message SearchStrategy {
+    // The types of search strategies to be applied on the metadata key.
+    enum SearchStrategyType {
+      // Unspecified search strategy type.
+      SEARCH_STRATEGY_TYPE_UNSPECIFIED = 0;
+
+      // metadata values of the `key` above will not be searchable.
+      NO_SEARCH = 1;
+
+      // When searching with `key`, the value must be exactly as the metadata
+      // value that has been ingested.
+      EXACT_SEARCH = 2;
+    }
+
+    // The search strategy type to be applied on the metadata key.
+    optional SearchStrategyType search_strategy_type = 1;
+  }
+
+  // Data type of the metadata.
+  enum DataType {
+    // Unspecified type.
+    DATA_TYPE_UNSPECIFIED = 0;
+
+    // Integer type.
+    INTEGER = 1;
+
+    // Float type.
+    FLOAT = 2;
+
+    // String type.
+    STRING = 3;
+
+    // Supported formats:
+    // %Y-%m-%dT%H:%M:%E*S%E*z (absl::RFC3339_full)
+    // %Y-%m-%dT%H:%M:%E*S
+    // %Y-%m-%dT%H:%M%E*z
+    // %Y-%m-%dT%H:%M
+    // %Y-%m-%dT%H%E*z
+    // %Y-%m-%dT%H
+    // %Y-%m-%d%E*z
+    // %Y-%m-%d
+    // %Y-%m
+    // %Y
+    DATETIME = 4;
+
+    // Boolean type.
+    BOOLEAN = 5;
+
+    // List type.
+    //  - Each element in the list must be of the exact same data schema;
+    //    otherwise, they are invalid arguments.
+    //  - Elements cannot be another list (no list of list).
+    LIST = 6;
+  }
+
+  // The granularity of metadata under this DataSchema.
+  enum Granularity {
+    // Unspecified granularity.
+    GRANULARITY_UNSPECIFIED = 0;
+
+    // RagFile-level granularity.
+    GRANULARITY_FILE_LEVEL = 1;
+  }
+
+  // Type of the metadata.
+  optional DataType type = 1;
+
+  // Config for List data type.
+  ListConfig list_config = 2;
+
+  // The granularity associated with this RagMetadataSchema.
+  optional Granularity granularity = 3;
+
+  // The search strategy for the metadata value of the `key`.
+  optional SearchStrategy search_strategy = 4;
+}
+
+// Metadata for RagFile provided by users.
+message RagMetadata {
+  option (google.api.resource) = {
+    type: "aiplatform.googleapis.com/RagMetadata"
+    pattern: "projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}"
+    plural: "ragMetadata"
+    singular: "ragMetadata"
+  };
+
+  // Identifier. Resource name of the RagMetadata.
+  // Format:
+  // `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // User provided metadata.
+  UserSpecifiedMetadata user_specified_metadata = 2;
+}
+
+// Metadata provided by users.
+message UserSpecifiedMetadata {
+  // Required. Key of the metadata. The key must be set with type by
+  // CreateRagDataSchema.
+  string key = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Value of the metadata. The value must be able to convert
+  // to the type according to the data schema.
+  MetadataValue value = 2;
+}
+
+// Value of Metadata, including all types available in data schema.
+message MetadataValue {
+  // The value of the metadata.
+  oneof value {
+    // Value of int type metadata.
+    int64 int_value = 1;
+
+    // Value of float type metadata.
+    float float_value = 2;
+
+    // Value of string type metadata.
+    string str_value = 3;
+
+    // Value of date time type metadata.
+    string datetime_value = 4;
+
+    // Value of boolean type metadata.
+    bool bool_value = 5;
+
+    // Value of list type metadata.
+    MetadataList list_value = 6;
+  }
+}
+
+// List representation in metadata.
+message MetadataList {
+  // The values of `LIST` data type metadata.
+  repeated MetadataValue values = 1;
+}