@google-cloud/discoveryengine 2.0.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +7 -2
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +54 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +2 -1
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +35 -6
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +113 -2
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +168 -2
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +23 -4
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +7 -2
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +16 -3
  12. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +70 -9
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +20 -1
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +9 -5
  15. package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +3 -1
  16. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -2
  17. package/build/protos/google/cloud/discoveryengine/v1/safety.proto +107 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +96 -8
  19. package/build/protos/google/cloud/discoveryengine/v1/serving_config.proto +271 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/serving_config_service.proto +75 -0
  21. package/build/protos/google/cloud/discoveryengine/v1/session.proto +19 -0
  22. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +27 -3
  23. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +184 -5
  24. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +34 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +16 -4
  26. package/build/protos/protos.d.ts +4390 -300
  27. package/build/protos/protos.js +13785 -2922
  28. package/build/protos/protos.json +1355 -14
  29. package/build/src/index.d.ts +4 -1
  30. package/build/src/index.js +4 -21
  31. package/build/src/v1/completion_service_client.d.ts +313 -76
  32. package/build/src/v1/completion_service_client.js +451 -262
  33. package/build/src/v1/completion_service_proto_list.json +3 -0
  34. package/build/src/v1/control_service_client.d.ts +318 -81
  35. package/build/src/v1/control_service_client.js +422 -132
  36. package/build/src/v1/control_service_proto_list.json +3 -0
  37. package/build/src/v1/conversational_search_service_client.d.ts +341 -134
  38. package/build/src/v1/conversational_search_service_client.js +395 -223
  39. package/build/src/v1/conversational_search_service_client_config.json +5 -0
  40. package/build/src/v1/conversational_search_service_proto_list.json +3 -0
  41. package/build/src/v1/data_store_service_client.d.ts +359 -122
  42. package/build/src/v1/data_store_service_client.js +460 -280
  43. package/build/src/v1/data_store_service_proto_list.json +3 -0
  44. package/build/src/v1/document_service_client.d.ts +364 -121
  45. package/build/src/v1/document_service_client.js +469 -300
  46. package/build/src/v1/document_service_proto_list.json +3 -0
  47. package/build/src/v1/engine_service_client.d.ts +340 -103
  48. package/build/src/v1/engine_service_client.js +460 -279
  49. package/build/src/v1/engine_service_proto_list.json +3 -0
  50. package/build/src/v1/gapic_metadata.json +59 -0
  51. package/build/src/v1/grounded_generation_service_client.d.ts +286 -51
  52. package/build/src/v1/grounded_generation_service_client.js +405 -100
  53. package/build/src/v1/grounded_generation_service_proto_list.json +3 -0
  54. package/build/src/v1/index.d.ts +1 -0
  55. package/build/src/v1/index.js +3 -1
  56. package/build/src/v1/project_service_client.d.ts +313 -76
  57. package/build/src/v1/project_service_client.js +434 -222
  58. package/build/src/v1/project_service_proto_list.json +3 -0
  59. package/build/src/v1/rank_service_client.d.ts +285 -48
  60. package/build/src/v1/rank_service_client.js +398 -85
  61. package/build/src/v1/rank_service_proto_list.json +3 -0
  62. package/build/src/v1/recommendation_service_client.d.ts +142 -49
  63. package/build/src/v1/recommendation_service_client.js +198 -82
  64. package/build/src/v1/recommendation_service_proto_list.json +3 -0
  65. package/build/src/v1/schema_service_client.d.ts +348 -111
  66. package/build/src/v1/schema_service_client.js +457 -273
  67. package/build/src/v1/schema_service_proto_list.json +3 -0
  68. package/build/src/v1/search_service_client.d.ts +748 -559
  69. package/build/src/v1/search_service_client.js +302 -133
  70. package/build/src/v1/search_service_proto_list.json +3 -0
  71. package/build/src/v1/search_tuning_service_client.d.ts +314 -77
  72. package/build/src/v1/search_tuning_service_client.js +439 -235
  73. package/build/src/v1/search_tuning_service_proto_list.json +3 -0
  74. package/build/src/v1/serving_config_service_client.d.ts +1851 -0
  75. package/build/src/v1/serving_config_service_client.js +2642 -0
  76. package/build/src/v1/serving_config_service_client_config.json +30 -0
  77. package/build/src/v1/serving_config_service_proto_list.json +39 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +504 -151
  79. package/build/src/v1/site_search_engine_service_client.js +625 -351
  80. package/build/src/v1/site_search_engine_service_client_config.json +12 -0
  81. package/build/src/v1/site_search_engine_service_proto_list.json +3 -0
  82. package/build/src/v1/user_event_service_client.d.ts +335 -86
  83. package/build/src/v1/user_event_service_client.js +447 -253
  84. package/build/src/v1/user_event_service_proto_list.json +3 -0
  85. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  86. package/build/src/v1alpha/acl_config_service_client.js +82 -106
  87. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  88. package/build/src/v1alpha/chunk_service_client.js +92 -120
  89. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  90. package/build/src/v1alpha/completion_service_client.js +134 -280
  91. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  92. package/build/src/v1alpha/control_service_client.js +105 -151
  93. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  94. package/build/src/v1alpha/conversational_search_service_client.js +145 -237
  95. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  96. package/build/src/v1alpha/data_store_service_client.js +151 -316
  97. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  98. package/build/src/v1alpha/document_service_client.js +156 -328
  99. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  100. package/build/src/v1alpha/engine_service_client.js +155 -325
  101. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  102. package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
  103. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  104. package/build/src/v1alpha/evaluation_service_client.js +143 -295
  105. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  106. package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
  107. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  108. package/build/src/v1alpha/project_service_client.js +126 -262
  109. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  110. package/build/src/v1alpha/rank_service_client.js +81 -104
  111. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  112. package/build/src/v1alpha/recommendation_service_client.js +79 -100
  113. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  114. package/build/src/v1alpha/sample_query_service_client.js +144 -301
  115. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  116. package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
  117. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  118. package/build/src/v1alpha/schema_service_client.js +140 -292
  119. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  120. package/build/src/v1alpha/search_service_client.js +88 -112
  121. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  122. package/build/src/v1alpha/search_tuning_service_client.js +122 -253
  123. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  124. package/build/src/v1alpha/serving_config_service_client.js +97 -133
  125. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  126. package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
  127. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  128. package/build/src/v1alpha/user_event_service_client.js +130 -271
  129. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  130. package/build/src/v1beta/completion_service_client.js +136 -279
  131. package/build/src/v1beta/control_service_client.d.ts +84 -84
  132. package/build/src/v1beta/control_service_client.js +103 -147
  133. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  134. package/build/src/v1beta/conversational_search_service_client.js +143 -233
  135. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  136. package/build/src/v1beta/data_store_service_client.js +141 -288
  137. package/build/src/v1beta/document_service_client.d.ts +124 -124
  138. package/build/src/v1beta/document_service_client.js +150 -309
  139. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  140. package/build/src/v1beta/engine_service_client.js +153 -315
  141. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  142. package/build/src/v1beta/evaluation_service_client.js +141 -285
  143. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  144. package/build/src/v1beta/grounded_generation_service_client.js +86 -114
  145. package/build/src/v1beta/project_service_client.d.ts +76 -76
  146. package/build/src/v1beta/project_service_client.js +115 -231
  147. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  148. package/build/src/v1beta/rank_service_client.js +79 -99
  149. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  150. package/build/src/v1beta/recommendation_service_client.js +77 -96
  151. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  152. package/build/src/v1beta/sample_query_service_client.js +142 -291
  153. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  154. package/build/src/v1beta/sample_query_set_service_client.js +104 -149
  155. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  156. package/build/src/v1beta/schema_service_client.js +138 -282
  157. package/build/src/v1beta/search_service_client.d.ts +665 -665
  158. package/build/src/v1beta/search_service_client.js +97 -128
  159. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  160. package/build/src/v1beta/search_tuning_service_client.js +120 -243
  161. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  162. package/build/src/v1beta/serving_config_service_client.js +95 -129
  163. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  164. package/build/src/v1beta/site_search_engine_service_client.js +186 -386
  165. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  166. package/build/src/v1beta/user_event_service_client.js +128 -261
  167. package/package.json +4 -4
@@ -117,471 +117,258 @@ export declare class SearchServiceClient {
117
117
  getProjectId(): Promise<string>;
118
118
  getProjectId(callback: Callback<string, undefined, undefined>): void;
119
119
  /**
120
- * Performs a search.
121
- *
122
- * @param {Object} request
123
- * The request object that will be sent.
124
- * @param {string} request.servingConfig
125
- * Required. The resource name of the Search serving config, such as
126
- * `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
127
- * or
128
- * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
129
- * This field is used to identify the serving configuration name, set
130
- * of models used to make the search.
131
- * @param {string} request.branch
132
- * The branch resource name, such as
133
- * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
134
- *
135
- * Use `default_branch` as the branch ID or leave this field empty, to search
136
- * documents under the default branch.
137
- * @param {string} request.query
138
- * Raw search query.
139
- * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
140
- * Raw image query.
141
- * @param {number} request.pageSize
142
- * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
143
- * return. The maximum allowed value depends on the data type. Values above
144
- * the maximum value are coerced to the maximum value.
145
- *
146
- * * Websites with basic indexing: Default `10`, Maximum `25`.
147
- * * Websites with advanced indexing: Default `25`, Maximum `50`.
148
- * * Other: Default `50`, Maximum `100`.
149
- *
150
- * If this field is negative, an `INVALID_ARGUMENT` is returned.
151
- * @param {string} request.pageToken
152
- * A page token received from a previous
153
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
154
- * call. Provide this to retrieve the subsequent page.
155
- *
156
- * When paginating, all other parameters provided to
157
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
158
- * must match the call that provided the page token. Otherwise, an
159
- * `INVALID_ARGUMENT` error is returned.
160
- * @param {number} request.offset
161
- * A 0-indexed integer that specifies the current offset (that is, starting
162
- * result location, amongst the
163
- * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
164
- * relevant) in search results. This field is only considered if
165
- * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
166
- * unset.
167
- *
168
- * If this field is negative, an `INVALID_ARGUMENT` is returned.
169
- * @param {number} request.oneBoxPageSize
170
- * The maximum number of results to return for OneBox.
171
- * This applies to each OneBox type individually.
172
- * Default number is 10.
173
- * @param {number[]} request.dataStoreSpecs
174
- * Specs defining dataStores to filter on in a search call and configurations
175
- * for those dataStores. This is only considered for engines with multiple
176
- * dataStores use case. For single dataStore within an engine, they should
177
- * use the specs at the top level.
178
- * @param {string} request.filter
179
- * The filter syntax consists of an expression language for constructing a
180
- * predicate from one or more fields of the documents being filtered. Filter
181
- * expression is case-sensitive.
182
- *
183
- * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
184
- *
185
- * Filtering in Vertex AI Search is done by mapping the LHS filter key to a
186
- * key property defined in the Vertex AI Search backend -- this mapping is
187
- * defined by the customer in their schema. For example a media customer might
188
- * have a field 'name' in their schema. In this case the filter would look
189
- * like this: filter --> name:'ANY("king kong")'
190
- *
191
- * For more information about filtering including syntax and filter
192
- * operators, see
193
- * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
194
- * @param {string} request.canonicalFilter
195
- * The default filter that is applied when a user performs a search without
196
- * checking any filters on the search page.
197
- *
198
- * The filter applied to every search request when quality improvement such as
199
- * query expansion is needed. In the case a query does not have a sufficient
200
- * amount of results this filter will be used to determine whether or not to
201
- * enable the query expansion flow. The original filter will still be used for
202
- * the query expanded search.
203
- * This field is strongly recommended to achieve high search quality.
204
- *
205
- * For more information about filter syntax, see
206
- * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.filter|SearchRequest.filter}.
207
- * @param {string} request.orderBy
208
- * The order in which documents are returned. Documents can be ordered by
209
- * a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
210
- * Leave it unset if ordered by relevance. `order_by` expression is
211
- * case-sensitive.
212
- *
213
- * For more information on ordering the website search results, see
214
- * [Order web search
215
- * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
216
- * For more information on ordering the healthcare search results, see
217
- * [Order healthcare search
218
- * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
219
- * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
220
- * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
221
- * Information about the end user.
222
- * Highly recommended for analytics.
223
- * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
224
- * is used to deduce `device_type` for analytics.
225
- * @param {string} request.languageCode
226
- * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
227
- * information, see [Standard
228
- * fields](https://cloud.google.com/apis/design/standard_fields). This field
229
- * helps to better interpret the query. If a value isn't specified, the query
230
- * language code is automatically detected, which may not be accurate.
231
- * @param {number[]} request.facetSpecs
232
- * Facet specifications for faceted search. If empty, no facets are returned.
233
- *
234
- * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
235
- * error is returned.
236
- * @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
237
- * Boost specification to boost certain documents.
238
- * For more information on boosting, see
239
- * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
240
- * @param {number[]} request.params
241
- * Additional search parameters.
242
- *
243
- * For public website search only, supported values are:
244
- *
245
- * * `user_country_code`: string. Default empty. If set to non-empty, results
246
- * are restricted or boosted based on the location provided.
247
- * For example, `user_country_code: "au"`
248
- *
249
- * For available codes see [Country
250
- * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
251
- *
252
- * * `search_type`: double. Default empty. Enables non-webpage searching
253
- * depending on the value. The only valid non-default value is 1,
254
- * which enables image searching.
255
- * For example, `search_type: 1`
256
- * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
257
- * The query expansion specification that specifies the conditions under which
258
- * query expansion occurs.
259
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
260
- * The spell correction specification that specifies the mode under
261
- * which spell correction takes effect.
262
- * @param {string} request.userPseudoId
263
- * A unique identifier for tracking visitors. For example, this could be
264
- * implemented with an HTTP cookie, which should be able to uniquely identify
265
- * a visitor on a single device. This unique identifier should not change if
266
- * the visitor logs in or out of the website.
267
- *
268
- * This field should NOT have a fixed value such as `unknown_visitor`.
269
- *
270
- * This should be the same identifier as
271
- * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
272
- * and
273
- * {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
274
- *
275
- * The field must be a UTF-8 encoded string with a length limit of 128
276
- * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
277
- * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
278
- * A specification for configuring the behavior of content search.
279
- * @param {boolean} request.safeSearch
280
- * Whether to turn on safe search. This is only supported for
281
- * website search.
282
- * @param {number[]} request.userLabels
283
- * The user labels applied to a resource must meet the following requirements:
284
- *
285
- * * Each resource can have multiple labels, up to a maximum of 64.
286
- * * Each label must be a key-value pair.
287
- * * Keys have a minimum length of 1 character and a maximum length of 63
288
- * characters and cannot be empty. Values can be empty and have a maximum
289
- * length of 63 characters.
290
- * * Keys and values can contain only lowercase letters, numeric characters,
291
- * underscores, and dashes. All characters must use UTF-8 encoding, and
292
- * international characters are allowed.
293
- * * The key portion of a label must be unique. However, you can use the same
294
- * key with multiple resources.
295
- * * Keys must start with a lowercase letter or international character.
296
- *
297
- * See [Google Cloud
298
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
299
- * for more details.
300
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
301
- * Search as you type configuration. Only supported for the
302
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
303
- * vertical.
304
- * @param {string} request.session
305
- * The session resource name. Optional.
306
- *
307
- * Session allows users to do multi-turn /search API calls or coordination
308
- * between /search API calls and /answer API calls.
309
- *
310
- * Example #1 (multi-turn /search API calls):
311
- * 1. Call /search API with the auto-session mode (see below).
312
- * 2. Call /search API with the session ID generated in the first call.
313
- * Here, the previous search query gets considered in query
314
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
315
- * and the current query is "How about 2023?", the current query will
316
- * be interpreted as "How did Alphabet do in 2023?".
317
- *
318
- * Example #2 (coordination between /search API calls and /answer API calls):
319
- * 1. Call /search API with the auto-session mode (see below).
320
- * 2. Call /answer API with the session ID generated in the first call.
321
- * Here, the answer generation happens in the context of the search
322
- * results from the first search call.
323
- *
324
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
325
- * gets automatically created. Otherwise, users can use the create-session API
326
- * to create a session manually.
327
- *
328
- * Multi-turn Search feature is currently at private GA stage. Please use
329
- * v1alpha or v1beta version instead before we launch this feature to public
330
- * GA. Or ask for allowlisting through Google Support team.
331
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
332
- * Session specification.
333
- *
334
- * Can be used only when `session` is set.
335
- * @param {object} [options]
336
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
337
- * @returns {Promise} - The promise which resolves to an array.
338
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}.
339
- * The client library will perform auto-pagination by default: it will call the API as many
340
- * times as needed and will merge results from all the pages into this array.
341
- * Note that it can affect your quota.
342
- * We recommend using `searchAsync()`
343
- * method described below for async iteration which you can stop as needed.
344
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
345
- * for more details and examples.
346
- */
347
- search(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Promise<[
348
- protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult[],
349
- protos.google.cloud.discoveryengine.v1.ISearchRequest | null,
350
- protos.google.cloud.discoveryengine.v1.ISearchResponse
351
- ]>;
352
- search(request: protos.google.cloud.discoveryengine.v1.ISearchRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.ISearchRequest, protos.google.cloud.discoveryengine.v1.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>): void;
353
- search(request: protos.google.cloud.discoveryengine.v1.ISearchRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.ISearchRequest, protos.google.cloud.discoveryengine.v1.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>): void;
354
- /**
355
- * Equivalent to `search`, but returns a NodeJS Stream object.
356
- * @param {Object} request
357
- * The request object that will be sent.
358
- * @param {string} request.servingConfig
359
- * Required. The resource name of the Search serving config, such as
360
- * `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
361
- * or
362
- * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
363
- * This field is used to identify the serving configuration name, set
364
- * of models used to make the search.
365
- * @param {string} request.branch
366
- * The branch resource name, such as
367
- * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
368
- *
369
- * Use `default_branch` as the branch ID or leave this field empty, to search
370
- * documents under the default branch.
371
- * @param {string} request.query
372
- * Raw search query.
373
- * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
374
- * Raw image query.
375
- * @param {number} request.pageSize
376
- * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
377
- * return. The maximum allowed value depends on the data type. Values above
378
- * the maximum value are coerced to the maximum value.
379
- *
380
- * * Websites with basic indexing: Default `10`, Maximum `25`.
381
- * * Websites with advanced indexing: Default `25`, Maximum `50`.
382
- * * Other: Default `50`, Maximum `100`.
383
- *
384
- * If this field is negative, an `INVALID_ARGUMENT` is returned.
385
- * @param {string} request.pageToken
386
- * A page token received from a previous
387
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
388
- * call. Provide this to retrieve the subsequent page.
389
- *
390
- * When paginating, all other parameters provided to
391
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
392
- * must match the call that provided the page token. Otherwise, an
393
- * `INVALID_ARGUMENT` error is returned.
394
- * @param {number} request.offset
395
- * A 0-indexed integer that specifies the current offset (that is, starting
396
- * result location, amongst the
397
- * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
398
- * relevant) in search results. This field is only considered if
399
- * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
400
- * unset.
401
- *
402
- * If this field is negative, an `INVALID_ARGUMENT` is returned.
403
- * @param {number} request.oneBoxPageSize
404
- * The maximum number of results to return for OneBox.
405
- * This applies to each OneBox type individually.
406
- * Default number is 10.
407
- * @param {number[]} request.dataStoreSpecs
408
- * Specs defining dataStores to filter on in a search call and configurations
409
- * for those dataStores. This is only considered for engines with multiple
410
- * dataStores use case. For single dataStore within an engine, they should
411
- * use the specs at the top level.
412
- * @param {string} request.filter
413
- * The filter syntax consists of an expression language for constructing a
414
- * predicate from one or more fields of the documents being filtered. Filter
415
- * expression is case-sensitive.
416
- *
417
- * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
418
- *
419
- * Filtering in Vertex AI Search is done by mapping the LHS filter key to a
420
- * key property defined in the Vertex AI Search backend -- this mapping is
421
- * defined by the customer in their schema. For example a media customer might
422
- * have a field 'name' in their schema. In this case the filter would look
423
- * like this: filter --> name:'ANY("king kong")'
424
- *
425
- * For more information about filtering including syntax and filter
426
- * operators, see
427
- * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
428
- * @param {string} request.canonicalFilter
429
- * The default filter that is applied when a user performs a search without
430
- * checking any filters on the search page.
431
- *
432
- * The filter applied to every search request when quality improvement such as
433
- * query expansion is needed. In the case a query does not have a sufficient
434
- * amount of results this filter will be used to determine whether or not to
435
- * enable the query expansion flow. The original filter will still be used for
436
- * the query expanded search.
437
- * This field is strongly recommended to achieve high search quality.
438
- *
439
- * For more information about filter syntax, see
440
- * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.filter|SearchRequest.filter}.
441
- * @param {string} request.orderBy
442
- * The order in which documents are returned. Documents can be ordered by
443
- * a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
444
- * Leave it unset if ordered by relevance. `order_by` expression is
445
- * case-sensitive.
446
- *
447
- * For more information on ordering the website search results, see
448
- * [Order web search
449
- * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
450
- * For more information on ordering the healthcare search results, see
451
- * [Order healthcare search
452
- * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
453
- * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
454
- * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
455
- * Information about the end user.
456
- * Highly recommended for analytics.
457
- * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
458
- * is used to deduce `device_type` for analytics.
459
- * @param {string} request.languageCode
460
- * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
461
- * information, see [Standard
462
- * fields](https://cloud.google.com/apis/design/standard_fields). This field
463
- * helps to better interpret the query. If a value isn't specified, the query
464
- * language code is automatically detected, which may not be accurate.
465
- * @param {number[]} request.facetSpecs
466
- * Facet specifications for faceted search. If empty, no facets are returned.
467
- *
468
- * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
469
- * error is returned.
470
- * @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
471
- * Boost specification to boost certain documents.
472
- * For more information on boosting, see
473
- * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
474
- * @param {number[]} request.params
475
- * Additional search parameters.
476
- *
477
- * For public website search only, supported values are:
478
- *
479
- * * `user_country_code`: string. Default empty. If set to non-empty, results
480
- * are restricted or boosted based on the location provided.
481
- * For example, `user_country_code: "au"`
482
- *
483
- * For available codes see [Country
484
- * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
485
- *
486
- * * `search_type`: double. Default empty. Enables non-webpage searching
487
- * depending on the value. The only valid non-default value is 1,
488
- * which enables image searching.
489
- * For example, `search_type: 1`
490
- * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
491
- * The query expansion specification that specifies the conditions under which
492
- * query expansion occurs.
493
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
494
- * The spell correction specification that specifies the mode under
495
- * which spell correction takes effect.
496
- * @param {string} request.userPseudoId
497
- * A unique identifier for tracking visitors. For example, this could be
498
- * implemented with an HTTP cookie, which should be able to uniquely identify
499
- * a visitor on a single device. This unique identifier should not change if
500
- * the visitor logs in or out of the website.
501
- *
502
- * This field should NOT have a fixed value such as `unknown_visitor`.
503
- *
504
- * This should be the same identifier as
505
- * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
506
- * and
507
- * {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
508
- *
509
- * The field must be a UTF-8 encoded string with a length limit of 128
510
- * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
511
- * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
512
- * A specification for configuring the behavior of content search.
513
- * @param {boolean} request.safeSearch
514
- * Whether to turn on safe search. This is only supported for
515
- * website search.
516
- * @param {number[]} request.userLabels
517
- * The user labels applied to a resource must meet the following requirements:
518
- *
519
- * * Each resource can have multiple labels, up to a maximum of 64.
520
- * * Each label must be a key-value pair.
521
- * * Keys have a minimum length of 1 character and a maximum length of 63
522
- * characters and cannot be empty. Values can be empty and have a maximum
523
- * length of 63 characters.
524
- * * Keys and values can contain only lowercase letters, numeric characters,
525
- * underscores, and dashes. All characters must use UTF-8 encoding, and
526
- * international characters are allowed.
527
- * * The key portion of a label must be unique. However, you can use the same
528
- * key with multiple resources.
529
- * * Keys must start with a lowercase letter or international character.
530
- *
531
- * See [Google Cloud
532
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
533
- * for more details.
534
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
535
- * Search as you type configuration. Only supported for the
536
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
537
- * vertical.
538
- * @param {string} request.session
539
- * The session resource name. Optional.
540
- *
541
- * Session allows users to do multi-turn /search API calls or coordination
542
- * between /search API calls and /answer API calls.
543
- *
544
- * Example #1 (multi-turn /search API calls):
545
- * 1. Call /search API with the auto-session mode (see below).
546
- * 2. Call /search API with the session ID generated in the first call.
547
- * Here, the previous search query gets considered in query
548
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
549
- * and the current query is "How about 2023?", the current query will
550
- * be interpreted as "How did Alphabet do in 2023?".
551
- *
552
- * Example #2 (coordination between /search API calls and /answer API calls):
553
- * 1. Call /search API with the auto-session mode (see below).
554
- * 2. Call /answer API with the session ID generated in the first call.
555
- * Here, the answer generation happens in the context of the search
556
- * results from the first search call.
557
- *
558
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
559
- * gets automatically created. Otherwise, users can use the create-session API
560
- * to create a session manually.
561
- *
562
- * Multi-turn Search feature is currently at private GA stage. Please use
563
- * v1alpha or v1beta version instead before we launch this feature to public
564
- * GA. Or ask for allowlisting through Google Support team.
565
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
566
- * Session specification.
567
- *
568
- * Can be used only when `session` is set.
569
- * @param {object} [options]
570
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
571
- * @returns {Stream}
572
- * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult} on 'data' event.
573
- * The client library will perform auto-pagination by default: it will call the API as many
574
- * times as needed. Note that it can affect your quota.
575
- * We recommend using `searchAsync()`
576
- * method described below for async iteration which you can stop as needed.
577
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
578
- * for more details and examples.
579
- */
580
- searchStream(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Transform;
120
+ * Performs a search.
121
+ *
122
+ * @param {Object} request
123
+ * The request object that will be sent.
124
+ * @param {string} request.servingConfig
125
+ * Required. The resource name of the Search serving config, such as
126
+ * `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
127
+ * or
128
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
129
+ * This field is used to identify the serving configuration name, set
130
+ * of models used to make the search.
131
+ * @param {string} request.branch
132
+ * The branch resource name, such as
133
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
134
+ *
135
+ * Use `default_branch` as the branch ID or leave this field empty, to search
136
+ * documents under the default branch.
137
+ * @param {string} request.query
138
+ * Raw search query.
139
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
140
+ * Raw image query.
141
+ * @param {number} request.pageSize
142
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
143
+ * return. The maximum allowed value depends on the data type. Values above
144
+ * the maximum value are coerced to the maximum value.
145
+ *
146
+ * * Websites with basic indexing: Default `10`, Maximum `25`.
147
+ * * Websites with advanced indexing: Default `25`, Maximum `50`.
148
+ * * Other: Default `50`, Maximum `100`.
149
+ *
150
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
151
+ * @param {string} request.pageToken
152
+ * A page token received from a previous
153
+ * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
154
+ * call. Provide this to retrieve the subsequent page.
155
+ *
156
+ * When paginating, all other parameters provided to
157
+ * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
158
+ * must match the call that provided the page token. Otherwise, an
159
+ * `INVALID_ARGUMENT` error is returned.
160
+ * @param {number} request.offset
161
+ * A 0-indexed integer that specifies the current offset (that is, starting
162
+ * result location, amongst the
163
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
164
+ * relevant) in search results. This field is only considered if
165
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
166
+ * unset.
167
+ *
168
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
169
+ * @param {number} request.oneBoxPageSize
170
+ * The maximum number of results to return for OneBox.
171
+ * This applies to each OneBox type individually.
172
+ * Default number is 10.
173
+ * @param {number[]} request.dataStoreSpecs
174
+ * Specifications that define the specific
175
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
176
+ * along with configurations for those data stores. This is only considered
177
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
178
+ * stores. For engines with a single data store, the specs directly under
179
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
180
+ * used.
181
+ * @param {string} request.filter
182
+ * The filter syntax consists of an expression language for constructing a
183
+ * predicate from one or more fields of the documents being filtered. Filter
184
+ * expression is case-sensitive.
185
+ *
186
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
187
+ *
188
+ * Filtering in Vertex AI Search is done by mapping the LHS filter key to a
189
+ * key property defined in the Vertex AI Search backend -- this mapping is
190
+ * defined by the customer in their schema. For example a media customer might
191
+ * have a field 'name' in their schema. In this case the filter would look
192
+ * like this: filter --> name:'ANY("king kong")'
193
+ *
194
+ * For more information about filtering including syntax and filter
195
+ * operators, see
196
+ * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
197
+ * @param {string} request.canonicalFilter
198
+ * The default filter that is applied when a user performs a search without
199
+ * checking any filters on the search page.
200
+ *
201
+ * The filter applied to every search request when quality improvement such as
202
+ * query expansion is needed. In the case a query does not have a sufficient
203
+ * amount of results this filter will be used to determine whether or not to
204
+ * enable the query expansion flow. The original filter will still be used for
205
+ * the query expanded search.
206
+ * This field is strongly recommended to achieve high search quality.
207
+ *
208
+ * For more information about filter syntax, see
209
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.filter|SearchRequest.filter}.
210
+ * @param {string} request.orderBy
211
+ * The order in which documents are returned. Documents can be ordered by
212
+ * a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
213
+ * Leave it unset if ordered by relevance. `order_by` expression is
214
+ * case-sensitive.
215
+ *
216
+ * For more information on ordering the website search results, see
217
+ * [Order web search
218
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
219
+ * For more information on ordering the healthcare search results, see
220
+ * [Order healthcare search
221
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
222
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
223
+ * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
224
+ * Information about the end user.
225
+ * Highly recommended for analytics and personalization.
226
+ * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
227
+ * is used to deduce `device_type` for analytics.
228
+ * @param {string} request.languageCode
229
+ * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
230
+ * information, see [Standard
231
+ * fields](https://cloud.google.com/apis/design/standard_fields). This field
232
+ * helps to better interpret the query. If a value isn't specified, the query
233
+ * language code is automatically detected, which may not be accurate.
234
+ * @param {number[]} request.facetSpecs
235
+ * Facet specifications for faceted search. If empty, no facets are returned.
236
+ *
237
+ * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
238
+ * error is returned.
239
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
240
+ * Boost specification to boost certain documents.
241
+ * For more information on boosting, see
242
+ * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
243
+ * @param {number[]} request.params
244
+ * Additional search parameters.
245
+ *
246
+ * For public website search only, supported values are:
247
+ *
248
+ * * `user_country_code`: string. Default empty. If set to non-empty, results
249
+ * are restricted or boosted based on the location provided.
250
+ * For example, `user_country_code: "au"`
251
+ *
252
+ * For available codes see [Country
253
+ * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
254
+ *
255
+ * * `search_type`: double. Default empty. Enables non-webpage searching
256
+ * depending on the value. The only valid non-default value is 1,
257
+ * which enables image searching.
258
+ * For example, `search_type: 1`
259
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
260
+ * The query expansion specification that specifies the conditions under which
261
+ * query expansion occurs.
262
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
263
+ * The spell correction specification that specifies the mode under
264
+ * which spell correction takes effect.
265
+ * @param {string} request.userPseudoId
266
+ * A unique identifier for tracking visitors. For example, this could be
267
+ * implemented with an HTTP cookie, which should be able to uniquely identify
268
+ * a visitor on a single device. This unique identifier should not change if
269
+ * the visitor logs in or out of the website.
270
+ *
271
+ * This field should NOT have a fixed value such as `unknown_visitor`.
272
+ *
273
+ * This should be the same identifier as
274
+ * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
275
+ * and
276
+ * {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
277
+ *
278
+ * The field must be a UTF-8 encoded string with a length limit of 128
279
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
280
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
281
+ * A specification for configuring the behavior of content search.
282
+ * @param {boolean} request.safeSearch
283
+ * Whether to turn on safe search. This is only supported for
284
+ * website search.
285
+ * @param {number[]} request.userLabels
286
+ * The user labels applied to a resource must meet the following requirements:
287
+ *
288
+ * * Each resource can have multiple labels, up to a maximum of 64.
289
+ * * Each label must be a key-value pair.
290
+ * * Keys have a minimum length of 1 character and a maximum length of 63
291
+ * characters and cannot be empty. Values can be empty and have a maximum
292
+ * length of 63 characters.
293
+ * * Keys and values can contain only lowercase letters, numeric characters,
294
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
295
+ * international characters are allowed.
296
+ * * The key portion of a label must be unique. However, you can use the same
297
+ * key with multiple resources.
298
+ * * Keys must start with a lowercase letter or international character.
299
+ *
300
+ * See [Google Cloud
301
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
302
+ * for more details.
303
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
304
+ * Search as you type configuration. Only supported for the
305
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
306
+ * vertical.
307
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
308
+ * Optional. Config for display feature, like match highlighting on search
309
+ * results.
310
+ * @param {string} request.session
311
+ * The session resource name. Optional.
312
+ *
313
+ * Session allows users to do multi-turn /search API calls or coordination
314
+ * between /search API calls and /answer API calls.
315
+ *
316
+ * Example #1 (multi-turn /search API calls):
317
+ * 1. Call /search API with the auto-session mode (see below).
318
+ * 2. Call /search API with the session ID generated in the first call.
319
+ * Here, the previous search query gets considered in query
320
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
321
+ * and the current query is "How about 2023?", the current query will
322
+ * be interpreted as "How did Alphabet do in 2023?".
323
+ *
324
+ * Example #2 (coordination between /search API calls and /answer API calls):
325
+ * 1. Call /search API with the auto-session mode (see below).
326
+ * 2. Call /answer API with the session ID generated in the first call.
327
+ * Here, the answer generation happens in the context of the search
328
+ * results from the first search call.
329
+ *
330
+ * Auto-session mode: when `projects/.../sessions/-` is used, a new session
331
+ * gets automatically created. Otherwise, users can use the create-session API
332
+ * to create a session manually.
333
+ *
334
+ * Multi-turn Search feature is currently at private GA stage. Please use
335
+ * v1alpha or v1beta version instead before we launch this feature to public
336
+ * GA. Or ask for allowlisting through Google Support team.
337
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
338
+ * Session specification.
339
+ *
340
+ * Can be used only when `session` is set.
341
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
342
+ * The relevance threshold of the search results.
343
+ *
344
+ * Default to Google defined threshold, leveraging a balance of
345
+ * precision and recall to deliver both highly accurate results and
346
+ * comprehensive coverage of relevant information.
347
+ *
348
+ * This feature is not supported for healthcare search.
349
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
350
+ * Optional. The specification for returning the relevance score.
351
+ * @param {object} [options]
352
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
353
+ * @returns {Promise} - The promise which resolves to an array.
354
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}.
355
+ * The client library will perform auto-pagination by default: it will call the API as many
356
+ * times as needed and will merge results from all the pages into this array.
357
+ * Note that it can affect your quota.
358
+ * We recommend using `searchAsync()`
359
+ * method described below for async iteration which you can stop as needed.
360
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
361
+ * for more details and examples.
362
+ */
363
+ search(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Promise<[
364
+ protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult[],
365
+ protos.google.cloud.discoveryengine.v1.ISearchRequest | null,
366
+ protos.google.cloud.discoveryengine.v1.ISearchResponse
367
+ ]>;
368
+ search(request: protos.google.cloud.discoveryengine.v1.ISearchRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.ISearchRequest, protos.google.cloud.discoveryengine.v1.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>): void;
369
+ search(request: protos.google.cloud.discoveryengine.v1.ISearchRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.ISearchRequest, protos.google.cloud.discoveryengine.v1.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>): void;
581
370
  /**
582
- * Equivalent to `search`, but returns an iterable object.
583
- *
584
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
371
+ * Equivalent to `search`, but returns a NodeJS Stream object.
585
372
  * @param {Object} request
586
373
  * The request object that will be sent.
587
374
  * @param {string} request.servingConfig
@@ -634,10 +421,13 @@ export declare class SearchServiceClient {
634
421
  * This applies to each OneBox type individually.
635
422
  * Default number is 10.
636
423
  * @param {number[]} request.dataStoreSpecs
637
- * Specs defining dataStores to filter on in a search call and configurations
638
- * for those dataStores. This is only considered for engines with multiple
639
- * dataStores use case. For single dataStore within an engine, they should
640
- * use the specs at the top level.
424
+ * Specifications that define the specific
425
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
426
+ * along with configurations for those data stores. This is only considered
427
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
428
+ * stores. For engines with a single data store, the specs directly under
429
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
430
+ * used.
641
431
  * @param {string} request.filter
642
432
  * The filter syntax consists of an expression language for constructing a
643
433
  * predicate from one or more fields of the documents being filtered. Filter
@@ -682,7 +472,7 @@ export declare class SearchServiceClient {
682
472
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
683
473
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
684
474
  * Information about the end user.
685
- * Highly recommended for analytics.
475
+ * Highly recommended for analytics and personalization.
686
476
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
687
477
  * is used to deduce `device_type` for analytics.
688
478
  * @param {string} request.languageCode
@@ -764,6 +554,9 @@ export declare class SearchServiceClient {
764
554
  * Search as you type configuration. Only supported for the
765
555
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
766
556
  * vertical.
557
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
558
+ * Optional. Config for display feature, like match highlighting on search
559
+ * results.
767
560
  * @param {string} request.session
768
561
  * The session resource name. Optional.
769
562
  *
@@ -795,34 +588,32 @@ export declare class SearchServiceClient {
795
588
  * Session specification.
796
589
  *
797
590
  * Can be used only when `session` is set.
591
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
592
+ * The relevance threshold of the search results.
593
+ *
594
+ * Default to Google defined threshold, leveraging a balance of
595
+ * precision and recall to deliver both highly accurate results and
596
+ * comprehensive coverage of relevant information.
597
+ *
598
+ * This feature is not supported for healthcare search.
599
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
600
+ * Optional. The specification for returning the relevance score.
798
601
  * @param {object} [options]
799
602
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
800
- * @returns {Object}
801
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
802
- * When you iterate the returned iterable, each element will be an object representing
803
- * {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
804
- * so you can stop the iteration when you don't need more results.
603
+ * @returns {Stream}
604
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult} on 'data' event.
605
+ * The client library will perform auto-pagination by default: it will call the API as many
606
+ * times as needed. Note that it can affect your quota.
607
+ * We recommend using `searchAsync()`
608
+ * method described below for async iteration which you can stop as needed.
805
609
  * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
806
610
  * for more details and examples.
807
- * @example <caption>include:samples/generated/v1/search_service.search.js</caption>
808
- * region_tag:discoveryengine_v1_generated_SearchService_Search_async
809
611
  */
810
- searchAsync(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>;
612
+ searchStream(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Transform;
811
613
  /**
812
- * Performs a search. Similar to the
813
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
814
- * method, but a lite version that allows API key for authentication, where
815
- * OAuth and IAM checks are not required.
816
- *
817
- * Only public website search is supported by this method. If data stores and
818
- * engines not associated with public website search are specified, a
819
- * `FAILED_PRECONDITION` error is returned.
820
- *
821
- * This method can be used for easy onboarding without having to implement an
822
- * authentication backend. However, it is strongly recommended to use
823
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
824
- * instead with required OAuth and IAM checks to provide better data security.
614
+ * Equivalent to `search`, but returns an iterable object.
825
615
  *
616
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
826
617
  * @param {Object} request
827
618
  * The request object that will be sent.
828
619
  * @param {string} request.servingConfig
@@ -875,10 +666,13 @@ export declare class SearchServiceClient {
875
666
  * This applies to each OneBox type individually.
876
667
  * Default number is 10.
877
668
  * @param {number[]} request.dataStoreSpecs
878
- * Specs defining dataStores to filter on in a search call and configurations
879
- * for those dataStores. This is only considered for engines with multiple
880
- * dataStores use case. For single dataStore within an engine, they should
881
- * use the specs at the top level.
669
+ * Specifications that define the specific
670
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
671
+ * along with configurations for those data stores. This is only considered
672
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
673
+ * stores. For engines with a single data store, the specs directly under
674
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
675
+ * used.
882
676
  * @param {string} request.filter
883
677
  * The filter syntax consists of an expression language for constructing a
884
678
  * predicate from one or more fields of the documents being filtered. Filter
@@ -923,7 +717,7 @@ export declare class SearchServiceClient {
923
717
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
924
718
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
925
719
  * Information about the end user.
926
- * Highly recommended for analytics.
720
+ * Highly recommended for analytics and personalization.
927
721
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
928
722
  * is used to deduce `device_type` for analytics.
929
723
  * @param {string} request.languageCode
@@ -1005,6 +799,9 @@ export declare class SearchServiceClient {
1005
799
  * Search as you type configuration. Only supported for the
1006
800
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1007
801
  * vertical.
802
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
803
+ * Optional. Config for display feature, like match highlighting on search
804
+ * results.
1008
805
  * @param {string} request.session
1009
806
  * The session resource name. Optional.
1010
807
  *
@@ -1036,18 +833,285 @@ export declare class SearchServiceClient {
1036
833
  * Session specification.
1037
834
  *
1038
835
  * Can be used only when `session` is set.
836
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
837
+ * The relevance threshold of the search results.
838
+ *
839
+ * Default to Google defined threshold, leveraging a balance of
840
+ * precision and recall to deliver both highly accurate results and
841
+ * comprehensive coverage of relevant information.
842
+ *
843
+ * This feature is not supported for healthcare search.
844
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
845
+ * Optional. The specification for returning the relevance score.
1039
846
  * @param {object} [options]
1040
847
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1041
- * @returns {Promise} - The promise which resolves to an array.
1042
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}.
1043
- * The client library will perform auto-pagination by default: it will call the API as many
1044
- * times as needed and will merge results from all the pages into this array.
1045
- * Note that it can affect your quota.
1046
- * We recommend using `searchLiteAsync()`
1047
- * method described below for async iteration which you can stop as needed.
848
+ * @returns {Object}
849
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
850
+ * When you iterate the returned iterable, each element will be an object representing
851
+ * {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
852
+ * so you can stop the iteration when you don't need more results.
1048
853
  * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1049
854
  * for more details and examples.
855
+ * @example <caption>include:samples/generated/v1/search_service.search.js</caption>
856
+ * region_tag:discoveryengine_v1_generated_SearchService_Search_async
1050
857
  */
858
+ searchAsync(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>;
859
+ /**
860
+ * Performs a search. Similar to the
861
+ * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
862
+ * method, but a lite version that allows API key for authentication, where
863
+ * OAuth and IAM checks are not required.
864
+ *
865
+ * Only public website search is supported by this method. If data stores and
866
+ * engines not associated with public website search are specified, a
867
+ * `FAILED_PRECONDITION` error is returned.
868
+ *
869
+ * This method can be used for easy onboarding without having to implement an
870
+ * authentication backend. However, it is strongly recommended to use
871
+ * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
872
+ * instead with required OAuth and IAM checks to provide better data security.
873
+ *
874
+ * @param {Object} request
875
+ * The request object that will be sent.
876
+ * @param {string} request.servingConfig
877
+ * Required. The resource name of the Search serving config, such as
878
+ * `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
879
+ * or
880
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
881
+ * This field is used to identify the serving configuration name, set
882
+ * of models used to make the search.
883
+ * @param {string} request.branch
884
+ * The branch resource name, such as
885
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
886
+ *
887
+ * Use `default_branch` as the branch ID or leave this field empty, to search
888
+ * documents under the default branch.
889
+ * @param {string} request.query
890
+ * Raw search query.
891
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
892
+ * Raw image query.
893
+ * @param {number} request.pageSize
894
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
895
+ * return. The maximum allowed value depends on the data type. Values above
896
+ * the maximum value are coerced to the maximum value.
897
+ *
898
+ * * Websites with basic indexing: Default `10`, Maximum `25`.
899
+ * * Websites with advanced indexing: Default `25`, Maximum `50`.
900
+ * * Other: Default `50`, Maximum `100`.
901
+ *
902
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
903
+ * @param {string} request.pageToken
904
+ * A page token received from a previous
905
+ * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
906
+ * call. Provide this to retrieve the subsequent page.
907
+ *
908
+ * When paginating, all other parameters provided to
909
+ * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
910
+ * must match the call that provided the page token. Otherwise, an
911
+ * `INVALID_ARGUMENT` error is returned.
912
+ * @param {number} request.offset
913
+ * A 0-indexed integer that specifies the current offset (that is, starting
914
+ * result location, amongst the
915
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
916
+ * relevant) in search results. This field is only considered if
917
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
918
+ * unset.
919
+ *
920
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
921
+ * @param {number} request.oneBoxPageSize
922
+ * The maximum number of results to return for OneBox.
923
+ * This applies to each OneBox type individually.
924
+ * Default number is 10.
925
+ * @param {number[]} request.dataStoreSpecs
926
+ * Specifications that define the specific
927
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
928
+ * along with configurations for those data stores. This is only considered
929
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
930
+ * stores. For engines with a single data store, the specs directly under
931
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
932
+ * used.
933
+ * @param {string} request.filter
934
+ * The filter syntax consists of an expression language for constructing a
935
+ * predicate from one or more fields of the documents being filtered. Filter
936
+ * expression is case-sensitive.
937
+ *
938
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
939
+ *
940
+ * Filtering in Vertex AI Search is done by mapping the LHS filter key to a
941
+ * key property defined in the Vertex AI Search backend -- this mapping is
942
+ * defined by the customer in their schema. For example a media customer might
943
+ * have a field 'name' in their schema. In this case the filter would look
944
+ * like this: filter --> name:'ANY("king kong")'
945
+ *
946
+ * For more information about filtering including syntax and filter
947
+ * operators, see
948
+ * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
949
+ * @param {string} request.canonicalFilter
950
+ * The default filter that is applied when a user performs a search without
951
+ * checking any filters on the search page.
952
+ *
953
+ * The filter applied to every search request when quality improvement such as
954
+ * query expansion is needed. In the case a query does not have a sufficient
955
+ * amount of results this filter will be used to determine whether or not to
956
+ * enable the query expansion flow. The original filter will still be used for
957
+ * the query expanded search.
958
+ * This field is strongly recommended to achieve high search quality.
959
+ *
960
+ * For more information about filter syntax, see
961
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.filter|SearchRequest.filter}.
962
+ * @param {string} request.orderBy
963
+ * The order in which documents are returned. Documents can be ordered by
964
+ * a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
965
+ * Leave it unset if ordered by relevance. `order_by` expression is
966
+ * case-sensitive.
967
+ *
968
+ * For more information on ordering the website search results, see
969
+ * [Order web search
970
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
971
+ * For more information on ordering the healthcare search results, see
972
+ * [Order healthcare search
973
+ * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
974
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
975
+ * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
976
+ * Information about the end user.
977
+ * Highly recommended for analytics and personalization.
978
+ * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
979
+ * is used to deduce `device_type` for analytics.
980
+ * @param {string} request.languageCode
981
+ * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
982
+ * information, see [Standard
983
+ * fields](https://cloud.google.com/apis/design/standard_fields). This field
984
+ * helps to better interpret the query. If a value isn't specified, the query
985
+ * language code is automatically detected, which may not be accurate.
986
+ * @param {number[]} request.facetSpecs
987
+ * Facet specifications for faceted search. If empty, no facets are returned.
988
+ *
989
+ * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
990
+ * error is returned.
991
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
992
+ * Boost specification to boost certain documents.
993
+ * For more information on boosting, see
994
+ * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
995
+ * @param {number[]} request.params
996
+ * Additional search parameters.
997
+ *
998
+ * For public website search only, supported values are:
999
+ *
1000
+ * * `user_country_code`: string. Default empty. If set to non-empty, results
1001
+ * are restricted or boosted based on the location provided.
1002
+ * For example, `user_country_code: "au"`
1003
+ *
1004
+ * For available codes see [Country
1005
+ * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
1006
+ *
1007
+ * * `search_type`: double. Default empty. Enables non-webpage searching
1008
+ * depending on the value. The only valid non-default value is 1,
1009
+ * which enables image searching.
1010
+ * For example, `search_type: 1`
1011
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
1012
+ * The query expansion specification that specifies the conditions under which
1013
+ * query expansion occurs.
1014
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
1015
+ * The spell correction specification that specifies the mode under
1016
+ * which spell correction takes effect.
1017
+ * @param {string} request.userPseudoId
1018
+ * A unique identifier for tracking visitors. For example, this could be
1019
+ * implemented with an HTTP cookie, which should be able to uniquely identify
1020
+ * a visitor on a single device. This unique identifier should not change if
1021
+ * the visitor logs in or out of the website.
1022
+ *
1023
+ * This field should NOT have a fixed value such as `unknown_visitor`.
1024
+ *
1025
+ * This should be the same identifier as
1026
+ * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
1027
+ * and
1028
+ * {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
1029
+ *
1030
+ * The field must be a UTF-8 encoded string with a length limit of 128
1031
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
1032
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
1033
+ * A specification for configuring the behavior of content search.
1034
+ * @param {boolean} request.safeSearch
1035
+ * Whether to turn on safe search. This is only supported for
1036
+ * website search.
1037
+ * @param {number[]} request.userLabels
1038
+ * The user labels applied to a resource must meet the following requirements:
1039
+ *
1040
+ * * Each resource can have multiple labels, up to a maximum of 64.
1041
+ * * Each label must be a key-value pair.
1042
+ * * Keys have a minimum length of 1 character and a maximum length of 63
1043
+ * characters and cannot be empty. Values can be empty and have a maximum
1044
+ * length of 63 characters.
1045
+ * * Keys and values can contain only lowercase letters, numeric characters,
1046
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
1047
+ * international characters are allowed.
1048
+ * * The key portion of a label must be unique. However, you can use the same
1049
+ * key with multiple resources.
1050
+ * * Keys must start with a lowercase letter or international character.
1051
+ *
1052
+ * See [Google Cloud
1053
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
1054
+ * for more details.
1055
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
1056
+ * Search as you type configuration. Only supported for the
1057
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1058
+ * vertical.
1059
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1060
+ * Optional. Config for display feature, like match highlighting on search
1061
+ * results.
1062
+ * @param {string} request.session
1063
+ * The session resource name. Optional.
1064
+ *
1065
+ * Session allows users to do multi-turn /search API calls or coordination
1066
+ * between /search API calls and /answer API calls.
1067
+ *
1068
+ * Example #1 (multi-turn /search API calls):
1069
+ * 1. Call /search API with the auto-session mode (see below).
1070
+ * 2. Call /search API with the session ID generated in the first call.
1071
+ * Here, the previous search query gets considered in query
1072
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1073
+ * and the current query is "How about 2023?", the current query will
1074
+ * be interpreted as "How did Alphabet do in 2023?".
1075
+ *
1076
+ * Example #2 (coordination between /search API calls and /answer API calls):
1077
+ * 1. Call /search API with the auto-session mode (see below).
1078
+ * 2. Call /answer API with the session ID generated in the first call.
1079
+ * Here, the answer generation happens in the context of the search
1080
+ * results from the first search call.
1081
+ *
1082
+ * Auto-session mode: when `projects/.../sessions/-` is used, a new session
1083
+ * gets automatically created. Otherwise, users can use the create-session API
1084
+ * to create a session manually.
1085
+ *
1086
+ * Multi-turn Search feature is currently at private GA stage. Please use
1087
+ * v1alpha or v1beta version instead before we launch this feature to public
1088
+ * GA. Or ask for allowlisting through Google Support team.
1089
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
1090
+ * Session specification.
1091
+ *
1092
+ * Can be used only when `session` is set.
1093
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1094
+ * The relevance threshold of the search results.
1095
+ *
1096
+ * Default to Google defined threshold, leveraging a balance of
1097
+ * precision and recall to deliver both highly accurate results and
1098
+ * comprehensive coverage of relevant information.
1099
+ *
1100
+ * This feature is not supported for healthcare search.
1101
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1102
+ * Optional. The specification for returning the relevance score.
1103
+ * @param {object} [options]
1104
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1105
+ * @returns {Promise} - The promise which resolves to an array.
1106
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}.
1107
+ * The client library will perform auto-pagination by default: it will call the API as many
1108
+ * times as needed and will merge results from all the pages into this array.
1109
+ * Note that it can affect your quota.
1110
+ * We recommend using `searchLiteAsync()`
1111
+ * method described below for async iteration which you can stop as needed.
1112
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1113
+ * for more details and examples.
1114
+ */
1051
1115
  searchLite(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Promise<[
1052
1116
  protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult[],
1053
1117
  protos.google.cloud.discoveryengine.v1.ISearchRequest | null,
@@ -1109,10 +1173,13 @@ export declare class SearchServiceClient {
1109
1173
  * This applies to each OneBox type individually.
1110
1174
  * Default number is 10.
1111
1175
  * @param {number[]} request.dataStoreSpecs
1112
- * Specs defining dataStores to filter on in a search call and configurations
1113
- * for those dataStores. This is only considered for engines with multiple
1114
- * dataStores use case. For single dataStore within an engine, they should
1115
- * use the specs at the top level.
1176
+ * Specifications that define the specific
1177
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
1178
+ * along with configurations for those data stores. This is only considered
1179
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
1180
+ * stores. For engines with a single data store, the specs directly under
1181
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
1182
+ * used.
1116
1183
  * @param {string} request.filter
1117
1184
  * The filter syntax consists of an expression language for constructing a
1118
1185
  * predicate from one or more fields of the documents being filtered. Filter
@@ -1157,7 +1224,7 @@ export declare class SearchServiceClient {
1157
1224
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1158
1225
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
1159
1226
  * Information about the end user.
1160
- * Highly recommended for analytics.
1227
+ * Highly recommended for analytics and personalization.
1161
1228
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
1162
1229
  * is used to deduce `device_type` for analytics.
1163
1230
  * @param {string} request.languageCode
@@ -1239,6 +1306,9 @@ export declare class SearchServiceClient {
1239
1306
  * Search as you type configuration. Only supported for the
1240
1307
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1241
1308
  * vertical.
1309
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1310
+ * Optional. Config for display feature, like match highlighting on search
1311
+ * results.
1242
1312
  * @param {string} request.session
1243
1313
  * The session resource name. Optional.
1244
1314
  *
@@ -1270,6 +1340,16 @@ export declare class SearchServiceClient {
1270
1340
  * Session specification.
1271
1341
  *
1272
1342
  * Can be used only when `session` is set.
1343
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1344
+ * The relevance threshold of the search results.
1345
+ *
1346
+ * Default to Google defined threshold, leveraging a balance of
1347
+ * precision and recall to deliver both highly accurate results and
1348
+ * comprehensive coverage of relevant information.
1349
+ *
1350
+ * This feature is not supported for healthcare search.
1351
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1352
+ * Optional. The specification for returning the relevance score.
1273
1353
  * @param {object} [options]
1274
1354
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1275
1355
  * @returns {Stream}
@@ -1338,10 +1418,13 @@ export declare class SearchServiceClient {
1338
1418
  * This applies to each OneBox type individually.
1339
1419
  * Default number is 10.
1340
1420
  * @param {number[]} request.dataStoreSpecs
1341
- * Specs defining dataStores to filter on in a search call and configurations
1342
- * for those dataStores. This is only considered for engines with multiple
1343
- * dataStores use case. For single dataStore within an engine, they should
1344
- * use the specs at the top level.
1421
+ * Specifications that define the specific
1422
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
1423
+ * along with configurations for those data stores. This is only considered
1424
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
1425
+ * stores. For engines with a single data store, the specs directly under
1426
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
1427
+ * used.
1345
1428
  * @param {string} request.filter
1346
1429
  * The filter syntax consists of an expression language for constructing a
1347
1430
  * predicate from one or more fields of the documents being filtered. Filter
@@ -1386,7 +1469,7 @@ export declare class SearchServiceClient {
1386
1469
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1387
1470
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
1388
1471
  * Information about the end user.
1389
- * Highly recommended for analytics.
1472
+ * Highly recommended for analytics and personalization.
1390
1473
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
1391
1474
  * is used to deduce `device_type` for analytics.
1392
1475
  * @param {string} request.languageCode
@@ -1468,6 +1551,9 @@ export declare class SearchServiceClient {
1468
1551
  * Search as you type configuration. Only supported for the
1469
1552
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1470
1553
  * vertical.
1554
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1555
+ * Optional. Config for display feature, like match highlighting on search
1556
+ * results.
1471
1557
  * @param {string} request.session
1472
1558
  * The session resource name. Optional.
1473
1559
  *
@@ -1499,6 +1585,16 @@ export declare class SearchServiceClient {
1499
1585
  * Session specification.
1500
1586
  *
1501
1587
  * Can be used only when `session` is set.
1588
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1589
+ * The relevance threshold of the search results.
1590
+ *
1591
+ * Default to Google defined threshold, leveraging a balance of
1592
+ * precision and recall to deliver both highly accurate results and
1593
+ * comprehensive coverage of relevant information.
1594
+ *
1595
+ * This feature is not supported for healthcare search.
1596
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1597
+ * Optional. The specification for returning the relevance score.
1502
1598
  * @param {object} [options]
1503
1599
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1504
1600
  * @returns {Object}
@@ -1513,55 +1609,55 @@ export declare class SearchServiceClient {
1513
1609
  */
1514
1610
  searchLiteAsync(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>;
1515
1611
  /**
1516
- * Gets information about a location.
1517
- *
1518
- * @param {Object} request
1519
- * The request object that will be sent.
1520
- * @param {string} request.name
1521
- * Resource name for the location.
1522
- * @param {object} [options]
1523
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
1524
- * @returns {Promise} - The promise which resolves to an array.
1525
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
1526
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
1527
- * for more details and examples.
1528
- * @example
1529
- * ```
1530
- * const [response] = await client.getLocation(request);
1531
- * ```
1532
- */
1612
+ * Gets information about a location.
1613
+ *
1614
+ * @param {Object} request
1615
+ * The request object that will be sent.
1616
+ * @param {string} request.name
1617
+ * Resource name for the location.
1618
+ * @param {object} [options]
1619
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
1620
+ * @returns {Promise} - The promise which resolves to an array.
1621
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
1622
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
1623
+ * for more details and examples.
1624
+ * @example
1625
+ * ```
1626
+ * const [response] = await client.getLocation(request);
1627
+ * ```
1628
+ */
1533
1629
  getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
1534
1630
  /**
1535
- * Lists information about the supported locations for this service. Returns an iterable object.
1536
- *
1537
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1538
- * @param {Object} request
1539
- * The request object that will be sent.
1540
- * @param {string} request.name
1541
- * The resource that owns the locations collection, if applicable.
1542
- * @param {string} request.filter
1543
- * The standard list filter.
1544
- * @param {number} request.pageSize
1545
- * The standard list page size.
1546
- * @param {string} request.pageToken
1547
- * The standard list page token.
1548
- * @param {object} [options]
1549
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1550
- * @returns {Object}
1551
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1552
- * When you iterate the returned iterable, each element will be an object representing
1553
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
1554
- * so you can stop the iteration when you don't need more results.
1555
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1556
- * for more details and examples.
1557
- * @example
1558
- * ```
1559
- * const iterable = client.listLocationsAsync(request);
1560
- * for await (const response of iterable) {
1561
- * // process response
1562
- * }
1563
- * ```
1564
- */
1631
+ * Lists information about the supported locations for this service. Returns an iterable object.
1632
+ *
1633
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1634
+ * @param {Object} request
1635
+ * The request object that will be sent.
1636
+ * @param {string} request.name
1637
+ * The resource that owns the locations collection, if applicable.
1638
+ * @param {string} request.filter
1639
+ * The standard list filter.
1640
+ * @param {number} request.pageSize
1641
+ * The standard list page size.
1642
+ * @param {string} request.pageToken
1643
+ * The standard list page token.
1644
+ * @param {object} [options]
1645
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1646
+ * @returns {Object}
1647
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1648
+ * When you iterate the returned iterable, each element will be an object representing
1649
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
1650
+ * so you can stop the iteration when you don't need more results.
1651
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1652
+ * for more details and examples.
1653
+ * @example
1654
+ * ```
1655
+ * const iterable = client.listLocationsAsync(request);
1656
+ * for await (const response of iterable) {
1657
+ * // process response
1658
+ * }
1659
+ * ```
1660
+ */
1565
1661
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
1566
1662
  /**
1567
1663
  * Return a fully-qualified engine resource name string.
@@ -2292,6 +2388,57 @@ export declare class SearchServiceClient {
2292
2388
  * @returns {string} A string representing the data_store.
2293
2389
  */
2294
2390
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
2391
+ /**
2392
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
2393
+ *
2394
+ * @param {string} project
2395
+ * @param {string} location
2396
+ * @param {string} collection
2397
+ * @param {string} data_store
2398
+ * @param {string} sitemap
2399
+ * @returns {string} Resource name string.
2400
+ */
2401
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
2402
+ /**
2403
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2404
+ *
2405
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2406
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2407
+ * @returns {string} A string representing the project.
2408
+ */
2409
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2410
+ /**
2411
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2412
+ *
2413
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2414
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2415
+ * @returns {string} A string representing the location.
2416
+ */
2417
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2418
+ /**
2419
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2420
+ *
2421
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2422
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2423
+ * @returns {string} A string representing the collection.
2424
+ */
2425
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2426
+ /**
2427
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2428
+ *
2429
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2430
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2431
+ * @returns {string} A string representing the data_store.
2432
+ */
2433
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2434
+ /**
2435
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2436
+ *
2437
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2438
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2439
+ * @returns {string} A string representing the sitemap.
2440
+ */
2441
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
2295
2442
  /**
2296
2443
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
2297
2444
  *
@@ -3162,6 +3309,48 @@ export declare class SearchServiceClient {
3162
3309
  * @returns {string} A string representing the data_store.
3163
3310
  */
3164
3311
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
3312
+ /**
3313
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
3314
+ *
3315
+ * @param {string} project
3316
+ * @param {string} location
3317
+ * @param {string} data_store
3318
+ * @param {string} sitemap
3319
+ * @returns {string} Resource name string.
3320
+ */
3321
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
3322
+ /**
3323
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3324
+ *
3325
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3326
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3327
+ * @returns {string} A string representing the project.
3328
+ */
3329
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3330
+ /**
3331
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3332
+ *
3333
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3334
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3335
+ * @returns {string} A string representing the location.
3336
+ */
3337
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3338
+ /**
3339
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3340
+ *
3341
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3342
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3343
+ * @returns {string} A string representing the data_store.
3344
+ */
3345
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3346
+ /**
3347
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3348
+ *
3349
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3350
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3351
+ * @returns {string} A string representing the sitemap.
3352
+ */
3353
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
3165
3354
  /**
3166
3355
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
3167
3356
  *