@google-cloud/discoveryengine 1.7.0 → 1.9.0

package/build/protos/google/cloud/discoveryengine/v1beta/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.v1beta.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.v1beta.Document]s to be
@@ -204,7 +204,7 @@ message ListDocumentsRequest {
 
   // Maximum number of [Document][google.cloud.discoveryengine.v1beta.Document]s
   // to return. If unspecified, defaults to 100. The maximum allowed value is
-  // 1000. Values above 1000 will be coerced to 1000.
+  // 1000. Values above 1000 are set to 1000.
   //
   // If this field is negative, an `INVALID_ARGUMENT` error is returned.
   int32 page_size = 2;
@@ -254,8 +254,8 @@ message CreateDocumentRequest {
   Document document = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The ID to use for the
-  // [Document][google.cloud.discoveryengine.v1beta.Document], which will become
-  // the final component of the
+  // [Document][google.cloud.discoveryengine.v1beta.Document], which becomes the
+  // final component of the
   // [Document.name][google.cloud.discoveryengine.v1beta.Document.name].
   //
   // If the caller does not have permission to create the
@@ -289,14 +289,13 @@ 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.v1beta.Document] is not found, a
-  // new [Document][google.cloud.discoveryengine.v1beta.Document] will be
-  // created.
+  // new [Document][google.cloud.discoveryengine.v1beta.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;
 }
 

package/build/protos/google/cloud/discoveryengine/v1beta/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.
@@ -118,9 +118,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 Chat Engine.
@@ -212,7 +212,7 @@ message Engine {
   // The restriction of the Engine industry vertical is based on
   // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
   // default to `GENERIC`. Vertical on Engine has to match vertical of the
-  // DataStore liniked to the engine.
+  // 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/v1beta/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/v1beta/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.v1beta.CheckGroundingResponse.Claim.citation_indices],
+    // and
+    // [anti_citation_indices][google.cloud.discoveryengine.v1beta.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/v1beta/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/v1beta/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::V1beta";
 
 // 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.v1beta.UserEvent] per line.
@@ -337,8 +337,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/v1beta/project.proto

@@ -0,0 +1,103 @@
+// 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.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "ProjectProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Metadata and configurations for a Google Cloud project in the service.
+message Project {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Project"
+    pattern: "projects/{project}"
+  };
+
+  // Metadata about the terms of service.
+  message ServiceTerms {
+    // The agreement states this terms of service.
+    enum State {
+      // The default value of the enum. This value is not actually used.
+      STATE_UNSPECIFIED = 0;
+
+      // The project has given consent to the terms of service.
+      TERMS_ACCEPTED = 1;
+
+      // The project is pending to review and accept the terms of service.
+      TERMS_PENDING = 2;
+
+      // The project has declined or revoked the agreement to terms of service.
+      TERMS_DECLINED = 3;
+    }
+
+    // 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
+    // [version][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.version]
+    // to provide is `2022-11-23`.
+    string id = 1;
+
+    // The version string of the terms of service.
+    // For acceptable values, see the comments for
+    // [id][google.cloud.discoveryengine.v1beta.Project.ServiceTerms.id] above.
+    string version = 2;
+
+    // Whether the project has accepted/rejected the service terms or it is
+    // still pending.
+    State state = 4;
+
+    // The last time when the project agreed to the terms of service.
+    google.protobuf.Timestamp accept_time = 5;
+
+    // The last time when the project declined or revoked the agreement to terms
+    // of service.
+    google.protobuf.Timestamp decline_time = 6;
+  }
+
+  // Output only. Full resource name of the project, for example
+  // `projects/{project_number}`.
+  // Note that when making requests, project number and project id are both
+  // acceptable, but the server will always respond in project number.
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The timestamp when this project is created.
+  google.protobuf.Timestamp create_time = 2
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The timestamp when this project is successfully provisioned.
+  // Empty value means this project is still provisioning and is not ready for
+  // use.
+  google.protobuf.Timestamp provision_completion_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. A map of terms of services. The key is the `id` of
+  // [ServiceTerms][google.cloud.discoveryengine.v1beta.Project.ServiceTerms].
+  map<string, ServiceTerms> service_terms_map = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}

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

@@ -0,0 +1,90 @@
+// 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.v1beta;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1beta/project.proto";
+import "google/longrunning/operations.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "ProjectServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Service for operations on the
+// [Project][google.cloud.discoveryengine.v1beta.Project].
+service ProjectService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Provisions the project resource. During the
+  // process, related systems will get prepared and initialized.
+  //
+  // Caller must read the [Terms for data
+  // use](https://cloud.google.com/retail/data-use-terms), and optionally
+  // specify in request to provide consent to that service terms.
+  rpc ProvisionProject(ProvisionProjectRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{name=projects/*}:provision"
+      body: "*"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.Project"
+      metadata_type: "google.cloud.discoveryengine.v1beta.ProvisionProjectMetadata"
+    };
+  }
+}
+
+// Request for
+// [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1beta.ProjectService.ProvisionProject]
+// method.
+message ProvisionProjectRequest {
+  // Required. Full resource name of a
+  // [Project][google.cloud.discoveryengine.v1beta.Project], such as
+  // `projects/{project_id_or_number}`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Project"
+    }
+  ];
+
+  // Required. Set to `true` to specify that caller has read and would like to
+  // give consent to the [Terms for data
+  // use](https://cloud.google.com/retail/data-use-terms).
+  bool accept_data_use_terms = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The version of the [Terms for data
+  // use](https://cloud.google.com/retail/data-use-terms) that caller has read
+  // and would like to give consent to.
+  //
+  // Acceptable version is `2022-11-23`, and this may change over time.
+  string data_use_terms_version = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Metadata associated with a project provision operation.
+message ProvisionProjectMetadata {}

package/build/protos/google/cloud/discoveryengine/v1beta/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/v1beta/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/v1beta/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.v1beta.RecommendRequest.params]
   // to receive empty results instead.
   //
-  // Note that the API will never return
+  // Note that the API never returns
   // [Document][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.RecommendRequest.params].
     Document document = 2;
 
-    // Additional Document metadata / annotations.
+    // Additional Document metadata or annotations.
     //
     // Possible values:
     //

package/build/protos/google/cloud/discoveryengine/v1beta/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.

package/build/protos/google/cloud/discoveryengine/v1beta/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.
@@ -142,9 +142,9 @@ message ListSchemasRequest {
   // to return. The service may return fewer than this value.
   //
   // If unspecified, at most 100
-  // [Schema][google.cloud.discoveryengine.v1beta.Schema]s will be returned.
+  // [Schema][google.cloud.discoveryengine.v1beta.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
@@ -189,7 +189,7 @@ message CreateSchemaRequest {
   Schema schema = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The ID to use for the
-  // [Schema][google.cloud.discoveryengine.v1beta.Schema], which will become the
+  // [Schema][google.cloud.discoveryengine.v1beta.Schema], which becomes the
   // final component of the
   // [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name].
   //
@@ -209,8 +209,8 @@ message UpdateSchemaRequest {
 
   // If set to true, and the
   // [Schema][google.cloud.discoveryengine.v1beta.Schema] is not found, a new
-  // [Schema][google.cloud.discoveryengine.v1beta.Schema] will be created. In
-  // this situation, `update_mask` is ignored.
+  // [Schema][google.cloud.discoveryengine.v1beta.Schema] is created. In this
+  // situation, `update_mask` is ignored.
   bool allow_missing = 3;
 }