@google-cloud/discoveryengine 1.6.0 → 1.7.0

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

@@ -0,0 +1,102 @@
+// Copyright 2022 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 = "ProjectProto";
+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 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.v1alpha.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.v1alpha.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.v1alpha.Project.ServiceTerms].
+  map<string, ServiceTerms> service_terms_map = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}

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

@@ -0,0 +1,171 @@
+// Copyright 2022 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/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1alpha/project.proto";
+import "google/longrunning/operations.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 = "ProjectServiceProto";
+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";
+
+// Service for operations on the
+// [Project][google.cloud.discoveryengine.v1alpha.Project].
+service ProjectService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Gets a [Project][google.cloud.discoveryengine.v1alpha.Project].
+  // Returns NOT_FOUND when the project is not yet created.
+  rpc GetProject(GetProjectRequest) returns (Project) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=projects/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // 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: "/v1alpha/{name=projects/*}:provision"
+      body: "*"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1alpha.Project"
+      metadata_type: "google.cloud.discoveryengine.v1alpha.ProvisionProjectMetadata"
+    };
+  }
+
+  // Updates service terms for this project.
+  //
+  // 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) = {
+      post: "/v1alpha/{project=projects/*}:reportConsentChange"
+      body: "*"
+    };
+    option (google.api.method_signature) =
+        "consent_change_action,project,service_term_id,service_term_version";
+  }
+}
+
+// Request message for
+// [ProjectService.GetProject][google.cloud.discoveryengine.v1alpha.ProjectService.GetProject]
+// method.
+message GetProjectRequest {
+  // Required. Full resource name of a
+  // [Project][google.cloud.discoveryengine.v1alpha.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"
+    }
+  ];
+}
+
+// Request for
+// [ProjectService.ProvisionProject][google.cloud.discoveryengine.v1alpha.ProjectService.ProvisionProject]
+// method.
+message ProvisionProjectRequest {
+  // Required. Full resource name of a
+  // [Project][google.cloud.discoveryengine.v1alpha.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 {}
+
+// Request for ReportConsentChange method.
+message ReportConsentChangeRequest {
+  // Type of consent acknowledgement (accept / reject).
+  //
+  // At this moment, only `ACCEPT` action is supported.
+  enum ConsentChangeAction {
+    // Invalid action, user must specify accept/decline
+    CONSENT_CHANGE_ACTION_UNSPECIFIED = 0;
+
+    // User accepts service terms.
+    ACCEPT = 1;
+  }
+
+  // Required. Whether customer decides to accept or decline service term.
+  //
+  // At this moment, only accept action is supported.
+  ConsentChangeAction consent_change_action = 1
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Required. Full resource name of a
+  // [Project][google.cloud.discoveryengine.v1alpha.Project], such as
+  // `projects/{project_id_or_number}`.
+  string project = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Project"
+    }
+  ];
+
+  // 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
+  // [service_term_version][google.cloud.discoveryengine.v1alpha.ReportConsentChangeRequest.service_term_version]
+  // to provide is `2022-11-23`.
+  string service_term_id = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The version string of the terms of service to update.
+  string service_term_version = 4 [(google.api.field_behavior) = REQUIRED];
+}

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

@@ -163,6 +163,18 @@ message FieldConfig {
     FILTERABLE_DISABLED = 2;
   }
 
+  // Optional source of the advanced site search field.
+  enum AdvancedSiteSearchDataSource {
+    // Value used when unset.
+    ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED = 0;
+
+    // Retrieve value from meta tag.
+    METATAGS = 1;
+
+    // Retrieve value from page map.
+    PAGEMAP = 2;
+  }
+
   // Required. Field path of the schema field.
   // For example: `title`, `description`, `release_info.release_year`.
   string field_path = 1 [(google.api.field_behavior) = REQUIRED];
@@ -312,4 +324,13 @@ message FieldConfig {
   // `indexable_option` and `searchable_option` of this field cannot be
   // modified.
   string key_property_type = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // If this field is set, only the corresponding source will be indexed for
+  // this field. Otherwise, the values from different sources are merged.
+  //
+  // Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
+  // map:
+  //  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;
 }

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

@@ -218,6 +218,80 @@ message SearchRequest {
   message BoostSpec {
     // Boost applies to documents which match a condition.
     message ConditionBoostSpec {
+      // Specification for custom ranking based on customer specified attribute
+      // value. It provides more controls for customized ranking than the simple
+      // (condition, boost) combination above.
+      message BoostControlSpec {
+        // The control points used to define the curve. The curve defined
+        // through these control points can only be monotonically increasing
+        // or decreasing(constant values are acceptable).
+        message ControlPoint {
+          // Can be one of:
+          // 1. The numerical field value.
+          // 2. The duration spec for freshness:
+          // The value must be formatted as an XSD `dayTimeDuration` value (a
+          // restricted subset of an ISO 8601 duration value). The pattern for
+          // this is: `[nD][T[nH][nM][nS]]`.
+          string attribute_value = 1;
+
+          // The value between -1 to 1 by which to boost the score if the
+          // attribute_value evaluates to the value specified above.
+          float boost_amount = 2;
+        }
+
+        // The attribute(or function) for which the custom ranking is to be
+        // applied.
+        enum AttributeType {
+          // Unspecified AttributeType.
+          ATTRIBUTE_TYPE_UNSPECIFIED = 0;
+
+          // The value of the numerical field will be used to dynamically update
+          // the boost amount. In this case, the attribute_value (the x value)
+          // of the control point will be the actual value of the numerical
+          // field for which the boost_amount is specified.
+          NUMERICAL = 1;
+
+          // For the freshness use case the attribute value will be the duration
+          // between the current time and the date in the datetime field
+          // specified. The value must be formatted as an XSD `dayTimeDuration`
+          // value (a restricted subset of an ISO 8601 duration value). The
+          // pattern for this is: `[nD][T[nH][nM][nS]]`.
+          // E.g. `5D`, `3DT12H30M`, `T24H`.
+          FRESHNESS = 2;
+        }
+
+        // The interpolation type to be applied. Default will be linear
+        // (Piecewise Linear).
+        enum InterpolationType {
+          // Interpolation type is unspecified. In this case, it defaults to
+          // Linear.
+          INTERPOLATION_TYPE_UNSPECIFIED = 0;
+
+          // Piecewise linear interpolation will be applied.
+          LINEAR = 1;
+        }
+
+        // The name of the field whose value will be used to determine the
+        // boost amount.
+        string field_name = 1;
+
+        // The attribute type to be used to determine the boost amount. The
+        // attribute value can be derived from the field value of the specified
+        // field_name. In the case of numerical it is straightforward i.e.
+        // attribute_value = numerical_field_value. In the case of freshness
+        // however, attribute_value = (time.now() - datetime_field_value).
+        AttributeType attribute_type = 2;
+
+        // The interpolation type to be applied to connect the control points
+        // listed below.
+        InterpolationType interpolation_type = 3;
+
+        // The control points used to define the curve. The monotonic function
+        // (defined through the interpolation_type above) passes through the
+        // control points listed here.
+        repeated ControlPoint control_points = 4;
+      }
+
       // An expression which specifies a boost condition. The syntax and
       // supported fields are the same as a filter expression. See
       // [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter]
@@ -233,21 +307,27 @@ message SearchRequest {
       // Strength of the condition boost, which should be in [-1, 1]. Negative
       // boost means demotion. Default is 0.0.
       //
-      // Setting to 1.0 gives the document a big promotion. However, it does not
-      // necessarily mean that the boosted document will be the top result at
-      // all times, nor that other documents will be excluded. Results could
-      // still be shown even when none of them matches the condition. And
-      // results that are significantly more relevant to the search query can
-      // still trump your heavily favored but irrelevant documents.
+      // Setting to 1.0 gives the document a big promotion. However, it does
+      // not necessarily mean that the boosted document will be the top result
+      // at all times, nor that other documents will be excluded. Results
+      // could still be shown even when none of them matches the condition.
+      // And results that are significantly more relevant to the search query
+      // can still trump your heavily favored but irrelevant documents.
       //
       // Setting to -1.0 gives the document a big demotion. However, results
       // that are deeply relevant might still be shown. The document will have
-      // an upstream battle to get a fairly high ranking, but it is not blocked
-      // out completely.
+      // an upstream battle to get a fairly high ranking, but it is not
+      // blocked out completely.
       //
       // Setting to 0.0 means no boost applied. The boosting condition is
-      // ignored.
+      // ignored. Only one of the (condition, boost) combination or the
+      // boost_control_spec below are set. If both are set then the global boost
+      // is ignored and the more fine-grained boost_control_spec is applied.
       float boost = 2;
+
+      // Complex specification for custom ranking based on customer defined
+      // attribute value.
+      BoostControlSpec boost_control_spec = 3;
     }
 
     // Condition boost specifications. If a document matches multiple conditions
@@ -348,11 +428,13 @@ message SearchRequest {
         // Supported values are:
         //
         // * `stable`: string. Default value when no value is specified. Uses a
-        //   generally available, fine-tuned version of the text-bison@001
-        //   model.
-        // * `preview`: string. (Public preview) Uses a fine-tuned version of
-        //   the text-bison@002 model. This model works only for summaries in
-        //   English.
+        //    generally available, fine-tuned model. For more information, see
+        //    [Answer generation model versions and
+        //    lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+        // * `preview`: string. (Public preview) Uses a preview model. For more
+        //    information, see
+        //    [Answer generation model versions and
+        //    lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
         string version = 1;
       }
 
@@ -360,7 +442,11 @@ message SearchRequest {
       // of results returned is less than `summaryResultCount`, the summary is
       // generated from all of the results.
       //
-      // At most 10 results can be used to generate a summary.
+      // At most 10 results for documents mode, or 50 for chunks mode, can be
+      // used to generate a summary. The chunks mode is used when
+      // [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
+      // is set to
+      // [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
       int32 summary_result_count = 1;
 
       // Specifies whether to include citations in the summary. The default
@@ -419,6 +505,14 @@ message SearchRequest {
       // If specified, the spec will be used to modify the model specification
       // provided to the LLM.
       ModelSpec model_spec = 7;
+
+      // If true, answer will be generated from most relevant chunks from top
+      // search results. This feature will improve summary quality.
+      // Note that with this feature enabled, not all top search results
+      // will be referenced and included in the reference list, so the citation
+      // source index only points to the search results listed in the reference
+      // list.
+      bool use_semantic_chunks = 8;
     }
 
     // A specification for configuring the extractive content in a search
@@ -459,10 +553,9 @@ message SearchRequest {
       int32 max_extractive_segment_count = 2;
 
       // Specifies whether to return the confidence score from the extractive
-      // segments in each search result. The default value is `false`.
-      //
-      // Note: this is a priavte preview feature and only works for allowlisted
-      // users, please reach out to Cloud Support team if you want to use it.
+      // segments in each search result. This feature is available only for new
+      // or allowlisted data stores. To allowlist your data store,
+      // contact your Customer Engineer. The default value is `false`.
       bool return_extractive_segment_score = 3;
 
       // Specifies whether to also include the adjacent from each selected
@@ -476,6 +569,23 @@ message SearchRequest {
       int32 num_next_segments = 5;
     }
 
+    // Specifies the chunk spec to be returned from the search response.
+    // Only available if the
+    // [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
+    // is set to
+    // [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
+    message ChunkSpec {
+      // The number of previous chunks to be returned of the current chunk. The
+      // maximum allowed value is 3.
+      // If not specified, no previous chunks will be returned.
+      int32 num_previous_chunks = 1;
+
+      // The number of next chunks to be returned of the current chunk. The
+      // maximum allowed value is 3.
+      // If not specified, no next chunks will be returned.
+      int32 num_next_chunks = 2;
+    }
+
     // Specifies the search result mode. If unspecified, the
     // search result mode is based on
     // [DataStore.DocumentProcessingConfig.chunking_config][]:
@@ -513,6 +623,13 @@ message SearchRequest {
     //   it defaults to `CHUNKS`.
     // * Otherwise, it defaults to `DOCUMENTS`.
     SearchResultMode search_result_mode = 4;
+
+    // Specifies the chunk spec to be returned from the search response.
+    // Only available if the
+    // [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.search_result_mode]
+    // is set to
+    // [CHUNKS][google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
+    ChunkSpec chunk_spec = 5;
   }
 
   // The specification that uses customized query embedding vector to do
@@ -560,11 +677,15 @@ message SearchRequest {
   ImageQuery image_query = 19;
 
   // Maximum number of
-  // [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. If
-  // unspecified, defaults to a reasonable value. The maximum allowed value is
-  // 100. Values above 100 are coerced to 100.
+  // [Document][google.cloud.discoveryengine.v1alpha.Document]s to return. The
+  // maximum allowed value depends on the data type. Values above the maximum
+  // value are coerced to the maximum value.
   //
-  // If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+  // * Websites with basic indexing: Default `10`, Maximum `25`.
+  // * Websites with advanced indexing: Default `25`, Maximum `50`.
+  // * Other: Default `50`, Maximum `100`.
+  //
+  // If this field is negative, an  `INVALID_ARGUMENT` is returned.
   int32 page_size = 4;
 
   // A page token received from a previous
@@ -701,7 +822,8 @@ message SearchRequest {
   //
   // If
   // [SearchRequest.EmbeddingSpec.EmbeddingVector.field_path][google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path]
-  // is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
+  // is not provided, it will use
+  // [ServingConfig.EmbeddingConfig.field_path][google.cloud.discoveryengine.v1alpha.ServingConfig.embedding_config].
   EmbeddingSpec embedding_spec = 23;
 
   // The ranking expression controls the customized ranking on retrieval
@@ -867,6 +989,15 @@ message SearchResponse {
 
     // Document reference.
     message Reference {
+      // Chunk content.
+      message ChunkContent {
+        // Chunk textual content.
+        string content = 1;
+
+        // Page identifier.
+        string page_identifier = 2;
+      }
+
       // Title of the document.
       string title = 1;
 
@@ -884,6 +1015,9 @@ message SearchResponse {
 
       // Cloud Storage or HTTP uri for the document.
       string uri = 3;
+
+      // List of cited chunk contents derived from document content.
+      repeated ChunkContent chunk_contents = 4;
     }
 
     // Summary with metadata information.

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

@@ -65,8 +65,8 @@ message TrainCustomModelRequest {
     // A newline delimited jsonl/ndjson file.
     //
     // For search-tuning model, each line should have the _id, title
-    // and text. Example: {"_id": "doc1", title: "relevant doc", "text":
-    // "relevant text"}
+    // and text. Example:
+    // `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
     string corpus_data_path = 1;
 
     // The gcs query data which could be associated in train data.
@@ -134,9 +134,15 @@ message TrainCustomModelResponse {
   //
   //  * **bad-data**: The training data quality is bad.
   //  * **no-improvement**: Tuning didn't improve performance. Won't deploy.
-  //  * **in-progress**: Model training is in progress.
+  //  * **in-progress**: Model training job creation is in progress.
+  //  * **training**: Model is actively training.
+  //  * **evaluating**: The model is evaluating trained metrics.
+  //  * **indexing**: The model trained metrics are indexing.
   //  * **ready**: The model is ready for serving.
   string model_status = 3;
+
+  // The metrics of the trained model.
+  map<string, double> metrics = 4;
 }
 
 // Metadata related to the progress of the TrainCustomModel operation. This is

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

@@ -32,7 +32,8 @@ option objc_class_prefix = "DISCOVERYENGINE";
 option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
 option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
 
-// Service for operations related to [ServingConfig][].
+// Service for operations related to
+// [ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig].
 service ServingConfigService {
   option (google.api.default_host) = "discoveryengine.googleapis.com";
   option (google.api.oauth_scopes) =