feat(discoveryengine): update the api

#### discoveryengine:v1alpha The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaChunk (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec.properties.searchResultMode.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult.properties.chunk.$ref (Total Keys: 1)
googleapis · Mar 12, 2024 · 3e175d8 · 3e175d8
1 parent 48b30d7
commit 3e175d8
Show file tree

Hide file tree

Showing 11 changed files with 313 additions and 8 deletions.
diff --git a/docs/dyn/discoveryengine_v1alpha.locations.html b/docs/dyn/discoveryengine_v1alpha.locations.html
@@ -130,6 +130,7 @@ <h3>Method Details</h3>
         &quot;numNextSegments&quot;: 42, # Return at most `num_next_segments` segments after each selected segments.
         &quot;numPreviousSegments&quot;: 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
       },
+      &quot;searchResultMode&quot;: &quot;A String&quot;, # 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`.
       &quot;snippetSpec&quot;: { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
         &quot;maxSnippetCount&quot;: 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count &gt; 0.
         &quot;referenceOnly&quot;: True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
@@ -203,7 +204,7 @@ <h3>Method Details</h3>
     &quot;dataStore&quot;: &quot;A String&quot;, # Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
     &quot;includeTailSuggestions&quot;: True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
     &quot;query&quot;: &quot;A String&quot;, # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
-    &quot;queryModel&quot;: &quot;A String&quot;, # Specifies the autocomplete data model. This overrides any model specified in the Configuration &gt; Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
+    &quot;queryModel&quot;: &quot;A String&quot;, # Specifies the autocomplete data model. This overrides any model specified in the Configuration &gt; Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. *
     &quot;userPseudoId&quot;: &quot;A String&quot;, # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   },
   &quot;configId&quot;: &quot;A String&quot;, # Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query.
@@ -485,6 +486,18 @@ <h3>Method Details</h3>
     },
     &quot;searchResults&quot;: [ # Search Results.
       { # Represents the search results.
+        &quot;chunk&quot;: { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          &quot;content&quot;: &quot;A String&quot;, # Content is a string from a document (parsed content).
+          &quot;derivedStructData&quot;: { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
+            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+          },
+          &quot;documentMetadata&quot;: { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
+            &quot;title&quot;: &quot;A String&quot;, # Title of the document.
+            &quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
+          },
+          &quot;id&quot;: &quot;A String&quot;, # Unique chunk id of the current chunk.
+          &quot;name&quot;: &quot;A String&quot;, # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        },
         &quot;document&quot;: { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
           &quot;aclInfo&quot;: { # ACL Information of the Document. # Access control information for the document.
             &quot;readers&quot;: [
@@ -563,6 +576,7 @@ <h3>Method Details</h3>
         &quot;numNextSegments&quot;: 42, # Return at most `num_next_segments` segments after each selected segments.
         &quot;numPreviousSegments&quot;: 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
       },
+      &quot;searchResultMode&quot;: &quot;A String&quot;, # 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`.
       &quot;snippetSpec&quot;: { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
         &quot;maxSnippetCount&quot;: 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count &gt; 0.
         &quot;referenceOnly&quot;: True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
@@ -717,6 +731,18 @@ <h3>Method Details</h3>
     &quot;redirectUri&quot;: &quot;A String&quot;, # The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
     &quot;results&quot;: [ # A list of matched documents. The order represents the ranking.
       { # Represents the search results.
+        &quot;chunk&quot;: { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          &quot;content&quot;: &quot;A String&quot;, # Content is a string from a document (parsed content).
+          &quot;derivedStructData&quot;: { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
+            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+          },
+          &quot;documentMetadata&quot;: { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
+            &quot;title&quot;: &quot;A String&quot;, # Title of the document.
+            &quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
+          },
+          &quot;id&quot;: &quot;A String&quot;, # Unique chunk id of the current chunk.
+          &quot;name&quot;: &quot;A String&quot;, # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        },
         &quot;document&quot;: { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
           &quot;aclInfo&quot;: { # ACL Information of the Document. # Access control information for the document.
             &quot;readers&quot;: [

diff --git a/.../dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/.../dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
@@ -353,6 +353,18 @@ <h3>Method Details</h3>
   },
   &quot;searchResults&quot;: [ # Search Results.
     { # Represents the search results.
+      &quot;chunk&quot;: { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+        &quot;content&quot;: &quot;A String&quot;, # Content is a string from a document (parsed content).
+        &quot;derivedStructData&quot;: { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
+          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+        },
+        &quot;documentMetadata&quot;: { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
+          &quot;title&quot;: &quot;A String&quot;, # Title of the document.
+          &quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
+        },
+        &quot;id&quot;: &quot;A String&quot;, # Unique chunk id of the current chunk.
+        &quot;name&quot;: &quot;A String&quot;, # The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      },
       &quot;document&quot;: { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
         &quot;aclInfo&quot;: { # ACL Information of the Document. # Access control information for the document.
           &quot;readers&quot;: [