@google-cloud/discoveryengine 1.3.0 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.3.1](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.3.0...discoveryengine-v1.3.1) (2024-01-05)
+
+
+### Bug Fixes
+
+* [discoveryengine] correct long audio synthesis HTTP binding ([#4886](https://github.com/googleapis/google-cloud-node/issues/4886)) ([fb95ca7](https://github.com/googleapis/google-cloud-node/commit/fb95ca771318195714dfa47deab817ba19f5e1a4))
+
 ## [1.3.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.2.0...discoveryengine-v1.3.0) (2023-11-16)
 
 

package/README.md

@@ -182,7 +182,19 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Schema_service.list_schemas | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.list_schemas.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.list_schemas.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Schema_service.update_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.update_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.update_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Search_service.search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_service.search.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_service.search.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Search_tuning_service.train_custom_model | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_tuning_service.train_custom_model.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/search_tuning_service.train_custom_model.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.batch_create_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.batch_verify_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.create_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.create_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.create_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.delete_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.delete_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.delete_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.disable_advanced_site_search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.disable_advanced_site_search.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.disable_advanced_site_search.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.enable_advanced_site_search | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.enable_advanced_site_search.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.enable_advanced_site_search.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.fetch_domain_verification_status | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.get_site_search_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_site_search_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_site_search_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.get_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.get_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.list_target_sites | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.list_target_sites.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.list_target_sites.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Site_search_engine_service.recrawl_uris | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.recrawl_uris.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.recrawl_uris.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Site_search_engine_service.update_target_site | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.update_target_site.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/site_search_engine_service.update_target_site.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | User_event_service.collect_user_event | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.collect_user_event.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.collect_user_event.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | User_event_service.import_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.import_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.import_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | User_event_service.purge_user_events | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.purge_user_events.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/user_event_service.purge_user_events.js,packages/google-cloud-discoveryengine/samples/README.md) |

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

@@ -41,11 +41,6 @@ option (google.api.resource_definition) = {
   pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
   pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}"
 };
-option (google.api.resource_definition) = {
-  type: "discoveryengine.googleapis.com/SiteSearchEngine"
-  pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine"
-  pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine"
-};
 
 // The industry vertical associated with the
 // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].

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

@@ -36,6 +36,7 @@ message Conversation {
     type: "discoveryengine.googleapis.com/Conversation"
     pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}"
     pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}"
   };
 
   // Enumeration of the state of the conversation.
@@ -52,6 +53,8 @@ message Conversation {
 
   // Immutable. Fully qualified name
   // `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
+  // or
+  // `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
   string name = 1 [(google.api.field_behavior) = IMMUTABLE];
 
   // The state of the Conversation.

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

@@ -50,6 +50,10 @@ service ConversationalSearchService {
         post: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse"
         body: "*"
       }
+      additional_bindings {
+        post: "/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse"
+        body: "*"
+      }
     };
     option (google.api.method_signature) = "name,query";
   }
@@ -66,6 +70,10 @@ service ConversationalSearchService {
         post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
         body: "conversation"
       }
+      additional_bindings {
+        post: "/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/conversations"
+        body: "conversation"
+      }
     };
     option (google.api.method_signature) = "parent,conversation";
   }
@@ -81,6 +89,9 @@ service ConversationalSearchService {
       additional_bindings {
         delete: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
       }
+      additional_bindings {
+        delete: "/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}"
+      }
     };
     option (google.api.method_signature) = "name";
   }
@@ -99,6 +110,10 @@ service ConversationalSearchService {
         patch: "/v1alpha/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
         body: "conversation"
       }
+      additional_bindings {
+        patch: "/v1alpha/{conversation.name=projects/*/locations/*/collections/*/engines/*/conversations/*}"
+        body: "conversation"
+      }
     };
     option (google.api.method_signature) = "conversation,update_mask";
   }
@@ -110,6 +125,9 @@ service ConversationalSearchService {
       additional_bindings {
         get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
       }
+      additional_bindings {
+        get: "/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}"
+      }
     };
     option (google.api.method_signature) = "name";
   }
@@ -123,6 +141,9 @@ service ConversationalSearchService {
       additional_bindings {
         get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
       }
+      additional_bindings {
+        get: "/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*}/conversations"
+      }
     };
     option (google.api.method_signature) = "parent";
   }
@@ -184,6 +205,24 @@ message ConverseConversationRequest {
 
   // A specification for configuring the summary returned in the response.
   SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
+
+  // The filter syntax consists of an expression language for constructing a
+  // predicate from one or more fields of the documents being filtered. Filter
+  // expression is case-sensitive. This will be used to filter search results
+  // which may affect the summary response.
+  //
+  // If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+  //
+  // Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+  // key property defined in the Vertex AI Search backend -- this mapping is
+  // defined by the customer in their schema. For example a media customer might
+  // have a field 'name' in their schema. In this case the filter would look
+  // like this: filter --> name:'ANY("king kong")'
+  //
+  // For more information about filtering including syntax and filter
+  // operators, see
+  // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+  string filter = 9;
 }
 
 // Response message for

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

@@ -53,7 +53,7 @@ message Document {
 
       // The URI of the content. Only Cloud Storage URIs (e.g.
       // `gs://bucket-name/path/to/file`) are supported. The maximum file size
-      // is 100 MB.
+      // is 2.5 MB for text-based formats, 100 MB for other formats.
       string uri = 3;
     }
 

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

@@ -105,7 +105,7 @@ service EngineService {
   }
 
   // Resumes the training of an existing engine. Only applicable if
-  // [solution_type][] is
+  // [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is
   // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
   rpc ResumeEngine(ResumeEngineRequest) returns (Engine) {
     option (google.api.http) = {

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

@@ -321,6 +321,20 @@ message SearchRequest {
     // A specification for configuring a summary returned in a search
     // response.
     message SummarySpec {
+      // Specification of the prompt to use with the model.
+      message ModelPromptSpec {
+        // Text at the beginning of the prompt that instructs the assistant.
+        // Examples are available in the user guide.
+        string preamble = 1;
+      }
+
+      // Specification of the model.
+      message ModelSpec {
+        // The string format of the model version.
+        // e.g. stable, preview, etc.
+        string version = 1;
+      }
+
       // The number of top results to generate the summary from. If the number
       // of results returned is less than `summaryResultCount`, the summary is
       // generated from all of the results.
@@ -372,10 +386,18 @@ message SearchRequest {
       // fallback messages instead.
       bool ignore_non_summary_seeking_query = 4;
 
+      // If specified, the spec will be used to modify the prompt provided to
+      // the LLM.
+      ModelPromptSpec model_prompt_spec = 5;
+
       // Language code for Summary. Use language tags defined by
       // [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
       // Note: This is an experimental feature.
       string language_code = 6;
+
+      // If specified, the spec will be used to modify the model specification
+      // provided to the LLM.
+      ModelSpec model_spec = 7;
     }
 
     // A specification for configuring the extractive content in a search
@@ -535,6 +557,20 @@ message SearchRequest {
   // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
   string filter = 7;
 
+  // The default filter that is applied when a user performs a search without
+  // checking any filters on the search page.
+  //
+  // The filter applied to every search request when quality improvement such as
+  // query expansion is needed. In the case a query does not have a sufficient
+  // amount of results this filter will be used to determine whether or not to
+  // enable the query expansion flow. The original filter will still be used for
+  // the query expanded search.
+  // This field is strongly recommended to achieve high search quality.
+  //
+  // For more information about filter syntax, see
+  // [SearchRequest.filter][google.cloud.discoveryengine.v1alpha.SearchRequest.filter].
+  string canonical_filter = 29;
+
   // The order in which documents are returned. Documents can be ordered by
   // a field in an [Document][google.cloud.discoveryengine.v1alpha.Document]
   // object. Leave it unset if ordered by relevance. `order_by` expression is
@@ -743,6 +779,65 @@ message SearchResponse {
       repeated float scores = 2;
     }
 
+    // Citation metadata.
+    message CitationMetadata {
+      // Citations for segments.
+      repeated Citation citations = 1;
+    }
+
+    // Citation info for a segment.
+    message Citation {
+      // Index indicates the start of the segment, measured in bytes/unicode.
+      int64 start_index = 1;
+
+      // End of the attributed segment, exclusive.
+      int64 end_index = 2;
+
+      // Citation sources for the attributed segment.
+      repeated CitationSource sources = 3;
+    }
+
+    // Citation source.
+    message CitationSource {
+      // Document reference index from SummaryWithMetadata.references.
+      // It is 0-indexed and the value will be zero if the reference_index is
+      // not set explicitly.
+      int64 reference_index = 4;
+    }
+
+    // Document reference.
+    message Reference {
+      // Title of the document.
+      string title = 1;
+
+      // Required.
+      // [Document.name][google.cloud.discoveryengine.v1alpha.Document.name] of
+      // the document. Full resource name of the referenced document, in the
+      // format
+      // `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+      string document = 2 [
+        (google.api.field_behavior) = REQUIRED,
+        (google.api.resource_reference) = {
+          type: "discoveryengine.googleapis.com/Document"
+        }
+      ];
+
+      // GCS or HTTP uri for the document.
+      string uri = 3;
+    }
+
+    // Summary with metadata information.
+    message SummaryWithMetadata {
+      // Summary text with no citation information.
+      string summary = 1;
+
+      // Citation metadata for given summary.
+      CitationMetadata citation_metadata = 2;
+
+      // Document References.
+      repeated Reference references = 3;
+    }
+
     // An Enum for summary-skipped reasons.
     enum SummarySkippedReason {
       // Default value. The summary skipped reason is not specified.
@@ -791,6 +886,8 @@ message SearchResponse {
     // A collection of Safety Attribute categories and their associated
     // confidence scores.
     SafetyAttributes safety_attributes = 3;
+
+    SummaryWithMetadata summary_with_metadata = 4;
   }
 
   // Debug information specifically related to forward geocoding issues arising

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

@@ -0,0 +1,147 @@
+// 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/import_config.proto";
+import "google/longrunning/operations.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 = "SearchTuningServiceProto";
+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 search tuning.
+service SearchTuningService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Trains a custom model.
+  rpc TrainCustomModel(TrainCustomModelRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1alpha/{data_store=projects/*/locations/*/collections/*/dataStores/*}:trainCustomModel"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse"
+      metadata_type: "google.cloud.discoveryengine.v1alpha.TrainCustomModelMetadata"
+    };
+  }
+}
+
+// Request message for
+// [SearchTuningService.TrainCustomModel][google.cloud.discoveryengine.v1alpha.SearchTuningService.TrainCustomModel]
+// method.
+message TrainCustomModelRequest {
+  // Gcs training data input.
+  message GcsTrainingInput {
+    // The gcs corpus data which could be associated in train data.
+    // The data path format is gs://<bucket_to_data>/<jsonl_file_name>.
+    // 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"}
+    string corpus_data_path = 1;
+
+    // The gcs query data which could be associated in train data.
+    // The data path format is gs://<bucket_to_data>/<jsonl_file_name>.
+    // A newline delimited jsonl/ndjson file.
+    //  * For search-tuning model, each line should have the _id
+    //  and text. Example: {"_id": "query1",  "text": "example query"}
+    string query_data_path = 2;
+
+    // Gcs training data path whose format should be
+    // gs://<bucket_to_data>/<tsv_file_name>. The file should be in tsv format.
+    // Each line should have the doc_id and query_id and score (number).
+    //  * For search-tuning model, it should have the query-id corpus-id
+    //  score as tsv file header. The score should be a number in [0, inf+). The
+    //  larger the number is, the more relevant the pair is. Example:
+    //  query-id\tcorpus-id\tscore
+    //  query1\tdoc1\t1
+    string train_data_path = 3;
+
+    // Gcs test data. Same format as train_data_path. If not provided, a
+    // random 80/20 train/test split will be performed on train_data_path.
+    string test_data_path = 4;
+  }
+
+  // Model training input.
+  oneof training_input {
+    // Gcs training input.
+    GcsTrainingInput gcs_training_input = 2;
+  }
+
+  // Required. The resource name of the Data Store, such as
+  // `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
+  // This field is used to identify the data store where to train the models.
+  string data_store = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // Model to be trained. Supported values are:
+  //
+  //  * **search-tuning**: Fine tuning the search system based on data provided.
+  string model_type = 3;
+
+  // The desired location of errors incurred during the data ingestion and
+  // training.
+  ImportErrorConfig error_config = 4;
+}
+
+// Response of the
+// [TrainCustomModelRequest][google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest].
+// This message is returned by the google.longrunning.Operations.response field.
+message TrainCustomModelResponse {
+  // A sample of errors encountered while processing the data.
+  repeated google.rpc.Status error_samples = 1;
+
+  // Echoes the destination for the complete errors in the request if set.
+  ImportErrorConfig error_config = 2;
+
+  // The trained model status. Possible values are:
+  //
+  //  * **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.
+  //  * **ready**: The model is ready for serving.
+  string model_status = 3;
+}
+
+// Metadata related to the progress of the TrainCustomModel operation. This is
+// returned by the google.longrunning.Operation.metadata field.
+message TrainCustomModelMetadata {
+  // 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/v1alpha/site_search_engine.proto

@@ -0,0 +1,164 @@
+// 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 = "SiteSearchEngineProto";
+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";
+
+// SiteSearchEngine captures DataStore level site search persisting
+// configurations. It is a singleton value per data store.
+message SiteSearchEngine {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/SiteSearchEngine"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine"
+  };
+
+  // The fully qualified resource name of the site search engine.
+  // Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
+  string name = 1;
+}
+
+// A target site for the SiteSearchEngine.
+message TargetSite {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/TargetSite"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}"
+  };
+
+  // Site search indexing failure reasons.
+  message FailureReason {
+    message QuotaFailure {}
+
+    oneof failure {
+      // Failed due to insufficient quota.
+      QuotaFailure quota_failure = 1;
+    }
+  }
+
+  // Possible target site types.
+  enum Type {
+    // This value is unused. In this case, server behavior defaults to
+    // [Type.INCLUDE][google.cloud.discoveryengine.v1alpha.TargetSite.Type.INCLUDE].
+    TYPE_UNSPECIFIED = 0;
+
+    // Include the target site.
+    INCLUDE = 1;
+
+    // Exclude the target site.
+    EXCLUDE = 2;
+  }
+
+  // Target site indexing status enumeration.
+  enum IndexingStatus {
+    // Defaults to SUCCEEDED.
+    INDEXING_STATUS_UNSPECIFIED = 0;
+
+    // The target site is in the update queue and will be picked up by indexing
+    // pipeline.
+    PENDING = 1;
+
+    // The target site fails to be indexed.
+    FAILED = 2;
+
+    // The target site has been indexed.
+    SUCCEEDED = 3;
+
+    // The previously indexed target site has been marked to be deleted. This is
+    // a transitioning state which will resulted in either:
+    // 1. target site deleted if unindexing is successful;
+    // 2. state reverts to SUCCEEDED if the unindexing fails.
+    DELETING = 4;
+  }
+
+  // Output only. The fully qualified resource name of the target site.
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
+  // The `target_site_id` is system-generated.
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. Input only. The user provided URI pattern from which the
+  // `generated_uri_pattern` is generated.
+  string provided_uri_pattern = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = INPUT_ONLY
+  ];
+
+  // The type of the target site, e.g. whether the site is to be included or
+  // excluded.
+  Type type = 3;
+
+  // Input only. If set to false, a uri_pattern is generated to include all
+  // pages whose address contains the provided_uri_pattern. If set to true, an
+  // uri_pattern is generated to try to be an exact match of the
+  // provided_uri_pattern or just the specific page if the provided_uri_pattern
+  // is a specific one. provided_uri_pattern is always normalized to
+  // generate the URI pattern to be used by the search engine.
+  bool exact_match = 6 [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Output only. This is system-generated based on the provided_uri_pattern.
+  string generated_uri_pattern = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Site ownership and validity verification status.
+  SiteVerificationInfo site_verification_info = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indexing status.
+  IndexingStatus indexing_status = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The target site's last updated time.
+  google.protobuf.Timestamp update_time = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Failure reason.
+  FailureReason failure_reason = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Verification information for target sites in advanced site search.
+message SiteVerificationInfo {
+  // Site verification state.
+  enum SiteVerificationState {
+    // Defaults to VERIFIED.
+    SITE_VERIFICATION_STATE_UNSPECIFIED = 0;
+
+    // Site ownership verified.
+    VERIFIED = 1;
+
+    // Site ownership pending verification or verification failed.
+    UNVERIFIED = 2;
+
+    // Site exempt from verification, e.g. a public website that opens to all.
+    EXEMPTED = 3;
+  }
+
+  // Site verification state indicating the ownership and validity.
+  SiteVerificationState site_verification_state = 1;
+
+  // Latest site verification time.
+  google.protobuf.Timestamp verify_time = 2;
+}