@google-cloud/discoveryengine 2.1.0 → 2.3.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 (172) hide show
  1. package/README.md +13 -0
  2. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +17 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +52 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto +300 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +67 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +1 -3
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +3 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +54 -2
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +14 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +95 -4
  11. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +28 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +131 -6
  13. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +8 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +9 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto +84 -0
  16. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto +375 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +6 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +6 -0
  19. package/build/protos/google/cloud/discoveryengine/v1/user_license.proto +98 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto +191 -0
  21. package/build/protos/protos.d.ts +5415 -578
  22. package/build/protos/protos.js +77830 -63391
  23. package/build/protos/protos.json +1537 -92
  24. package/build/src/index.d.ts +10 -1
  25. package/build/src/index.js +8 -22
  26. package/build/src/v1/cmek_config_service_client.d.ts +2287 -0
  27. package/build/src/v1/cmek_config_service_client.js +3274 -0
  28. package/build/src/v1/cmek_config_service_client_config.json +42 -0
  29. package/build/src/v1/cmek_config_service_proto_list.json +44 -0
  30. package/build/src/v1/completion_service_client.d.ts +166 -76
  31. package/build/src/v1/completion_service_client.js +258 -263
  32. package/build/src/v1/completion_service_proto_list.json +6 -1
  33. package/build/src/v1/control_service_client.d.ts +171 -81
  34. package/build/src/v1/control_service_client.js +246 -132
  35. package/build/src/v1/control_service_proto_list.json +6 -1
  36. package/build/src/v1/conversational_search_service_client.d.ts +233 -143
  37. package/build/src/v1/conversational_search_service_client.js +330 -226
  38. package/build/src/v1/conversational_search_service_proto_list.json +6 -1
  39. package/build/src/v1/data_store_service_client.d.ts +218 -122
  40. package/build/src/v1/data_store_service_client.js +273 -281
  41. package/build/src/v1/data_store_service_proto_list.json +6 -1
  42. package/build/src/v1/document_service_client.d.ts +210 -120
  43. package/build/src/v1/document_service_client.js +300 -301
  44. package/build/src/v1/document_service_proto_list.json +6 -1
  45. package/build/src/v1/engine_service_client.d.ts +193 -103
  46. package/build/src/v1/engine_service_client.js +273 -280
  47. package/build/src/v1/engine_service_proto_list.json +6 -1
  48. package/build/src/v1/gapic_metadata.json +184 -0
  49. package/build/src/v1/grounded_generation_service_client.d.ts +138 -48
  50. package/build/src/v1/grounded_generation_service_client.js +217 -100
  51. package/build/src/v1/grounded_generation_service_proto_list.json +6 -1
  52. package/build/src/v1/identity_mapping_store_service_client.d.ts +2470 -0
  53. package/build/src/v1/identity_mapping_store_service_client.js +3449 -0
  54. package/build/src/v1/identity_mapping_store_service_client_config.json +54 -0
  55. package/build/src/v1/identity_mapping_store_service_proto_list.json +44 -0
  56. package/build/src/v1/index.d.ts +3 -0
  57. package/build/src/v1/index.js +7 -1
  58. package/build/src/v1/project_service_client.d.ts +166 -76
  59. package/build/src/v1/project_service_client.js +235 -223
  60. package/build/src/v1/project_service_proto_list.json +6 -1
  61. package/build/src/v1/rank_service_client.d.ts +137 -47
  62. package/build/src/v1/rank_service_client.js +204 -85
  63. package/build/src/v1/rank_service_proto_list.json +6 -1
  64. package/build/src/v1/recommendation_service_client.d.ts +137 -47
  65. package/build/src/v1/recommendation_service_client.js +202 -82
  66. package/build/src/v1/recommendation_service_proto_list.json +6 -1
  67. package/build/src/v1/schema_service_client.d.ts +201 -111
  68. package/build/src/v1/schema_service_client.js +264 -274
  69. package/build/src/v1/schema_service_proto_list.json +6 -1
  70. package/build/src/v1/search_service_client.d.ts +661 -571
  71. package/build/src/v1/search_service_client.js +216 -113
  72. package/build/src/v1/search_service_proto_list.json +6 -1
  73. package/build/src/v1/search_tuning_service_client.d.ts +167 -77
  74. package/build/src/v1/search_tuning_service_client.js +246 -236
  75. package/build/src/v1/search_tuning_service_proto_list.json +6 -1
  76. package/build/src/v1/serving_config_service_client.d.ts +138 -48
  77. package/build/src/v1/serving_config_service_client.js +201 -80
  78. package/build/src/v1/serving_config_service_proto_list.json +6 -1
  79. package/build/src/v1/site_search_engine_service_client.d.ts +238 -148
  80. package/build/src/v1/site_search_engine_service_client.js +324 -379
  81. package/build/src/v1/site_search_engine_service_proto_list.json +6 -1
  82. package/build/src/v1/user_event_service_client.d.ts +167 -77
  83. package/build/src/v1/user_event_service_client.js +260 -254
  84. package/build/src/v1/user_event_service_proto_list.json +6 -1
  85. package/build/src/v1/user_license_service_client.d.ts +2256 -0
  86. package/build/src/v1/user_license_service_client.js +3194 -0
  87. package/build/src/v1/user_license_service_client_config.json +34 -0
  88. package/build/src/v1/user_license_service_proto_list.json +44 -0
  89. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  90. package/build/src/v1alpha/acl_config_service_client.js +94 -106
  91. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  92. package/build/src/v1alpha/chunk_service_client.js +98 -120
  93. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  94. package/build/src/v1alpha/completion_service_client.js +141 -281
  95. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  96. package/build/src/v1alpha/control_service_client.js +129 -151
  97. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  98. package/build/src/v1alpha/conversational_search_service_client.js +211 -237
  99. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  100. package/build/src/v1alpha/data_store_service_client.js +176 -317
  101. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  102. package/build/src/v1alpha/document_service_client.js +193 -329
  103. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  104. package/build/src/v1alpha/engine_service_client.js +180 -326
  105. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  106. package/build/src/v1alpha/estimate_billing_service_client.js +119 -244
  107. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  108. package/build/src/v1alpha/evaluation_service_client.js +150 -296
  109. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  110. package/build/src/v1alpha/grounded_generation_service_client.js +85 -100
  111. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  112. package/build/src/v1alpha/project_service_client.js +139 -263
  113. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  114. package/build/src/v1alpha/rank_service_client.js +87 -104
  115. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  116. package/build/src/v1alpha/recommendation_service_client.js +85 -100
  117. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  118. package/build/src/v1alpha/sample_query_service_client.js +169 -302
  119. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  120. package/build/src/v1alpha/sample_query_set_service_client.js +130 -153
  121. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  122. package/build/src/v1alpha/schema_service_client.js +147 -293
  123. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  124. package/build/src/v1alpha/search_service_client.js +88 -112
  125. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  126. package/build/src/v1alpha/search_tuning_service_client.js +129 -254
  127. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  128. package/build/src/v1alpha/serving_config_service_client.js +109 -133
  129. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  130. package/build/src/v1alpha/site_search_engine_service_client.js +203 -388
  131. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  132. package/build/src/v1alpha/user_event_service_client.js +143 -272
  133. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  134. package/build/src/v1beta/completion_service_client.js +149 -280
  135. package/build/src/v1beta/control_service_client.d.ts +84 -84
  136. package/build/src/v1beta/control_service_client.js +127 -147
  137. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  138. package/build/src/v1beta/conversational_search_service_client.js +209 -233
  139. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  140. package/build/src/v1beta/data_store_service_client.js +154 -289
  141. package/build/src/v1beta/document_service_client.d.ts +124 -124
  142. package/build/src/v1beta/document_service_client.js +181 -310
  143. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  144. package/build/src/v1beta/engine_service_client.js +178 -316
  145. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  146. package/build/src/v1beta/evaluation_service_client.js +148 -286
  147. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  148. package/build/src/v1beta/grounded_generation_service_client.js +98 -114
  149. package/build/src/v1beta/project_service_client.d.ts +76 -76
  150. package/build/src/v1beta/project_service_client.js +116 -232
  151. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  152. package/build/src/v1beta/rank_service_client.js +85 -99
  153. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  154. package/build/src/v1beta/recommendation_service_client.js +83 -96
  155. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  156. package/build/src/v1beta/sample_query_service_client.js +167 -292
  157. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  158. package/build/src/v1beta/sample_query_set_service_client.js +128 -149
  159. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  160. package/build/src/v1beta/schema_service_client.js +145 -283
  161. package/build/src/v1beta/search_service_client.d.ts +665 -665
  162. package/build/src/v1beta/search_service_client.js +97 -128
  163. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  164. package/build/src/v1beta/search_tuning_service_client.js +127 -244
  165. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  166. package/build/src/v1beta/serving_config_service_client.js +107 -129
  167. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  168. package/build/src/v1beta/site_search_engine_service_client.js +205 -387
  169. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  170. package/build/src/v1beta/user_event_service_client.js +141 -262
  171. package/package.json +7 -7
  172. package/CHANGELOG.md +0 -267
@@ -117,503 +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
- * 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;
370
- /**
371
- * Equivalent to `search`, but returns a NodeJS Stream object.
372
- * @param {Object} request
373
- * The request object that will be sent.
374
- * @param {string} request.servingConfig
375
- * Required. The resource name of the Search serving config, such as
376
- * `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
377
- * or
378
- * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
379
- * This field is used to identify the serving configuration name, set
380
- * of models used to make the search.
381
- * @param {string} request.branch
382
- * The branch resource name, such as
383
- * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
384
- *
385
- * Use `default_branch` as the branch ID or leave this field empty, to search
386
- * documents under the default branch.
387
- * @param {string} request.query
388
- * Raw search query.
389
- * @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
390
- * Raw image query.
391
- * @param {number} request.pageSize
392
- * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
393
- * return. The maximum allowed value depends on the data type. Values above
394
- * the maximum value are coerced to the maximum value.
395
- *
396
- * * Websites with basic indexing: Default `10`, Maximum `25`.
397
- * * Websites with advanced indexing: Default `25`, Maximum `50`.
398
- * * Other: Default `50`, Maximum `100`.
399
- *
400
- * If this field is negative, an `INVALID_ARGUMENT` is returned.
401
- * @param {string} request.pageToken
402
- * A page token received from a previous
403
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
404
- * call. Provide this to retrieve the subsequent page.
405
- *
406
- * When paginating, all other parameters provided to
407
- * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
408
- * must match the call that provided the page token. Otherwise, an
409
- * `INVALID_ARGUMENT` error is returned.
410
- * @param {number} request.offset
411
- * A 0-indexed integer that specifies the current offset (that is, starting
412
- * result location, amongst the
413
- * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
414
- * relevant) in search results. This field is only considered if
415
- * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
416
- * unset.
417
- *
418
- * If this field is negative, an `INVALID_ARGUMENT` is returned.
419
- * @param {number} request.oneBoxPageSize
420
- * The maximum number of results to return for OneBox.
421
- * This applies to each OneBox type individually.
422
- * Default number is 10.
423
- * @param {number[]} request.dataStoreSpecs
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.
431
- * @param {string} request.filter
432
- * The filter syntax consists of an expression language for constructing a
433
- * predicate from one or more fields of the documents being filtered. Filter
434
- * expression is case-sensitive.
435
- *
436
- * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
437
- *
438
- * Filtering in Vertex AI Search is done by mapping the LHS filter key to a
439
- * key property defined in the Vertex AI Search backend -- this mapping is
440
- * defined by the customer in their schema. For example a media customer might
441
- * have a field 'name' in their schema. In this case the filter would look
442
- * like this: filter --> name:'ANY("king kong")'
443
- *
444
- * For more information about filtering including syntax and filter
445
- * operators, see
446
- * [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
447
- * @param {string} request.canonicalFilter
448
- * The default filter that is applied when a user performs a search without
449
- * checking any filters on the search page.
450
- *
451
- * The filter applied to every search request when quality improvement such as
452
- * query expansion is needed. In the case a query does not have a sufficient
453
- * amount of results this filter will be used to determine whether or not to
454
- * enable the query expansion flow. The original filter will still be used for
455
- * the query expanded search.
456
- * This field is strongly recommended to achieve high search quality.
457
- *
458
- * For more information about filter syntax, see
459
- * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.filter|SearchRequest.filter}.
460
- * @param {string} request.orderBy
461
- * The order in which documents are returned. Documents can be ordered by
462
- * a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
463
- * Leave it unset if ordered by relevance. `order_by` expression is
464
- * case-sensitive.
465
- *
466
- * For more information on ordering the website search results, see
467
- * [Order web search
468
- * results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
469
- * For more information on ordering the healthcare search results, see
470
- * [Order healthcare search
471
- * results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
472
- * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
473
- * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
474
- * Information about the end user.
475
- * Highly recommended for analytics and personalization.
476
- * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
477
- * is used to deduce `device_type` for analytics.
478
- * @param {string} request.languageCode
479
- * The BCP-47 language code, such as "en-US" or "sr-Latn". For more
480
- * information, see [Standard
481
- * fields](https://cloud.google.com/apis/design/standard_fields). This field
482
- * helps to better interpret the query. If a value isn't specified, the query
483
- * language code is automatically detected, which may not be accurate.
484
- * @param {number[]} request.facetSpecs
485
- * Facet specifications for faceted search. If empty, no facets are returned.
486
- *
487
- * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
488
- * error is returned.
489
- * @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
490
- * Boost specification to boost certain documents.
491
- * For more information on boosting, see
492
- * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
493
- * @param {number[]} request.params
494
- * Additional search parameters.
495
- *
496
- * For public website search only, supported values are:
497
- *
498
- * * `user_country_code`: string. Default empty. If set to non-empty, results
499
- * are restricted or boosted based on the location provided.
500
- * For example, `user_country_code: "au"`
501
- *
502
- * For available codes see [Country
503
- * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
504
- *
505
- * * `search_type`: double. Default empty. Enables non-webpage searching
506
- * depending on the value. The only valid non-default value is 1,
507
- * which enables image searching.
508
- * For example, `search_type: 1`
509
- * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
510
- * The query expansion specification that specifies the conditions under which
511
- * query expansion occurs.
512
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
513
- * The spell correction specification that specifies the mode under
514
- * which spell correction takes effect.
515
- * @param {string} request.userPseudoId
516
- * A unique identifier for tracking visitors. For example, this could be
517
- * implemented with an HTTP cookie, which should be able to uniquely identify
518
- * a visitor on a single device. This unique identifier should not change if
519
- * the visitor logs in or out of the website.
520
- *
521
- * This field should NOT have a fixed value such as `unknown_visitor`.
522
- *
523
- * This should be the same identifier as
524
- * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
525
- * and
526
- * {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
527
- *
528
- * The field must be a UTF-8 encoded string with a length limit of 128
529
- * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
530
- * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
531
- * A specification for configuring the behavior of content search.
532
- * @param {boolean} request.safeSearch
533
- * Whether to turn on safe search. This is only supported for
534
- * website search.
535
- * @param {number[]} request.userLabels
536
- * The user labels applied to a resource must meet the following requirements:
537
- *
538
- * * Each resource can have multiple labels, up to a maximum of 64.
539
- * * Each label must be a key-value pair.
540
- * * Keys have a minimum length of 1 character and a maximum length of 63
541
- * characters and cannot be empty. Values can be empty and have a maximum
542
- * length of 63 characters.
543
- * * Keys and values can contain only lowercase letters, numeric characters,
544
- * underscores, and dashes. All characters must use UTF-8 encoding, and
545
- * international characters are allowed.
546
- * * The key portion of a label must be unique. However, you can use the same
547
- * key with multiple resources.
548
- * * Keys must start with a lowercase letter or international character.
549
- *
550
- * See [Google Cloud
551
- * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
552
- * for more details.
553
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec} request.searchAsYouTypeSpec
554
- * Search as you type configuration. Only supported for the
555
- * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
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.
560
- * @param {string} request.session
561
- * The session resource name. Optional.
562
- *
563
- * Session allows users to do multi-turn /search API calls or coordination
564
- * between /search API calls and /answer API calls.
565
- *
566
- * Example #1 (multi-turn /search API calls):
567
- * 1. Call /search API with the auto-session mode (see below).
568
- * 2. Call /search API with the session ID generated in the first call.
569
- * Here, the previous search query gets considered in query
570
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
571
- * and the current query is "How about 2023?", the current query will
572
- * be interpreted as "How did Alphabet do in 2023?".
573
- *
574
- * Example #2 (coordination between /search API calls and /answer API calls):
575
- * 1. Call /search API with the auto-session mode (see below).
576
- * 2. Call /answer API with the session ID generated in the first call.
577
- * Here, the answer generation happens in the context of the search
578
- * results from the first search call.
579
- *
580
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
581
- * gets automatically created. Otherwise, users can use the create-session API
582
- * to create a session manually.
583
- *
584
- * Multi-turn Search feature is currently at private GA stage. Please use
585
- * v1alpha or v1beta version instead before we launch this feature to public
586
- * GA. Or ask for allowlisting through Google Support team.
587
- * @param {google.cloud.discoveryengine.v1.SearchRequest.SessionSpec} request.sessionSpec
588
- * Session specification.
589
- *
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.
601
- * @param {object} [options]
602
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
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.
609
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
610
- * for more details and examples.
611
- */
612
- 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;
613
370
  /**
614
- * Equivalent to `search`, but returns an iterable object.
615
- *
616
- * `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.
617
372
  * @param {Object} request
618
373
  * The request object that will be sent.
619
374
  * @param {string} request.servingConfig
@@ -845,32 +600,20 @@ export declare class SearchServiceClient {
845
600
  * Optional. The specification for returning the relevance score.
846
601
  * @param {object} [options]
847
602
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
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.
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.
853
609
  * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
854
610
  * 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
857
611
  */
858
- 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;
859
613
  /**
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.
614
+ * Equivalent to `search`, but returns an iterable object.
873
615
  *
616
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
874
617
  * @param {Object} request
875
618
  * The request object that will be sent.
876
619
  * @param {string} request.servingConfig
@@ -1102,16 +845,273 @@ export declare class SearchServiceClient {
1102
845
  * Optional. The specification for returning the relevance score.
1103
846
  * @param {object} [options]
1104
847
  * 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.
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.
1112
853
  * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1113
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
1114
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
+ */
1115
1115
  searchLite(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Promise<[
1116
1116
  protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult[],
1117
1117
  protos.google.cloud.discoveryengine.v1.ISearchRequest | null,
@@ -1609,55 +1609,55 @@ export declare class SearchServiceClient {
1609
1609
  */
1610
1610
  searchLiteAsync(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>;
1611
1611
  /**
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
- */
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
+ */
1629
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>;
1630
1630
  /**
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
- */
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
+ */
1661
1661
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
1662
1662
  /**
1663
1663
  * Return a fully-qualified engine resource name string.
@@ -1701,6 +1701,39 @@ export declare class SearchServiceClient {
1701
1701
  * @returns {string} A string representing the engine.
1702
1702
  */
1703
1703
  matchEngineFromEngineName(engineName: string): string | number;
1704
+ /**
1705
+ * Return a fully-qualified identityMappingStore resource name string.
1706
+ *
1707
+ * @param {string} project
1708
+ * @param {string} location
1709
+ * @param {string} identity_mapping_store
1710
+ * @returns {string} Resource name string.
1711
+ */
1712
+ identityMappingStorePath(project: string, location: string, identityMappingStore: string): string;
1713
+ /**
1714
+ * Parse the project from IdentityMappingStore resource.
1715
+ *
1716
+ * @param {string} identityMappingStoreName
1717
+ * A fully-qualified path representing IdentityMappingStore resource.
1718
+ * @returns {string} A string representing the project.
1719
+ */
1720
+ matchProjectFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
1721
+ /**
1722
+ * Parse the location from IdentityMappingStore resource.
1723
+ *
1724
+ * @param {string} identityMappingStoreName
1725
+ * A fully-qualified path representing IdentityMappingStore resource.
1726
+ * @returns {string} A string representing the location.
1727
+ */
1728
+ matchLocationFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
1729
+ /**
1730
+ * Parse the identity_mapping_store from IdentityMappingStore resource.
1731
+ *
1732
+ * @param {string} identityMappingStoreName
1733
+ * A fully-qualified path representing IdentityMappingStore resource.
1734
+ * @returns {string} A string representing the identity_mapping_store.
1735
+ */
1736
+ matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
1704
1737
  /**
1705
1738
  * Return a fully-qualified project resource name string.
1706
1739
  *
@@ -1716,6 +1749,63 @@ export declare class SearchServiceClient {
1716
1749
  * @returns {string} A string representing the project.
1717
1750
  */
1718
1751
  matchProjectFromProjectName(projectName: string): string | number;
1752
+ /**
1753
+ * Return a fully-qualified projectLocationCmekConfig resource name string.
1754
+ *
1755
+ * @param {string} project
1756
+ * @param {string} location
1757
+ * @returns {string} Resource name string.
1758
+ */
1759
+ projectLocationCmekConfigPath(project: string, location: string): string;
1760
+ /**
1761
+ * Parse the project from ProjectLocationCmekConfig resource.
1762
+ *
1763
+ * @param {string} projectLocationCmekConfigName
1764
+ * A fully-qualified path representing project_location_cmekConfig resource.
1765
+ * @returns {string} A string representing the project.
1766
+ */
1767
+ matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
1768
+ /**
1769
+ * Parse the location from ProjectLocationCmekConfig resource.
1770
+ *
1771
+ * @param {string} projectLocationCmekConfigName
1772
+ * A fully-qualified path representing project_location_cmekConfig resource.
1773
+ * @returns {string} A string representing the location.
1774
+ */
1775
+ matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
1776
+ /**
1777
+ * Return a fully-qualified projectLocationCmekConfigs resource name string.
1778
+ *
1779
+ * @param {string} project
1780
+ * @param {string} location
1781
+ * @param {string} cmek_config
1782
+ * @returns {string} Resource name string.
1783
+ */
1784
+ projectLocationCmekConfigsPath(project: string, location: string, cmekConfig: string): string;
1785
+ /**
1786
+ * Parse the project from ProjectLocationCmekConfigs resource.
1787
+ *
1788
+ * @param {string} projectLocationCmekConfigsName
1789
+ * A fully-qualified path representing project_location_cmekConfigs resource.
1790
+ * @returns {string} A string representing the project.
1791
+ */
1792
+ matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
1793
+ /**
1794
+ * Parse the location from ProjectLocationCmekConfigs resource.
1795
+ *
1796
+ * @param {string} projectLocationCmekConfigsName
1797
+ * A fully-qualified path representing project_location_cmekConfigs resource.
1798
+ * @returns {string} A string representing the location.
1799
+ */
1800
+ matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
1801
+ /**
1802
+ * Parse the cmek_config from ProjectLocationCmekConfigs resource.
1803
+ *
1804
+ * @param {string} projectLocationCmekConfigsName
1805
+ * A fully-qualified path representing project_location_cmekConfigs resource.
1806
+ * @returns {string} A string representing the cmek_config.
1807
+ */
1808
+ matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
1719
1809
  /**
1720
1810
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
1721
1811
  *