@google-cloud/discoveryengine 1.9.0 → 1.10.0

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"
+      }
     };
   }