@google-cloud/discoveryengine 3.2.0 → 3.3.0

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

@@ -38,7 +38,10 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
 service SearchService {
   option (google.api.default_host) = "discoveryengine.googleapis.com";
   option (google.api.oauth_scopes) =
-      "https://www.googleapis.com/auth/cloud-platform";
+      "https://www.googleapis.com/auth/cloud-platform,"
+      "https://www.googleapis.com/auth/discoveryengine.assist.readwrite,"
+      "https://www.googleapis.com/auth/discoveryengine.readwrite,"
+      "https://www.googleapis.com/auth/discoveryengine.serving.readwrite";
 
   // Performs a search.
   rpc Search(SearchRequest) returns (SearchResponse) {
@@ -91,6 +94,7 @@ service SearchService {
 message SearchRequest {
   // Specifies the image query input.
   message ImageQuery {
+    // Specifies the image bytes.
     oneof image {
       // Base64 encoded image bytes. Supported image formats: JPEG, PNG, and
       // BMP.
@@ -129,6 +133,14 @@ message SearchRequest {
     // search operators, see
     // [SearchOperators](https://support.google.com/cloudsearch/answer/6172299).
     string custom_search_operators = 7 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The maximum number of results to retrieve from this data store.
+    // If not specified, it will use the
+    // [SearchRequest.num_results_per_data_store][google.cloud.discoveryengine.v1.SearchRequest.num_results_per_data_store]
+    // if provided, otherwise there is no limit. If both this field and
+    // [SearchRequest.num_results_per_data_store][google.cloud.discoveryengine.v1.SearchRequest.num_results_per_data_store]
+    // are specified, this field will be used.
+    int32 num_results = 9 [(google.api.field_behavior) = OPTIONAL];
   }
 
   // A facet specification to perform faceted search.
@@ -737,9 +749,6 @@ message SearchRequest {
     // Field names used for location-based filtering, where geolocation filters
     // are detected in natural language search queries.
     // Only valid when the FilterExtractionCondition is set to `ENABLED`.
-    //
-    // If this field is set, it overrides the field names set in
-    // [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
     repeated string geo_search_query_detection_field_names = 2;
 
     // Optional. Controls behavior of how extracted filters are applied to the
@@ -769,6 +778,18 @@ message SearchRequest {
 
   // Specification for search as you type in search requests.
   message SearchAsYouTypeSpec {
+    // A schema field to be used for Search As You Type scoring on this
+    // request. Overrides any data-store-level Search As You Type field
+    // configuration for the duration of the request.
+    message Field {
+      // Required. A field key that has been indexed for Search As You Type.
+      string key = 1 [(google.api.field_behavior) = REQUIRED];
+
+      // Optional. Weight for scores from this field. Defaults to 1.0 if not
+      // specified.
+      optional double weight = 2 [(google.api.field_behavior) = OPTIONAL];
+    }
+
     // Enum describing under which condition search as you type should occur.
     enum Condition {
       // Server behavior defaults to
@@ -790,6 +811,14 @@ message SearchRequest {
     // Default to
     // [Condition.DISABLED][google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition.DISABLED].
     Condition condition = 1;
+
+    // Optional. The list of fields to be used for Search As You Type scoring.
+    repeated Field fields = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Search As You Type score threshold for filtering purpose.
+    // We keep the result if `score` >= `score_threshold`.
+    optional double score_threshold = 3
+        [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Specifies features for display, like match highlighting.
@@ -847,10 +876,6 @@ message SearchRequest {
   }
 
   // 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.
@@ -889,13 +914,6 @@ message SearchRequest {
     optional int32 search_result_persistence_count = 2;
   }
 
-  // The specification for returning the document relevance score.
-  message RelevanceScoreSpec {
-    // Optional. Whether to return the relevance score for search results.
-    // The higher the score, the more relevant the document is to the query.
-    bool return_relevance_score = 1 [(google.api.field_behavior) = OPTIONAL];
-  }
-
   // Relevance filtering specification.
   message RelevanceFilterSpec {
     // Specification for relevance filtering on a specific sub-search.
@@ -921,6 +939,43 @@ message SearchRequest {
         [(google.api.field_behavior) = OPTIONAL];
   }
 
+  // The specification for returning the document relevance score.
+  message RelevanceScoreSpec {
+    // Optional. Whether to return the relevance score for search results.
+    // The higher the score, the more relevant the document is to the query.
+    bool return_relevance_score = 1 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // SearchAddonSpec is used to disable add-ons for search as per new
+  // repricing model. By default if the SearchAddonSpec is not specified, we
+  // consider that the customer wants to enable them wherever applicable.
+  message SearchAddonSpec {
+    // Optional. If true, semantic add-on is disabled. Semantic add-on includes
+    // embeddings and jetstream.
+    bool disable_semantic_add_on = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. If true, disables event re-ranking and personalization to
+    // optimize KPIs & personalize results.
+    bool disable_kpi_personalization_add_on = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. If true, generative answer add-on is disabled. Generative
+    // answer add-on includes natural language to filters and simple answers.
+    bool disable_generative_answer_add_on = 3
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Configuration parameters for the Custom Ranking feature.
+  message CustomRankingParams {
+    // Optional. A list of ranking expressions (see `ranking_expression` for the
+    // syntax documentation) to evaluate. The evaluation results will be
+    // returned in
+    // `SearchResponse.SearchResult.rank_signals.precomputed_expression_values`
+    // field.
+    repeated string expressions_to_precompute = 1
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
   // The backend to use for the ranking expression evaluation.
   enum RankingExpressionBackend {
     // Default option for unspecified/unknown values.
@@ -1060,6 +1115,13 @@ message SearchRequest {
   // used.
   repeated DataStoreSpec data_store_specs = 32;
 
+  // Optional. The maximum number of results to retrieve from each data store.
+  // If not specified, it will use the
+  // [SearchRequest.DataStoreSpec.num_results][google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec.num_results]
+  // if provided, otherwise there is no limit.
+  int32 num_results_per_data_store = 65
+      [(google.api.field_behavior) = OPTIONAL];
+
   // 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.
@@ -1263,6 +1325,15 @@ message SearchRequest {
   //   Google model to determine the keyword-based overlap between the query and
   //   the document.
   //   * `base_rank`: the default rank of the result
+  //   * `media_actor_match`: whether the media actor matches the query
+  //   * `media_director_match`: whether the media director matches the query
+  //   * `media_genre_match`: whether the media genre matches the query
+  //   * `media_language_match`: whether the media language matches the query
+  //   * `media_title_match`: whether the media title matches the query
+  //   * `media_prefix_similarity_rank`: prefix similarity rank for media
+  //   results
+  //   * `media_semantic_similarity_rank`: semantic similarity rank for media
+  //   results
   string ranking_expression = 26 [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. The backend to use for the ranking expression evaluation.
@@ -1339,10 +1410,6 @@ message SearchRequest {
   //   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.
-  //
-  // 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"
   }];
@@ -1377,6 +1444,24 @@ message SearchRequest {
   // Optional. The specification for returning the relevance score.
   RelevanceScoreSpec relevance_score_spec = 52
       [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. SearchAddonSpec is used to disable add-ons for search as per new
+  // repricing model.
+  // This field is only supported for search requests.
+  SearchAddonSpec search_addon_spec = 62
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Optional configuration for the Custom Ranking feature.
+  CustomRankingParams custom_ranking_params = 64
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The entity for customers that may run multiple different
+  // entities, domains, sites or regions, for example, "Google US", "Google
+  // Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
+  // be exactly matched with
+  // [UserEvent.entity][google.cloud.discoveryengine.v1.UserEvent.entity] to get
+  // search results boosted by entity.
+  string entity = 66 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response message for
@@ -1429,6 +1514,36 @@ message SearchResponse {
       // Optional. A list of custom clearbox signals.
       repeated CustomSignal custom_signals = 33
           [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. A list of precomputed expression results for a given
+      // document, in the same order as requested in
+      // `SearchRequest.custom_ranking_params.expressions_to_precompute`.
+      repeated float precomputed_expression_values = 34
+          [(google.api.field_behavior) = OPTIONAL];
+    }
+
+    // Contains a set of signals used by the relevance filter.
+    message RetrievalSignals {
+      // Indicates the source of the retrieval.
+      enum RetrievalSource {
+        // Unspecified retrieval source.
+        RETRIEVAL_SOURCE_UNSPECIFIED = 0;
+
+        // Indicates the result was retrieved by keyword search.
+        KEYWORD_SEARCH = 1;
+
+        // Indicates the result was retrieved by semantic search.
+        SEMANTIC_SEARCH = 2;
+      }
+
+      // Optional. Indicates how the result was retrieved.
+      repeated RetrievalSource retrieval_sources = 1
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. Relevance score used by the filter when
+      // semantic_relevance_threshold is set.
+      float semantic_relevance_score = 2
+          [(google.api.field_behavior) = OPTIONAL];
     }
 
     // [Document.id][google.cloud.discoveryengine.v1.Document.id] of the
@@ -1451,6 +1566,11 @@ message SearchResponse {
 
     // Optional. A set of ranking signals associated with the result.
     RankSignals rank_signals = 7 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. A set of signals used by the relevance filter meant for use to
+    // fine-tune the relevance filter thresholds.
+    RetrievalSignals retrieval_signals = 11
+        [(google.api.field_behavior) = OPTIONAL];
   }
 
   // A facet result.
@@ -1874,6 +1994,14 @@ message SearchResponse {
   // is set.
   Summary summary = 9;
 
+  // Optional. Controls applied as part of the Control service.
+  repeated string applied_controls = 10 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Control"
+    }
+  ];
+
   // Query expansion information for the returned results.
   QueryExpansionInfo query_expansion_info = 14;