@google-cloud/discoveryengine 1.7.0 → 1.9.0

package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto

@@ -0,0 +1,87 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.discoveryengine.v1alpha;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "CustomTuningModelProto";
+option java_package = "com.google.cloud.discoveryengine.v1alpha";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
+
+// Metadata that describes a custom tuned model.
+message CustomTuningModel {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/CustomTuningModel"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}"
+  };
+
+  // The state of the model.
+  enum ModelState {
+    // Default value.
+    MODEL_STATE_UNSPECIFIED = 0;
+
+    // The model is in a paused training state.
+    TRAINING_PAUSED = 1;
+
+    // The model is currently training.
+    TRAINING = 2;
+
+    // The model has successfully completed training.
+    TRAINING_COMPLETE = 3;
+
+    // The model is ready for serving.
+    READY_FOR_SERVING = 4;
+
+    // The model training failed.
+    TRAINING_FAILED = 5;
+  }
+
+  // Required. The fully qualified resource name of the model.
+  //
+  // Format:
+  // `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
+  // model must be an alpha-numerical string with limit of 40 characters.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/CustomTuningModel"
+    }
+  ];
+
+  // The display name of the model.
+  string display_name = 2;
+
+  // The version of the model.
+  int64 model_version = 3;
+
+  // The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
+  ModelState model_state = 4;
+
+  // Timestamp the Model was created at.
+  google.protobuf.Timestamp create_time = 5;
+
+  // Timestamp the model training was initiated.
+  google.protobuf.Timestamp training_start_time = 6;
+}

package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -265,8 +265,8 @@ message ListDataStoresRequest {
   // INVALID_ARGUMENT error is returned.
   string page_token = 3;
 
-  // Filter by solution type. For example: filter =
-  // 'solution_type:SOLUTION_TYPE_SEARCH'
+  // Filter by solution type.
+  // For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
   string filter = 4;
 }
 

package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -114,6 +114,7 @@ message DocumentProcessingConfig {
 
   // Map from file type to override the default parsing configuration based on
   // the file type. Supported keys:
+  //
   // * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
   // parsing or layout parsing is supported.
   // * `html`: Override parsing config for HTML files, only digital parsing and

package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -105,7 +105,7 @@ service DocumentService {
 
   // Bulk import of multiple
   // [Document][google.cloud.discoveryengine.v1alpha.Document]s. Request
-  // processing may be synchronous. Non-existing items will be created.
+  // processing may be synchronous. Non-existing items are created.
   //
   // Note: It is possible for a subset of the
   // [Document][google.cloud.discoveryengine.v1alpha.Document]s to be
@@ -218,7 +218,7 @@ message ListDocumentsRequest {
   // Maximum number of
   // [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. If
   // unspecified, defaults to 100. The maximum allowed value is 1000. Values
-  // above 1000 will be coerced to 1000.
+  // above 1000 are set to 1000.
   //
   // If this field is negative, an `INVALID_ARGUMENT` error is returned.
   int32 page_size = 2;
@@ -268,8 +268,8 @@ message CreateDocumentRequest {
   Document document = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The ID to use for the
-  // [Document][google.cloud.discoveryengine.v1alpha.Document], which will
-  // become the final component of the
+  // [Document][google.cloud.discoveryengine.v1alpha.Document], which becomes
+  // the final component of the
   // [Document.name][google.cloud.discoveryengine.v1alpha.Document.name].
   //
   // If the caller does not have permission to create the
@@ -303,14 +303,14 @@ message UpdateDocumentRequest {
   // is not set, a `NOT_FOUND` error is returned.
   Document document = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // If set to true, and the
+  // If set to `true` and the
   // [Document][google.cloud.discoveryengine.v1alpha.Document] is not found, a
-  // new [Document][google.cloud.discoveryengine.v1alpha.Document] will be
+  // new [Document][google.cloud.discoveryengine.v1alpha.Document] is be
   // created.
   bool allow_missing = 2;
 
   // Indicates which fields in the provided imported 'document' to update. If
-  // not set, will by default update all fields.
+  // not set, by default updates all fields.
   google.protobuf.FieldMask update_mask = 3;
 }
 
@@ -348,8 +348,11 @@ message GetProcessedDocumentRequest {
     // Available for all data store parsing configs.
     PARSED_DOCUMENT = 1;
 
-    // Only available if ChunkingConfig is enabeld on the data store.
+    // Only available if ChunkingConfig is enabled on the data store.
     CHUNKED_DOCUMENT = 2;
+
+    // Returns the converted PNG Image bytes if available.
+    PNG_CONVERTED_DOCUMENT = 3;
   }
 
   // The format of the returned processed document. If unspecified, defaults to
@@ -358,7 +361,7 @@ message GetProcessedDocumentRequest {
     // Default value.
     PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED = 0;
 
-    // output format will be a JSON string representation of processed document.
+    // Output format is a JSON string representation of processed document.
     JSON = 1;
   }
 

package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -193,9 +193,9 @@ message Engine {
 
   // Common configurations for an Engine.
   message CommonConfig {
-    // Immutable. The name of the company, business or entity that is associated
-    // with the engine. Setting this may help improve LLM related features.
-    string company_name = 1 [(google.api.field_behavior) = IMMUTABLE];
+    // The name of the company, business or entity that is associated with the
+    // engine. Setting this may help improve LLM related features.
+    string company_name = 1;
   }
 
   // Additional information of a recommendation engine.
@@ -367,7 +367,7 @@ message Engine {
   // The restriction of the Engine industry vertical is based on
   // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore]: If
   // unspecified, default to `GENERIC`. Vertical on Engine has to match vertical
-  // of the DataStore liniked to the engine.
+  // of the DataStore linked to the engine.
   IndustryVertical industry_vertical = 16;
 
   // Common config spec that specifies the metadata of the engine.

package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -69,7 +69,7 @@ message CheckGroundingRequest {
     }
   ];
 
-  // Answer candidate to check.
+  // Answer candidate to check. Can have a maximum length of 1024 characters.
   string answer_candidate = 2;
 
   // List of facts for the grounding check.
@@ -78,6 +78,25 @@ message CheckGroundingRequest {
 
   // Configuration of the grounding check.
   CheckGroundingSpec grounding_spec = 4;
+
+  // The user labels applied to a resource must meet the following requirements:
+  //
+  // * Each resource can have multiple labels, up to a maximum of 64.
+  // * Each label must be a key-value pair.
+  // * Keys have a minimum length of 1 character and a maximum length of 63
+  //   characters and cannot be empty. Values can be empty and have a maximum
+  //   length of 63 characters.
+  // * Keys and values can contain only lowercase letters, numeric characters,
+  //   underscores, and dashes. All characters must use UTF-8 encoding, and
+  //   international characters are allowed.
+  // * The key portion of a label must be unique. However, you can use the same
+  //   key with multiple resources.
+  // * Keys must start with a lowercase letter or international character.
+  //
+  // See [Google Cloud
+  // Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+  // for more details.
+  map<string, string> user_labels = 5;
 }
 
 // Response message for the
@@ -104,6 +123,16 @@ message CheckGroundingResponse {
     // supporting for the claim. A citation to a fact indicates that the claim
     // is supported by the fact.
     repeated int32 citation_indices = 4;
+
+    // Indicates that this claim required grounding check. When the system
+    // decided this claim doesn't require attribution/grounding check, this
+    // field will be set to false. In that case, no grounding check was done for
+    // the claim and therefore
+    // [citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.citation_indices],
+    // and
+    // [anti_citation_indices][google.cloud.discoveryengine.v1alpha.CheckGroundingResponse.Claim.anti_citation_indices]
+    // should not be returned.
+    optional bool grounding_check_required = 6;
   }
 
   // The support score for the input answer candidate.

package/build/protos/google/cloud/discoveryengine/v1alpha/grounding.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -50,6 +50,9 @@ message FactChunk {
   // retrieved.
   string source = 2;
 
+  // The index of this chunk. Currently, only used for the streaming mode.
+  int32 index = 4;
+
   // More fine-grained information for the source reference.
   map<string, string> source_metadata = 3;
 }

package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -37,7 +37,7 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
 
 // Cloud Storage location for input content.
 message GcsSource {
-  // Required. Cloud Storage URIs to input files. URI can be up to
+  // Required. Cloud Storage URIs to input files. Each URI can be up to
   // 2000 characters long. URIs can match the full object path (for example,
   // `gs://bucket/directory/object.json`) or a pattern matching one or more
   // files, such as `gs://bucket/directory/*.json`.
@@ -67,7 +67,7 @@ message GcsSource {
   //   data store. Each entry after the header is imported as a Document.
   //   This can only be used by the GENERIC Data Store vertical.
   //
-  // Supported values for user even imports:
+  // Supported values for user event imports:
   //
   // * `user_event` (default): One JSON
   // [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] per line.
@@ -338,8 +338,8 @@ message FirestoreSource {
   // of 256 characters.
   string database_id = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The Firestore collection to copy the data from with a length
-  // limit of 1,500 characters.
+  // Required. The Firestore collection (or entity) to copy the data from with a
+  // length limit of 1,500 characters.
   string collection_id = 3 [(google.api.field_behavior) = REQUIRED];
 
   // Intermediate Cloud Storage directory used for the import with a length

package/build/protos/google/cloud/discoveryengine/v1alpha/project.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -55,6 +55,7 @@ message Project {
 
     // The unique identifier of this terms of service.
     // Available terms:
+    //
     // * `GA_DATA_USE_TERMS`: [Terms for data
     // use](https://cloud.google.com/retail/data-use-terms). When using this as
     // `id`, the acceptable

package/build/protos/google/cloud/discoveryengine/v1alpha/project_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -72,6 +72,7 @@ service ProjectService {
   // This method can be used to retroactively accept the latest terms.
   //
   // Terms available for update:
+  //
   // * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
   rpc ReportConsentChange(ReportConsentChangeRequest) returns (Project) {
     option (google.api.http) = {
@@ -159,6 +160,7 @@ message ReportConsentChangeRequest {
 
   // Required. The unique identifier of the terms of service to update.
   // Available term ids:
+  //
   // * `GA_DATA_USE_TERMS`: [Terms for data
   // use](https://cloud.google.com/retail/data-use-terms). When using this
   // service term id, the acceptable

package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/protos/google/cloud/discoveryengine/v1alpha/rank_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -104,6 +104,25 @@ message RankRequest {
   // If true, the response will contain only record ID and score. By default, it
   // is false, the response will contain record details.
   bool ignore_record_details_in_response = 6;
+
+  // The user labels applied to a resource must meet the following requirements:
+  //
+  // * Each resource can have multiple labels, up to a maximum of 64.
+  // * Each label must be a key-value pair.
+  // * Keys have a minimum length of 1 character and a maximum length of 63
+  //   characters and cannot be empty. Values can be empty and have a maximum
+  //   length of 63 characters.
+  // * Keys and values can contain only lowercase letters, numeric characters,
+  //   underscores, and dashes. All characters must use UTF-8 encoding, and
+  //   international characters are allowed.
+  // * The key portion of a label must be unique. However, you can use the same
+  //   key with multiple resources.
+  // * Keys must start with a lowercase letter or international character.
+  //
+  // See [Google Cloud
+  // Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+  // for more details.
+  map<string, string> user_labels = 7;
 }
 
 // Response message for

package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -64,7 +64,7 @@ message RecommendRequest {
   // `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
   //
   // One default serving config is created along with your recommendation engine
-  // creation. The engine ID will be used as the ID of the default serving
+  // creation. The engine ID is used as the ID of the default serving
   // config. For example, for Engine
   // `projects/*/locations/global/collections/*/engines/my-engine`, you can use
   // `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
@@ -97,9 +97,9 @@ message RecommendRequest {
   UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Maximum number of results to return. Set this property
-  // to the number of recommendation results needed. If zero, the service will
-  // choose a reasonable default. The maximum allowed value is 100. Values
-  // above 100 will be coerced to 100.
+  // to the number of recommendation results needed. If zero, the service
+  // chooses a reasonable default. The maximum allowed value is 100. Values
+  // above 100 are set to 100.
   int32 page_size = 3;
 
   // Filter for restricting recommendation results with a length limit of 5,000
@@ -120,19 +120,19 @@ message RecommendRequest {
   //  * (available: true) AND
   //    (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
   //
-  // If your filter blocks all results, the API will return generic
+  // If your filter blocks all results, the API returns generic
   // (unfiltered) popular Documents. If you only want results strictly matching
-  // the filters, set `strictFiltering` to True in
+  // the filters, set `strictFiltering` to `true` in
   // [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params]
   // to receive empty results instead.
   //
-  // Note that the API will never return
+  // Note that the API never returns
   // [Document][google.cloud.discoveryengine.v1alpha.Document]s with
-  // `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
+  // `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
   string filter = 4;
 
-  // Use validate only mode for this recommendation query. If set to true, a
-  // fake model will be used that returns arbitrary Document IDs.
+  // Use validate only mode for this recommendation query. If set to `true`, a
+  // fake model is used that returns arbitrary Document IDs.
   // Note that the validate only mode should only be used for testing the API,
   // or if the model is not ready.
   bool validate_only = 5;
@@ -141,16 +141,17 @@ message RecommendRequest {
   //
   // Allowed values:
   //
-  // * `returnDocument`: Boolean. If set to true, the associated Document
-  //    object will be returned in
+  // * `returnDocument`: Boolean. If set to `true`, the associated Document
+  //    object is returned in
   //    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.document].
-  // * `returnScore`: Boolean. If set to true, the recommendation 'score'
-  //    corresponding to each returned Document will be set in
+  // * `returnScore`: Boolean. If set to true, the recommendation score
+  //    corresponding to each returned Document is set in
   //    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.metadata].
-  //    The given 'score' indicates the probability of a Document conversion
-  //    given the user's context and history.
-  // * `strictFiltering`: Boolean. True by default. If set to false, the service
-  //    will return generic (unfiltered) popular Documents instead of empty if
+  //    The given score indicates the probability of a Document conversion given
+  //    the user's context and history.
+  // * `strictFiltering`: Boolean. True by default. If set to `false`, the
+  // service
+  //    returns generic (unfiltered) popular Documents instead of empty if
   //    your filter blocks all recommendation results.
   // * `diversityLevel`: String. Default empty. If set to be non-empty, then
   //    it needs to be one of:
@@ -198,7 +199,7 @@ message RecommendResponse {
     // [RecommendRequest.params][google.cloud.discoveryengine.v1alpha.RecommendRequest.params].
     Document document = 2;
 
-    // Additional Document metadata / annotations.
+    // Additional Document metadata or annotations.
     //
     // Possible values:
     //

package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -84,10 +84,28 @@ message FieldConfig {
     // Field value type is Boolean.
     BOOLEAN = 5;
 
-    // Field value type is Geolocation.
+    // Field value type is Geolocation. Geolocation is expressed as an object
+    // with the following keys:
+    //
+    // * `id`: a string representing the location id
+    // * `longitude`: a number representing the longitude coordinate of the
+    // location
+    // * `latitude`: a number repesenting the latitude coordinate of the
+    // location
+    // * `address`: a string representing the full address of the location
+    //
+    // `latitude` and `longitude` must always be provided together. At least one
+    // of a) `address` or b) `latitude`-`longitude` pair must be provided.
     GEOLOCATION = 6;
 
-    // Field value type is Datetime.
+    // Field value type is Datetime. Datetime can be expressed as either:
+    //
+    // * a number representing milliseconds-since-the-epoch
+    // * a string representing milliseconds-since-the-epoch. e.g.
+    // `"1420070400001"`
+    // * a string representing the [ISO
+    // 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g.
+    // `"2015-01-01"` or `"2015-01-01T12:10:30Z"`
     DATETIME = 7;
   }
 
@@ -173,6 +191,9 @@ message FieldConfig {
 
     // Retrieve value from page map.
     PAGEMAP = 2;
+
+    // Retrieve value from schema.org data.
+    SCHEMA_ORG = 4;
   }
 
   // Required. Field path of the schema field.
@@ -333,4 +354,18 @@ message FieldConfig {
   //  if this enum is set to METATAGS, we will only index `<author, a>`;
   //  if this enum is not set, we will merge them and index `<author, [a, b]>`.
   repeated AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;
+
+  // Field paths for indexing custom attribute from schema.org data. More
+  // details of schema.org and its defined types can be found at
+  // [schema.org](https://schema.org).
+  //
+  // It is only used on advanced site search schema.
+  //
+  // Currently only support full path from root. The full path to a field is
+  // constructed by concatenating field names, starting from `_root`, with
+  // a period `.` as the delimiter. Examples:
+  //
+  // * Publish date of the root: _root.datePublished
+  // * Publish date of the reviews: _root.review.datePublished
+  repeated string schema_org_paths = 11;
 }

package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -143,9 +143,9 @@ message ListSchemasRequest {
   // service may return fewer than this value.
   //
   // If unspecified, at most 100
-  // [Schema][google.cloud.discoveryengine.v1alpha.Schema]s will be returned.
+  // [Schema][google.cloud.discoveryengine.v1alpha.Schema]s are returned.
   //
-  // The maximum value is 1000; values above 1000 will be coerced to 1000.
+  // The maximum value is 1000; values above 1000 are set to 1000.
   int32 page_size = 2;
 
   // A page token, received from a previous
@@ -190,8 +190,8 @@ message CreateSchemaRequest {
   Schema schema = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The ID to use for the
-  // [Schema][google.cloud.discoveryengine.v1alpha.Schema], which will become
-  // the final component of the
+  // [Schema][google.cloud.discoveryengine.v1alpha.Schema], which becomes the
+  // final component of the
   // [Schema.name][google.cloud.discoveryengine.v1alpha.Schema.name].
   //
   // This field should conform to
@@ -210,8 +210,8 @@ message UpdateSchemaRequest {
 
   // If set to true, and the
   // [Schema][google.cloud.discoveryengine.v1alpha.Schema] is not found, a new
-  // [Schema][google.cloud.discoveryengine.v1alpha.Schema] will be created. In
-  // this situation, `update_mask` is ignored.
+  // [Schema][google.cloud.discoveryengine.v1alpha.Schema] is created. In this
+  // situation, `update_mask` is ignored.
   bool allow_missing = 3;
 }