@google-cloud/discoveryengine 1.10.0 → 1.12.0

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

@@ -0,0 +1,252 @@
+// 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/evaluation.proto";
+import "google/cloud/discoveryengine/v1beta/sample_query.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 = "EvaluationServiceProto";
+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 managing
+// [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s,
+service EvaluationService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Gets a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
+  rpc GetEvaluation(GetEvaluationRequest) returns (Evaluation) {
+    option (google.api.http) = {
+      get: "/v1beta/{name=projects/*/locations/*/evaluations/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Gets a list of
+  // [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.
+  rpc ListEvaluations(ListEvaluationsRequest)
+      returns (ListEvaluationsResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{parent=projects/*/locations/*}/evaluations"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Creates a [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
+  //
+  // Upon creation, the evaluation will be automatically triggered and begin
+  // execution.
+  rpc CreateEvaluation(CreateEvaluationRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*}/evaluations"
+      body: "evaluation"
+    };
+    option (google.api.method_signature) = "parent,evaluation";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.Evaluation"
+      metadata_type: "google.cloud.discoveryengine.v1beta.CreateEvaluationMetadata"
+    };
+  }
+
+  // Gets a list of results for a given a
+  // [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation].
+  rpc ListEvaluationResults(ListEvaluationResultsRequest)
+      returns (ListEvaluationResultsResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{evaluation=projects/*/locations/*/evaluations/*}:listResults"
+    };
+    option (google.api.method_signature) = "evaluation";
+  }
+}
+
+// Request message for
+// [EvaluationService.GetEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.GetEvaluation]
+// method.
+message GetEvaluationRequest {
+  // Required. Full resource name of
+  // [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], such as
+  // `projects/{project}/locations/{location}/evaluations/{evaluation}`.
+  //
+  // If the caller does not have permission to access the
+  // [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation], regardless of
+  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  //
+  // If the requested
+  // [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation] does not
+  // exist, a NOT_FOUND error is returned.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Evaluation"
+    }
+  ];
+}
+
+// Request message for
+// [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations]
+// method.
+message ListEvaluationsRequest {
+  // Required. The parent location resource name, such as
+  // `projects/{project}/locations/{location}`.
+  //
+  // If the caller does not have permission to list
+  // [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s under this
+  // location, regardless of whether or not this location exists, a
+  // `PERMISSION_DENIED` error is returned.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Location"
+    }
+  ];
+
+  // Maximum number of
+  // [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s to return. If
+  // unspecified, defaults to 100. The maximum allowed value is 1000. Values
+  // above 1000 will be coerced to 1000.
+  //
+  // If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  int32 page_size = 2;
+
+  // A page token
+  // [ListEvaluationsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationsResponse.next_page_token],
+  // received from a previous
+  // [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations]
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to
+  // [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations]
+  // must match the call that provided the page token. Otherwise, an
+  // `INVALID_ARGUMENT` error is returned.
+  string page_token = 3;
+}
+
+// Response message for
+// [EvaluationService.ListEvaluations][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluations]
+// method.
+message ListEvaluationsResponse {
+  // The [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]s.
+  repeated Evaluation evaluations = 1;
+
+  // A token that can be sent as
+  // [ListEvaluationsRequest.page_token][google.cloud.discoveryengine.v1beta.ListEvaluationsRequest.page_token]
+  // to retrieve the next page. If this field is omitted, there are no
+  // subsequent pages.
+  string next_page_token = 2;
+}
+
+// Request message for
+// [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation]
+// method.
+message CreateEvaluationRequest {
+  // Required. The parent resource name, such as
+  // `projects/{project}/locations/{location}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Location"
+    }
+  ];
+
+  // Required. The [Evaluation][google.cloud.discoveryengine.v1beta.Evaluation]
+  // to create.
+  Evaluation evaluation = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Metadata for
+// [EvaluationService.CreateEvaluation][google.cloud.discoveryengine.v1beta.EvaluationService.CreateEvaluation]
+// method.
+message CreateEvaluationMetadata {}
+
+// Request message for
+// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
+// method.
+message ListEvaluationResultsRequest {
+  // Required. The evaluation resource name, such as
+  // `projects/{project}/locations/{location}/evaluations/{evaluation}`.
+  //
+  // If the caller does not have permission to list [EvaluationResult][]
+  // under this evaluation, regardless of whether or not this evaluation
+  // set exists, a `PERMISSION_DENIED` error is returned.
+  string evaluation = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Evaluation"
+    }
+  ];
+
+  // Maximum number of [EvaluationResult][] to return. If unspecified,
+  // defaults to 100. The maximum allowed value is 1000. Values above 1000 will
+  // be coerced to 1000.
+  //
+  // If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  int32 page_size = 2;
+
+  // A page token
+  // [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token],
+  // received from a previous
+  // [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to
+  // [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
+  // must match the call that provided the page token. Otherwise, an
+  // `INVALID_ARGUMENT` error is returned.
+  string page_token = 3;
+}
+
+// Response message for
+// [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
+// method.
+message ListEvaluationResultsResponse {
+  // Represents the results of an evaluation for a single
+  // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
+  message EvaluationResult {
+    // Output only. The
+    // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] that was
+    // evaluated.
+    SampleQuery sample_query = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The metrics produced by the evaluation, for a given
+    // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery].
+    QualityMetrics quality_metrics = 2
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // The
+  // [EvaluationResult][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.EvaluationResult]s.
+  repeated EvaluationResult evaluation_results = 1;
+
+  // A token that can be sent as
+  // [ListEvaluationResultsRequest.page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest.page_token]
+  // to retrieve the next page. If this field is omitted, there are no
+  // subsequent pages.
+  string next_page_token = 2;
+}

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

@@ -20,6 +20,7 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/discoveryengine/v1beta/completion.proto";
 import "google/cloud/discoveryengine/v1beta/document.proto";
+import "google/cloud/discoveryengine/v1beta/sample_query.proto";
 import "google/cloud/discoveryengine/v1beta/user_event.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/timestamp.proto";
@@ -326,6 +327,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
@@ -499,6 +532,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;
   }
@@ -663,3 +699,158 @@ message ImportSuggestionDenyListEntriesMetadata {
   // finish time.
   google.protobuf.Timestamp update_time = 2;
 }
+
+// Request message for
+// [CompletionService.ImportCompletionSuggestions][google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.CompletionSuggestion]s
+  // successfully imported.
+  int64 success_count = 3;
+
+  // Count of
+  // [CompletionSuggestion][google.cloud.discoveryengine.v1beta.CompletionSuggestion]s
+  // that failed to be imported.
+  int64 failure_count = 4;
+}
+
+// Request message for
+// [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries]
+// method.
+message ImportSampleQueriesRequest {
+  // The inline source for
+  // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s.
+  message InlineSource {
+    // Required. A list of
+    // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s to
+    // import. Max of 1000 items.
+    repeated SampleQuery sample_queries = 1
+        [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // The source of the sample queries.
+  oneof source {
+    // The Inline source for sample query 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 sample query set resource name, such as
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+  //
+  // If the caller does not have permission to list
+  // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s under this
+  // sample query set, regardless of whether or not this sample query set
+  // exists, a `PERMISSION_DENIED` error is returned.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/SampleQuerySet"
+    }
+  ];
+
+  // The desired location of errors incurred during the Import.
+  ImportErrorConfig error_config = 5;
+}
+
+// Response of the
+// [SampleQueryService.ImportSampleQueries][google.cloud.discoveryengine.v1beta.SampleQueryService.ImportSampleQueries]
+// 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 ImportSampleQueriesResponse {
+  // 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 ImportSampleQueries
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message ImportSampleQueriesMetadata {
+  // ImportSampleQueries operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // ImportSampleQueries operation last update time. If the operation is done,
+  // this is also the finish time.
+  google.protobuf.Timestamp update_time = 2;
+
+  // Count of [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s
+  // successfully imported.
+  int64 success_count = 3;
+
+  // Count of [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s
+  // that failed to be imported.
+  int64 failure_count = 4;
+
+  // Total count of
+  // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s that were
+  // processed.
+  int64 total_count = 5;
+}

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

@@ -30,6 +30,79 @@ option objc_class_prefix = "DISCOVERYENGINE";
 option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
 option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
 
+// Request message for PurgeUserEvents method.
+message PurgeUserEventsRequest {
+  // Required. The resource name of the catalog under which the events are
+  // created. The format is
+  // `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // Required. The filter string to specify the events to be deleted with a
+  // length limit of 5,000 characters. The eligible fields for filtering are:
+  //
+  // * `eventType`: Double quoted
+  // [UserEvent.event_type][google.cloud.discoveryengine.v1beta.UserEvent.event_type]
+  // string.
+  // * `eventTime`: in ISO 8601 "zulu" format.
+  // * `userPseudoId`: Double quoted string. Specifying this will delete all
+  //   events associated with a visitor.
+  // * `userId`: Double quoted string. Specifying this will delete all events
+  //   associated with a user.
+  //
+  // Examples:
+  //
+  // * Deleting all events in a time range:
+  //   `eventTime > "2012-04-23T18:25:43.511Z"
+  //   eventTime < "2012-04-23T18:30:43.511Z"`
+  // * Deleting specific eventType:
+  //   `eventType = "search"`
+  // * Deleting all events for a specific visitor:
+  //   `userPseudoId = "visitor1024"`
+  // * Deleting all events inside a DataStore:
+  //   `*`
+  //
+  // The filtering fields are assumed to have an implicit AND.
+  string filter = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // The `force` field is currently not supported. Purge user event requests
+  // will permanently delete all purgeable events. Once the development is
+  // complete:
+  // If `force` is set to false, the method will return the expected
+  // purge count without deleting any user events. This field will default to
+  // false if not included in the request.
+  bool force = 3;
+}
+
+// Response of the PurgeUserEventsRequest. If the long running operation is
+// successfully done, then this message is returned by the
+// google.longrunning.Operations.response field.
+message PurgeUserEventsResponse {
+  // The total count of events purged as a result of the operation.
+  int64 purge_count = 1;
+}
+
+// Metadata related to the progress of the PurgeUserEvents operation.
+// This will be returned by the google.longrunning.Operation.metadata field.
+message PurgeUserEventsMetadata {
+  // 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 entries that were deleted successfully.
+  int64 success_count = 3;
+
+  // Count of entries that encountered errors while processing.
+  int64 failure_count = 4;
+}
+
 // Request message for
 // [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
 // method.
@@ -125,3 +198,41 @@ message PurgeSuggestionDenyListEntriesMetadata {
   // finish time.
   google.protobuf.Timestamp update_time = 2;
 }
+
+// Request message for
+// [CompletionService.PurgeCompletionSuggestions][google.cloud.discoveryengine.v1beta.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.v1beta.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/v1beta/sample_query.proto

@@ -0,0 +1,86 @@
+// 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 = "SampleQueryProto";
+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";
+
+// Sample Query captures metadata to be used for evaluation.
+message SampleQuery {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/SampleQuery"
+    pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}"
+  };
+
+  // Query Entry captures metadata to be used for search evaluation.
+  message QueryEntry {
+    // Defines the parameters of the query's expected outcome.
+    message Target {
+      // Expected uri of the target.
+      //
+      // This field must be a UTF-8 encoded string with a length limit of 2048
+      // characters.
+      //
+      // Example of valid uris: `https://example.com/abc`,
+      // `gcs://example/example.pdf`.
+      string uri = 1;
+
+      // Expected page numbers of the target.
+      //
+      // Each page number must be non negative.
+      repeated int32 page_numbers = 2;
+
+      // Relevance score of the target.
+      optional double score = 3;
+    }
+
+    // Required. The query.
+    string query = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // List of targets for the query.
+    repeated Target targets = 3;
+  }
+
+  // The content of the sample query.
+  oneof content {
+    // The query entry.
+    QueryEntry query_entry = 2;
+  }
+
+  // Identifier. The full resource name of the sample query, in the format of
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 1024
+  // characters.
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. Timestamp the
+  // [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] was created
+  // at.
+  google.protobuf.Timestamp create_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}