@google-cloud/discoveryengine 1.9.0 → 1.11.0

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

@@ -325,6 +325,38 @@ message CloudSqlSource {
   bool offload = 6;
 }
 
+// AlloyDB source import data from.
+message AlloyDbSource {
+  // The project ID that the AlloyDB source is in
+  // with a length limit of 128 characters. If not specified, inherits the
+  // project ID from the parent request.
+  string project_id = 1;
+
+  // Required. The AlloyDB location to copy the data from with a length limit of
+  // 256 characters.
+  string location_id = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The AlloyDB cluster to copy the data from with a length limit of
+  // 256 characters.
+  string cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The AlloyDB database to copy the data from with a length limit of
+  // 256 characters.
+  string database_id = 4 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The AlloyDB table to copy the data from with a length limit of
+  // 256 characters.
+  string table_id = 5 [(google.api.field_behavior) = REQUIRED];
+
+  // Intermediate Cloud Storage directory used for the import with a length
+  // limit of 2,000 characters. Can be specified if one wants to have the
+  // AlloyDB export to a specific Cloud Storage directory.
+  //
+  // Ensure that the AlloyDB service account has the necessary Cloud
+  // Storage Admin permissions to access the specified Cloud Storage directory.
+  string gcs_staging_dir = 6;
+}
+
 // Firestore source import data from.
 message FirestoreSource {
   // The project ID that the Cloud SQL source is in with a length limit of 128
@@ -498,6 +530,9 @@ message ImportDocumentsRequest {
     // Firestore input source.
     FirestoreSource firestore_source = 13;
 
+    // AlloyDB input source.
+    AlloyDbSource alloy_db_source = 14;
+
     // Cloud Bigtable input source.
     BigtableSource bigtable_source = 15;
   }
@@ -662,3 +697,76 @@ message ImportSuggestionDenyListEntriesMetadata {
   // finish time.
   google.protobuf.Timestamp update_time = 2;
 }
+
+// Request message for
+// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions]
+// method.
+message ImportCompletionSuggestionsRequest {
+  // The inline source for CompletionSuggestions.
+  message InlineSource {
+    // Required. A list of all denylist entries to import. Max of 1000 items.
+    repeated CompletionSuggestion suggestions = 1
+        [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // The source of the autocomplete suggestions.
+  oneof source {
+    // The Inline source for suggestion entries.
+    InlineSource inline_source = 2;
+
+    // Cloud Storage location for the input content.
+    GcsSource gcs_source = 3;
+
+    // BigQuery input source.
+    BigQuerySource bigquery_source = 4;
+  }
+
+  // Required. The parent data store resource name for which to import customer
+  // autocomplete suggestions.
+  //
+  // Follows pattern `projects/*/locations/*/collections/*/dataStores/*`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // The desired location of errors incurred during the Import.
+  ImportErrorConfig error_config = 5;
+}
+
+// Response of the
+// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.ImportCompletionSuggestions]
+// method. If the long running operation is done, this message is returned by
+// the google.longrunning.Operations.response field if the operation is
+// successful.
+message ImportCompletionSuggestionsResponse {
+  // A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 1;
+
+  // The desired location of errors incurred during the Import.
+  ImportErrorConfig error_config = 2;
+}
+
+// Metadata related to the progress of the ImportCompletionSuggestions
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message ImportCompletionSuggestionsMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+
+  // Count of
+  // [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
+  // successfully imported.
+  int64 success_count = 3;
+
+  // Count of
+  // [CompletionSuggestion][google.cloud.discoveryengine.v1.CompletionSuggestion]s
+  // that failed to be imported.
+  int64 failure_count = 4;
+}

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

@@ -125,3 +125,41 @@ message PurgeSuggestionDenyListEntriesMetadata {
   // finish time.
   google.protobuf.Timestamp update_time = 2;
 }
+
+// Request message for
+// [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions]
+// method.
+message PurgeCompletionSuggestionsRequest {
+  // Required. The parent data store resource name for which to purge completion
+  // suggestions. Follows pattern
+  // projects/*/locations/*/collections/*/dataStores/*.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+}
+
+// Response message for
+// [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1.CompletionService.PurgeCompletionSuggestions]
+// method.
+message PurgeCompletionSuggestionsResponse {
+  // Whether the completion suggestions were successfully purged.
+  bool purge_succeeded = 1;
+
+  // A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 2;
+}
+
+// Metadata related to the progress of the PurgeCompletionSuggestions
+// operation. This is returned by the google.longrunning.Operation.metadata
+// field.
+message PurgeCompletionSuggestionsMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}

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

@@ -20,6 +20,7 @@ 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/v1/chunk.proto";
 import "google/cloud/discoveryengine/v1/common.proto";
 import "google/cloud/discoveryengine/v1/document.proto";
 import "google/protobuf/struct.proto";
@@ -70,8 +71,8 @@ message SearchRequest {
   }
 
   // A struct to define data stores to filter on in a search call and
-  // configurations for those data stores. A maximum of 1 DataStoreSpec per
-  // data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  // configurations for those data stores. Otherwise, an `INVALID_ARGUMENT`
+  // error is returned.
   message DataStoreSpec {
     // Required. Full resource name of
     // [DataStore][google.cloud.discoveryengine.v1.DataStore], such as
@@ -150,6 +151,9 @@ message SearchRequest {
     // Maximum facet values that are returned for this facet. If
     // unspecified, defaults to 20. The maximum allowed value is 300. Values
     // above 300 are coerced to 300.
+    // For aggregation in healthcare search, when the [FacetKey.key] is
+    // "healthcare_aggregation_key", the limit will be overridden to
+    // 10,000 internally, regardless of the value set here.
     //
     // If this field is negative, an  `INVALID_ARGUMENT`  is returned.
     int32 limit = 2;
@@ -367,8 +371,9 @@ message SearchRequest {
       //
       // 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][] is set to
-      // [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
+      // [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
+      // is set to
+      // [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
       int32 summary_result_count = 1;
 
       // Specifies whether to include citations in the summary. The default
@@ -491,6 +496,41 @@ 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.v1.SearchRequest.ContentSearchSpec.search_result_mode]
+    // is set to
+    // [CHUNKS][google.cloud.discoveryengine.v1.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][]:
+    // * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
+    //   it defaults to `CHUNKS`.
+    // * Otherwise, it defaults to `DOCUMENTS`.
+    enum SearchResultMode {
+      // Default value.
+      SEARCH_RESULT_MODE_UNSPECIFIED = 0;
+
+      // Returns documents in the search result.
+      DOCUMENTS = 1;
+
+      // Returns chunks in the search result. Only available if the
+      // [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
+      CHUNKS = 2;
+    }
+
     // If `snippetSpec` is not specified, snippets are not included in the
     // search response.
     SnippetSpec snippet_spec = 1;
@@ -502,6 +542,85 @@ message SearchRequest {
     // If there is no extractive_content_spec provided, there will be no
     // extractive answer in the search response.
     ExtractiveContentSpec extractive_content_spec = 3;
+
+    // Specifies the search result mode. If unspecified, the
+    // search result mode is based on
+    // [DataStore.DocumentProcessingConfig.chunking_config][]:
+    // * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
+    //   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.v1.SearchRequest.ContentSearchSpec.search_result_mode]
+    // is set to
+    // [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]
+    ChunkSpec chunk_spec = 5;
+  }
+
+  // Specification for search as you type in search requests.
+  message SearchAsYouTypeSpec {
+    // Enum describing under which condition search as you type should occur.
+    enum Condition {
+      // Server behavior defaults to
+      // [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
+      CONDITION_UNSPECIFIED = 0;
+
+      // Disables Search As You Type.
+      DISABLED = 1;
+
+      // Enables Search As You Type.
+      ENABLED = 2;
+    }
+
+    // The condition under which search as you type should occur.
+    // Default to
+    // [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
+    Condition condition = 1;
+  }
+
+  // Session specification.
+  //
+  // Multi-turn Search feature is currently at private GA stage. Please use
+  // v1alpha or v1beta version instead before we launch this feature to public
+  // GA. Or ask for allowlisting through Google Support team.
+  message SessionSpec {
+    // If set, the search result gets stored to the "turn" specified by this
+    // query ID.
+    //
+    // Example: Let's say the session looks like this:
+    //   session {
+    //     name: ".../sessions/xxx"
+    //     turns {
+    //       query { text: "What is foo?" query_id: ".../questions/yyy" }
+    //       answer: "Foo is ..."
+    //     }
+    //     turns {
+    //       query { text: "How about bar then?" query_id: ".../questions/zzz" }
+    //     }
+    //   }
+    //
+    // The user can call /search API with a request like this:
+    //
+    //    session: ".../sessions/xxx"
+    //    session_spec { query_id: ".../questions/zzz" }
+    //
+    // Then, the API stores the search result, associated with the last turn.
+    // The stored search result can be used by a subsequent /answer API call
+    // (with the session ID and the query ID specified). Also, it is possible
+    // to call /search and /answer in parallel with the same session ID & query
+    // ID.
+    string query_id = 1;
+
+    // The number of top search results to persist. The persisted search results
+    // can be used for the subsequent /answer api call.
+    //
+    // This field is simliar to the `summary_result_count` field in
+    // [SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count].
+    //
+    // At most 10 results for documents mode, or 50 for chunks mode.
+    optional int32 search_result_persistence_count = 2;
   }
 
   // Required. The resource name of the Search serving config, such as
@@ -617,6 +736,13 @@ message SearchRequest {
   // is used to deduce `device_type` for analytics.
   UserInfo user_info = 21;
 
+  // The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+  // information, see [Standard
+  // fields](https://cloud.google.com/apis/design/standard_fields). This field
+  // helps to better interpret the query. If a value isn't specified, the query
+  // language code is automatically detected, which may not be accurate.
+  string language_code = 35;
+
   // Facet specifications for faceted search. If empty, no facets are returned.
   //
   // A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
@@ -694,6 +820,46 @@ message SearchRequest {
   // Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
   // for more details.
   map<string, string> user_labels = 22;
+
+  // Search as you type configuration. Only supported for the
+  // [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1.IndustryVertical.MEDIA]
+  // vertical.
+  SearchAsYouTypeSpec search_as_you_type_spec = 31;
+
+  // The session resource name. Optional.
+  //
+  // Session allows users to do multi-turn /search API calls or coordination
+  // between /search API calls and /answer API calls.
+  //
+  // Example #1 (multi-turn /search API calls):
+  //   1. Call /search API with the auto-session mode (see below).
+  //   2. Call /search API with the session ID generated in the first call.
+  //      Here, the previous search query gets considered in query
+  //      standing. I.e., if the first query is "How did Alphabet do in 2022?"
+  //      and the current query is "How about 2023?", the current query will
+  //      be interpreted as "How did Alphabet do in 2023?".
+  //
+  // Example #2 (coordination between /search API calls and /answer API calls):
+  //   1. Call /search API with the auto-session mode (see below).
+  //   2. Call /answer API with the session ID generated in the first call.
+  //      Here, the answer generation happens in the context of the search
+  //      results from the first search call.
+  //
+  // Auto-session mode: when `projects/.../sessions/-` is used, a new session
+  // gets automatically created. Otherwise, users can use the create-session API
+  // to create a session manually.
+  //
+  // Multi-turn Search feature is currently at private GA stage. Please use
+  // v1alpha or v1beta version instead before we launch this feature to public
+  // GA. Or ask for allowlisting through Google Support team.
+  string session = 41 [(google.api.resource_reference) = {
+    type: "discoveryengine.googleapis.com/Session"
+  }];
+
+  // Session specification.
+  //
+  // Can be used only when `session` is set.
+  SessionSpec session_spec = 42;
 }
 
 // Response message for
@@ -709,6 +875,12 @@ message SearchResponse {
     // The document data snippet in the search response. Only fields that are
     // marked as `retrievable` are populated.
     Document document = 2;
+
+    // The chunk data in the search response if the
+    // [SearchRequest.ContentSearchSpec.search_result_mode][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.search_result_mode]
+    // is set to
+    // [CHUNKS][google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
+    Chunk chunk = 18;
   }
 
   // A facet result.
@@ -890,6 +1062,23 @@ message SearchResponse {
     int64 pinned_result_count = 2;
   }
 
+  // Information about the session.
+  message SessionInfo {
+    // Name of the session.
+    // If the auto-session mode is used (when
+    // [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
+    // ends with "-"), this field holds the newly generated session name.
+    string name = 1;
+
+    // Query ID that corresponds to this search API call.
+    // One session can have multiple turns, each with a unique query ID.
+    //
+    // By specifying the session name and this query ID in the Answer API call,
+    // the answer generation happens in the context of the search results from
+    // this search call.
+    string query_id = 2;
+  }
+
   // A list of matched documents. The order represents the ranking.
   repeated SearchResult results = 1;
 
@@ -936,4 +1125,11 @@ message SearchResponse {
 
   // Query expansion information for the returned results.
   QueryExpansionInfo query_expansion_info = 14;
+
+  // Session information.
+  //
+  // Only set if
+  // [SearchRequest.session][google.cloud.discoveryengine.v1.SearchRequest.session]
+  // is provided. See its description for more details.
+  SessionInfo session_info = 19;
 }

package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto

@@ -67,6 +67,9 @@ service UserEventService {
       additional_bindings {
         get: "/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect"
       }
+      additional_bindings {
+        get: "/v1/{parent=projects/*/locations/*}/userEvents:collect"
+      }
     };
   }
 

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

@@ -0,0 +1,232 @@
+// 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/cloud/discoveryengine/v1alpha/search_service.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.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 = "EvaluationProto";
+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";
+
+// An evaluation is a single execution (or run) of an evaluation process. It
+// encapsulates the state of the evaluation and the resulting data.
+message Evaluation {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Evaluation"
+    pattern: "projects/{project}/locations/{location}/evaluations/{evaluation}"
+  };
+
+  // Describes the specification of the evaluation.
+  message EvaluationSpec {
+    // Describes the specification of the query set.
+    message QuerySetSpec {
+      // Required. The full resource name of the
+      // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
+      // used for the evaluation, in the format of
+      // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+      string sample_query_set = 1 [
+        (google.api.field_behavior) = REQUIRED,
+        (google.api.resource_reference) = {
+          type: "discoveryengine.googleapis.com/SampleQuerySet"
+        }
+      ];
+    }
+
+    // The search specification.
+    oneof search_spec {
+      // Required. The search request that is used to perform the evaluation.
+      //
+      // Only the following fields within SearchRequest are supported; if any
+      // other fields are provided, an UNSUPPORTED error will be returned:
+      //
+      // * [SearchRequest.serving_config][google.cloud.discoveryengine.v1alpha.SearchRequest.serving_config]
+      // * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
+      // * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
+      // * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
+      // * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
+      // * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
+      // * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
+      SearchRequest search_request = 2 [(google.api.field_behavior) = REQUIRED];
+    }
+
+    // Required. The specification of the query set.
+    QuerySetSpec query_set_spec = 1 [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // Describes the state of an evaluation.
+  enum State {
+    // The evaluation is unspecified.
+    STATE_UNSPECIFIED = 0;
+
+    // The service is preparing to run the evaluation.
+    PENDING = 1;
+
+    // The evaluation is in progress.
+    RUNNING = 2;
+
+    // The evaluation completed successfully.
+    SUCCEEDED = 3;
+
+    // The evaluation failed.
+    FAILED = 4;
+  }
+
+  // Identifier. The full resource name of the
+  // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], in the
+  // format of
+  // `projects/{project}/locations/{location}/evaluations/{evaluation}`.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 1024
+  // characters.
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Required. The specification of the evaluation.
+  EvaluationSpec evaluation_spec = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Output only. The metrics produced by the evaluation, averaged across all
+  // [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s in the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
+  //
+  // Only populated when the evaluation's state is SUCCEEDED.
+  QualityMetrics quality_metrics = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The state of the evaluation.
+  State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The error that occurred during evaluation. Only populated when
+  // the evaluation's state is FAILED.
+  google.rpc.Status error = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Timestamp the
+  // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was created
+  // at.
+  google.protobuf.Timestamp create_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Timestamp the
+  // [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] was completed
+  // at.
+  google.protobuf.Timestamp end_time = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Describes the metrics produced by the evaluation.
+message QualityMetrics {
+  // Stores the metric values at specific top-k levels.
+  message TopkMetrics {
+    // The top-1 value.
+    double top_1 = 1;
+
+    // The top-3 value.
+    double top_3 = 2;
+
+    // The top-5 value.
+    double top_5 = 3;
+
+    // The top-10 value.
+    double top_10 = 4;
+  }
+
+  // Recall per document, at various top-k cutoff levels.
+  //
+  // Recall is the fraction of relevant documents retrieved out of all
+  // relevant documents.
+  //
+  // Example (top-5):
+  //  * For a single
+  //  [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], If 3 out
+  //  of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+  TopkMetrics doc_recall = 1;
+
+  // Precision per document, at various top-k cutoff levels.
+  //
+  // Precision is the fraction of retrieved documents that are relevant.
+  //
+  // Example (top-5):
+  //  * For a single
+  //  [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], If 4 out
+  //  of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
+  //  0.8
+  TopkMetrics doc_precision = 2;
+
+  // Normalized discounted cumulative gain (NDCG) per document, at various top-k
+  // cutoff levels.
+  //
+  // NDCG measures the ranking quality, giving higher relevance to top
+  // results.
+  //
+  // Example (top-3):
+  //  Suppose [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
+  //  with three retrieved documents (D1, D2, D3) and binary relevance
+  //  judgements (1 for relevant, 0 for not relevant):
+  //
+  //   Retrieved:  [D3 (0), D1 (1), D2 (1)]
+  //   Ideal:      [D1 (1), D2 (1), D3 (0)]
+  //
+  //   Calculate NDCG@3 for each
+  //   [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]:
+  //    * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
+  //    * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
+  //    * NDCG@3: 1.13/1.63 = 0.693
+  TopkMetrics doc_ndcg = 3;
+
+  // Recall per page, at various top-k cutoff levels.
+  //
+  // Recall is the fraction of relevant pages retrieved out of all relevant
+  // pages.
+  //
+  // Example (top-5):
+  //  * For a single
+  //  [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], if 3 out
+  //  of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+  TopkMetrics page_recall = 4;
+
+  // Normalized discounted cumulative gain (NDCG) per page, at various top-k
+  // cutoff levels.
+  //
+  // NDCG measures the ranking quality, giving higher relevance to top
+  // results.
+  //
+  // Example (top-3):
+  //  Suppose [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]
+  //  with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
+  //  for relevant, 0 for not relevant):
+  //
+  //   Retrieved:  [P3 (0), P1 (1), P2 (1)]
+  //   Ideal:      [P1 (1), P2 (1), P3 (0)]
+  //
+  //   Calculate NDCG@3 for
+  //   [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]:
+  //    * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
+  //    * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
+  //    * NDCG@3: 1.13/1.63 = 0.693
+  TopkMetrics page_ndcg = 5;
+}