@google-cloud/discoveryengine 2.3.0 → 2.5.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 (228) hide show
  1. package/README.md +20 -0
  2. package/build/protos/google/cloud/discoveryengine/v1/assist_answer.proto +251 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/assistant.proto +44 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/assistant_service.proto +217 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +15 -3
  6. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +160 -14
  7. package/build/protos/google/cloud/discoveryengine/v1/session.proto +21 -8
  8. package/build/protos/google/cloud/discoveryengine/v1/session_service.proto +128 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +15 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +30 -9
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +136 -18
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +238 -8
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/session_service.proto +201 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +26 -5
  15. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +136 -18
  16. package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +40 -8
  17. package/build/protos/google/cloud/discoveryengine/v1beta/session_service.proto +128 -0
  18. package/build/protos/protos.d.ts +15854 -10608
  19. package/build/protos/protos.js +47009 -33222
  20. package/build/protos/protos.json +5357 -3208
  21. package/build/src/index.d.ts +7 -1
  22. package/build/src/index.js +6 -2
  23. package/build/src/v1/assistant_service_client.d.ts +2058 -0
  24. package/build/src/v1/assistant_service_client.js +2957 -0
  25. package/build/src/v1/assistant_service_client_config.json +43 -0
  26. package/build/src/v1/assistant_service_proto_list.json +48 -0
  27. package/build/src/v1/cmek_config_service_client.d.ts +255 -144
  28. package/build/src/v1/cmek_config_service_client.js +348 -196
  29. package/build/src/v1/cmek_config_service_proto_list.json +4 -0
  30. package/build/src/v1/completion_service_client.d.ts +255 -144
  31. package/build/src/v1/completion_service_client.js +348 -196
  32. package/build/src/v1/completion_service_proto_list.json +4 -0
  33. package/build/src/v1/control_service_client.d.ts +255 -144
  34. package/build/src/v1/control_service_client.js +348 -196
  35. package/build/src/v1/control_service_proto_list.json +4 -0
  36. package/build/src/v1/conversational_search_service_client.d.ts +302 -155
  37. package/build/src/v1/conversational_search_service_client.js +380 -204
  38. package/build/src/v1/conversational_search_service_proto_list.json +4 -0
  39. package/build/src/v1/data_store_service_client.d.ts +255 -144
  40. package/build/src/v1/data_store_service_client.js +348 -196
  41. package/build/src/v1/data_store_service_proto_list.json +4 -0
  42. package/build/src/v1/document_service_client.d.ts +255 -144
  43. package/build/src/v1/document_service_client.js +348 -196
  44. package/build/src/v1/document_service_proto_list.json +4 -0
  45. package/build/src/v1/engine_service_client.d.ts +255 -144
  46. package/build/src/v1/engine_service_client.js +348 -196
  47. package/build/src/v1/engine_service_proto_list.json +4 -0
  48. package/build/src/v1/gapic_metadata.json +86 -0
  49. package/build/src/v1/grounded_generation_service_client.d.ts +255 -144
  50. package/build/src/v1/grounded_generation_service_client.js +348 -196
  51. package/build/src/v1/grounded_generation_service_proto_list.json +4 -0
  52. package/build/src/v1/identity_mapping_store_service_client.d.ts +255 -144
  53. package/build/src/v1/identity_mapping_store_service_client.js +353 -201
  54. package/build/src/v1/identity_mapping_store_service_proto_list.json +4 -0
  55. package/build/src/v1/index.d.ts +2 -0
  56. package/build/src/v1/index.js +5 -1
  57. package/build/src/v1/project_service_client.d.ts +255 -144
  58. package/build/src/v1/project_service_client.js +348 -196
  59. package/build/src/v1/project_service_proto_list.json +4 -0
  60. package/build/src/v1/rank_service_client.d.ts +255 -144
  61. package/build/src/v1/rank_service_client.js +348 -196
  62. package/build/src/v1/rank_service_proto_list.json +4 -0
  63. package/build/src/v1/recommendation_service_client.d.ts +255 -144
  64. package/build/src/v1/recommendation_service_client.js +348 -196
  65. package/build/src/v1/recommendation_service_proto_list.json +4 -0
  66. package/build/src/v1/schema_service_client.d.ts +255 -144
  67. package/build/src/v1/schema_service_client.js +348 -196
  68. package/build/src/v1/schema_service_proto_list.json +4 -0
  69. package/build/src/v1/search_service_client.d.ts +861 -228
  70. package/build/src/v1/search_service_client.js +752 -252
  71. package/build/src/v1/search_service_proto_list.json +4 -0
  72. package/build/src/v1/search_tuning_service_client.d.ts +255 -144
  73. package/build/src/v1/search_tuning_service_client.js +348 -196
  74. package/build/src/v1/search_tuning_service_proto_list.json +4 -0
  75. package/build/src/v1/serving_config_service_client.d.ts +255 -144
  76. package/build/src/v1/serving_config_service_client.js +348 -196
  77. package/build/src/v1/serving_config_service_proto_list.json +4 -0
  78. package/build/src/v1/session_service_client.d.ts +2326 -0
  79. package/build/src/v1/session_service_client.js +3218 -0
  80. package/build/src/v1/session_service_client_config.json +63 -0
  81. package/build/src/v1/session_service_proto_list.json +48 -0
  82. package/build/src/v1/site_search_engine_service_client.d.ts +255 -144
  83. package/build/src/v1/site_search_engine_service_client.js +348 -196
  84. package/build/src/v1/site_search_engine_service_proto_list.json +4 -0
  85. package/build/src/v1/user_event_service_client.d.ts +255 -144
  86. package/build/src/v1/user_event_service_client.js +348 -196
  87. package/build/src/v1/user_event_service_proto_list.json +4 -0
  88. package/build/src/v1/user_license_service_client.d.ts +255 -144
  89. package/build/src/v1/user_license_service_client.js +348 -196
  90. package/build/src/v1/user_license_service_proto_list.json +4 -0
  91. package/build/src/v1alpha/acl_config_service_client.d.ts +144 -144
  92. package/build/src/v1alpha/acl_config_service_client.js +196 -196
  93. package/build/src/v1alpha/acl_config_service_proto_list.json +1 -0
  94. package/build/src/v1alpha/chunk_service_client.d.ts +144 -144
  95. package/build/src/v1alpha/chunk_service_client.js +196 -196
  96. package/build/src/v1alpha/chunk_service_proto_list.json +1 -0
  97. package/build/src/v1alpha/completion_service_client.d.ts +144 -144
  98. package/build/src/v1alpha/completion_service_client.js +196 -196
  99. package/build/src/v1alpha/completion_service_proto_list.json +1 -0
  100. package/build/src/v1alpha/control_service_client.d.ts +144 -144
  101. package/build/src/v1alpha/control_service_client.js +196 -196
  102. package/build/src/v1alpha/control_service_proto_list.json +1 -0
  103. package/build/src/v1alpha/conversational_search_service_client.d.ts +221 -167
  104. package/build/src/v1alpha/conversational_search_service_client.js +244 -210
  105. package/build/src/v1alpha/conversational_search_service_proto_list.json +1 -0
  106. package/build/src/v1alpha/data_store_service_client.d.ts +144 -144
  107. package/build/src/v1alpha/data_store_service_client.js +196 -196
  108. package/build/src/v1alpha/data_store_service_proto_list.json +1 -0
  109. package/build/src/v1alpha/document_service_client.d.ts +144 -144
  110. package/build/src/v1alpha/document_service_client.js +196 -196
  111. package/build/src/v1alpha/document_service_proto_list.json +1 -0
  112. package/build/src/v1alpha/engine_service_client.d.ts +144 -144
  113. package/build/src/v1alpha/engine_service_client.js +196 -196
  114. package/build/src/v1alpha/engine_service_proto_list.json +1 -0
  115. package/build/src/v1alpha/estimate_billing_service_client.d.ts +144 -144
  116. package/build/src/v1alpha/estimate_billing_service_client.js +196 -196
  117. package/build/src/v1alpha/estimate_billing_service_proto_list.json +1 -0
  118. package/build/src/v1alpha/evaluation_service_client.d.ts +144 -144
  119. package/build/src/v1alpha/evaluation_service_client.js +196 -196
  120. package/build/src/v1alpha/evaluation_service_proto_list.json +1 -0
  121. package/build/src/v1alpha/gapic_metadata.json +82 -0
  122. package/build/src/v1alpha/grounded_generation_service_client.d.ts +144 -144
  123. package/build/src/v1alpha/grounded_generation_service_client.js +196 -196
  124. package/build/src/v1alpha/grounded_generation_service_proto_list.json +1 -0
  125. package/build/src/v1alpha/index.d.ts +1 -0
  126. package/build/src/v1alpha/index.js +3 -1
  127. package/build/src/v1alpha/project_service_client.d.ts +144 -144
  128. package/build/src/v1alpha/project_service_client.js +196 -196
  129. package/build/src/v1alpha/project_service_proto_list.json +1 -0
  130. package/build/src/v1alpha/rank_service_client.d.ts +144 -144
  131. package/build/src/v1alpha/rank_service_client.js +196 -196
  132. package/build/src/v1alpha/rank_service_proto_list.json +1 -0
  133. package/build/src/v1alpha/recommendation_service_client.d.ts +144 -144
  134. package/build/src/v1alpha/recommendation_service_client.js +196 -196
  135. package/build/src/v1alpha/recommendation_service_proto_list.json +1 -0
  136. package/build/src/v1alpha/sample_query_service_client.d.ts +144 -144
  137. package/build/src/v1alpha/sample_query_service_client.js +196 -196
  138. package/build/src/v1alpha/sample_query_service_proto_list.json +1 -0
  139. package/build/src/v1alpha/sample_query_set_service_client.d.ts +144 -144
  140. package/build/src/v1alpha/sample_query_set_service_client.js +196 -196
  141. package/build/src/v1alpha/sample_query_set_service_proto_list.json +1 -0
  142. package/build/src/v1alpha/schema_service_client.d.ts +144 -144
  143. package/build/src/v1alpha/schema_service_client.js +196 -196
  144. package/build/src/v1alpha/schema_service_proto_list.json +1 -0
  145. package/build/src/v1alpha/search_service_client.d.ts +378 -198
  146. package/build/src/v1alpha/search_service_client.js +352 -232
  147. package/build/src/v1alpha/search_service_proto_list.json +1 -0
  148. package/build/src/v1alpha/search_tuning_service_client.d.ts +144 -144
  149. package/build/src/v1alpha/search_tuning_service_client.js +196 -196
  150. package/build/src/v1alpha/search_tuning_service_proto_list.json +1 -0
  151. package/build/src/v1alpha/serving_config_service_client.d.ts +144 -144
  152. package/build/src/v1alpha/serving_config_service_client.js +196 -196
  153. package/build/src/v1alpha/serving_config_service_proto_list.json +1 -0
  154. package/build/src/v1alpha/session_service_client.d.ts +2331 -0
  155. package/build/src/v1alpha/session_service_client.js +3161 -0
  156. package/build/src/v1alpha/session_service_client_config.json +68 -0
  157. package/build/src/v1alpha/session_service_proto_list.json +49 -0
  158. package/build/src/v1alpha/site_search_engine_service_client.d.ts +144 -144
  159. package/build/src/v1alpha/site_search_engine_service_client.js +196 -196
  160. package/build/src/v1alpha/site_search_engine_service_proto_list.json +1 -0
  161. package/build/src/v1alpha/user_event_service_client.d.ts +144 -144
  162. package/build/src/v1alpha/user_event_service_client.js +196 -196
  163. package/build/src/v1alpha/user_event_service_proto_list.json +1 -0
  164. package/build/src/v1beta/completion_service_client.d.ts +144 -144
  165. package/build/src/v1beta/completion_service_client.js +196 -196
  166. package/build/src/v1beta/completion_service_proto_list.json +1 -0
  167. package/build/src/v1beta/control_service_client.d.ts +144 -144
  168. package/build/src/v1beta/control_service_client.js +196 -196
  169. package/build/src/v1beta/control_service_proto_list.json +1 -0
  170. package/build/src/v1beta/conversational_search_service_client.d.ts +215 -161
  171. package/build/src/v1beta/conversational_search_service_client.js +242 -208
  172. package/build/src/v1beta/conversational_search_service_proto_list.json +1 -0
  173. package/build/src/v1beta/data_store_service_client.d.ts +144 -144
  174. package/build/src/v1beta/data_store_service_client.js +196 -196
  175. package/build/src/v1beta/data_store_service_proto_list.json +1 -0
  176. package/build/src/v1beta/document_service_client.d.ts +144 -144
  177. package/build/src/v1beta/document_service_client.js +196 -196
  178. package/build/src/v1beta/document_service_proto_list.json +1 -0
  179. package/build/src/v1beta/engine_service_client.d.ts +144 -144
  180. package/build/src/v1beta/engine_service_client.js +196 -196
  181. package/build/src/v1beta/engine_service_proto_list.json +1 -0
  182. package/build/src/v1beta/evaluation_service_client.d.ts +144 -144
  183. package/build/src/v1beta/evaluation_service_client.js +196 -196
  184. package/build/src/v1beta/evaluation_service_proto_list.json +1 -0
  185. package/build/src/v1beta/gapic_metadata.json +68 -0
  186. package/build/src/v1beta/grounded_generation_service_client.d.ts +144 -144
  187. package/build/src/v1beta/grounded_generation_service_client.js +196 -196
  188. package/build/src/v1beta/grounded_generation_service_proto_list.json +1 -0
  189. package/build/src/v1beta/index.d.ts +1 -0
  190. package/build/src/v1beta/index.js +3 -1
  191. package/build/src/v1beta/project_service_client.d.ts +144 -144
  192. package/build/src/v1beta/project_service_client.js +196 -196
  193. package/build/src/v1beta/project_service_proto_list.json +1 -0
  194. package/build/src/v1beta/rank_service_client.d.ts +144 -144
  195. package/build/src/v1beta/rank_service_client.js +196 -196
  196. package/build/src/v1beta/rank_service_proto_list.json +1 -0
  197. package/build/src/v1beta/recommendation_service_client.d.ts +144 -144
  198. package/build/src/v1beta/recommendation_service_client.js +196 -196
  199. package/build/src/v1beta/recommendation_service_proto_list.json +1 -0
  200. package/build/src/v1beta/sample_query_service_client.d.ts +144 -144
  201. package/build/src/v1beta/sample_query_service_client.js +196 -196
  202. package/build/src/v1beta/sample_query_service_proto_list.json +1 -0
  203. package/build/src/v1beta/sample_query_set_service_client.d.ts +144 -144
  204. package/build/src/v1beta/sample_query_set_service_client.js +196 -196
  205. package/build/src/v1beta/sample_query_set_service_proto_list.json +1 -0
  206. package/build/src/v1beta/schema_service_client.d.ts +144 -144
  207. package/build/src/v1beta/schema_service_client.js +196 -196
  208. package/build/src/v1beta/schema_service_proto_list.json +1 -0
  209. package/build/src/v1beta/search_service_client.d.ts +612 -252
  210. package/build/src/v1beta/search_service_client.js +508 -268
  211. package/build/src/v1beta/search_service_proto_list.json +1 -0
  212. package/build/src/v1beta/search_tuning_service_client.d.ts +144 -144
  213. package/build/src/v1beta/search_tuning_service_client.js +196 -196
  214. package/build/src/v1beta/search_tuning_service_proto_list.json +1 -0
  215. package/build/src/v1beta/serving_config_service_client.d.ts +144 -144
  216. package/build/src/v1beta/serving_config_service_client.js +196 -196
  217. package/build/src/v1beta/serving_config_service_proto_list.json +1 -0
  218. package/build/src/v1beta/session_service_client.d.ts +2266 -0
  219. package/build/src/v1beta/session_service_client.js +3136 -0
  220. package/build/src/v1beta/session_service_client_config.json +63 -0
  221. package/build/src/v1beta/session_service_proto_list.json +45 -0
  222. package/build/src/v1beta/site_search_engine_service_client.d.ts +144 -144
  223. package/build/src/v1beta/site_search_engine_service_client.js +196 -196
  224. package/build/src/v1beta/site_search_engine_service_proto_list.json +1 -0
  225. package/build/src/v1beta/user_event_service_client.d.ts +144 -144
  226. package/build/src/v1beta/user_event_service_client.js +196 -196
  227. package/build/src/v1beta/user_event_service_proto_list.json +1 -0
  228. package/package.json +1 -1
@@ -293,8 +293,14 @@ export declare class SearchServiceClient {
293
293
  * The ranking expression controls the customized ranking on retrieval
294
294
  * documents. This overrides
295
295
  * {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
296
- * The ranking expression is a single function or multiple functions that are
297
- * joined by "+".
296
+ * The syntax and supported features depend on the
297
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
298
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
299
+ *
300
+ * If
301
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
302
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
303
+ * function or multiple functions that are joined by "+".
298
304
  *
299
305
  * * ranking_expression = function, { " + ", function };
300
306
  *
@@ -309,13 +315,73 @@ export declare class SearchServiceClient {
309
315
  * between query and document.
310
316
  * * `embedding_field_path`: the document embedding field
311
317
  * used with query embedding vector.
312
- * * `dotProduct`: embedding function between embedding_field_path and query
313
- * embedding vector.
318
+ * * `dotProduct`: embedding function between `embedding_field_path` and
319
+ * query embedding vector.
314
320
  *
315
321
  * Example ranking expression:
316
322
  *
317
323
  * If document has an embedding field doc_embedding, the ranking expression
318
324
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
325
+ *
326
+ * If
327
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
328
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
329
+ * combinations of those chained using + or
330
+ * * operators) are supported:
331
+ *
332
+ * * `double`
333
+ * * `signal`
334
+ * * `log(signal)`
335
+ * * `exp(signal)`
336
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
337
+ * argument being a denominator constant.
338
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
339
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
340
+ * signal2 | double, else returns signal1.
341
+ *
342
+ * Here are a few examples of ranking formulas that use the supported
343
+ * ranking expression types:
344
+ *
345
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
346
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
347
+ * `semantic_smilarity_score` adjustment.
348
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
349
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
350
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
351
+ * add constant 0.3 adjustment to the final score if
352
+ * `semantic_similarity_score` is NaN.
353
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
354
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
355
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
356
+ * of `semantic_smilarity_score`.
357
+ *
358
+ * The following signals are supported:
359
+ *
360
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
361
+ * calculated using the embeddings generated by a proprietary Google model.
362
+ * This score determines how semantically similar a search query is to a
363
+ * document.
364
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
365
+ * Match 25 (BM25) ranking function. This score is calculated using a
366
+ * probabilistic model to estimate the probability that a document is
367
+ * relevant to a given query.
368
+ * * `relevance_score`: semantic relevance adjustment that uses a
369
+ * proprietary Google model to determine the meaning and intent behind a
370
+ * user's query in context with the content in the documents.
371
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
372
+ * predicted Click-through rate (pCTR) to gauge the relevance and
373
+ * attractiveness of a search result from a user's perspective. A higher
374
+ * pCTR suggests that the result is more likely to satisfy the user's query
375
+ * and intent, making it a valuable signal for ranking.
376
+ * * `freshness_rank`: freshness adjustment as a rank
377
+ * * `document_age`: The time in hours elapsed since the document was last
378
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
379
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
380
+ * Google model to determine the keyword-based overlap between the query and
381
+ * the document.
382
+ * * `base_rank`: the default rank of the result
383
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
384
+ * The backend to use for the ranking expression evaluation.
319
385
  * @param {boolean} request.safeSearch
320
386
  * Whether to turn on safe search. This is only supported for
321
387
  * website search.
@@ -355,22 +421,16 @@ export declare class SearchServiceClient {
355
421
  * between /search API calls and /answer API calls.
356
422
  *
357
423
  * Example #1 (multi-turn /search API calls):
358
- * 1. Call /search API with the auto-session mode (see below).
359
- * 2. Call /search API with the session ID generated in the first call.
360
- * Here, the previous search query gets considered in query
361
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
362
- * and the current query is "How about 2023?", the current query will
363
- * be interpreted as "How did Alphabet do in 2023?".
424
+ * Call /search API with the session ID generated in the first call.
425
+ * Here, the previous search query gets considered in query
426
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
427
+ * and the current query is "How about 2023?", the current query will
428
+ * be interpreted as "How did Alphabet do in 2023?".
364
429
  *
365
430
  * Example #2 (coordination between /search API calls and /answer API calls):
366
- * 1. Call /search API with the auto-session mode (see below).
367
- * 2. Call /answer API with the session ID generated in the first call.
368
- * Here, the answer generation happens in the context of the search
369
- * results from the first search call.
370
- *
371
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
372
- * gets automatically created. Otherwise, users can use the create-session API
373
- * to create a session manually.
431
+ * Call /answer API with the session ID generated in the first call.
432
+ * Here, the answer generation happens in the context of the search
433
+ * results from the first search call.
374
434
  *
375
435
  * Multi-turn Search feature is currently at private GA stage. Please use
376
436
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -580,8 +640,14 @@ export declare class SearchServiceClient {
580
640
  * The ranking expression controls the customized ranking on retrieval
581
641
  * documents. This overrides
582
642
  * {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
583
- * The ranking expression is a single function or multiple functions that are
584
- * joined by "+".
643
+ * The syntax and supported features depend on the
644
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
645
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
646
+ *
647
+ * If
648
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
649
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
650
+ * function or multiple functions that are joined by "+".
585
651
  *
586
652
  * * ranking_expression = function, { " + ", function };
587
653
  *
@@ -596,13 +662,73 @@ export declare class SearchServiceClient {
596
662
  * between query and document.
597
663
  * * `embedding_field_path`: the document embedding field
598
664
  * used with query embedding vector.
599
- * * `dotProduct`: embedding function between embedding_field_path and query
600
- * embedding vector.
665
+ * * `dotProduct`: embedding function between `embedding_field_path` and
666
+ * query embedding vector.
601
667
  *
602
668
  * Example ranking expression:
603
669
  *
604
670
  * If document has an embedding field doc_embedding, the ranking expression
605
671
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
672
+ *
673
+ * If
674
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
675
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
676
+ * combinations of those chained using + or
677
+ * * operators) are supported:
678
+ *
679
+ * * `double`
680
+ * * `signal`
681
+ * * `log(signal)`
682
+ * * `exp(signal)`
683
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
684
+ * argument being a denominator constant.
685
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
686
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
687
+ * signal2 | double, else returns signal1.
688
+ *
689
+ * Here are a few examples of ranking formulas that use the supported
690
+ * ranking expression types:
691
+ *
692
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
693
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
694
+ * `semantic_smilarity_score` adjustment.
695
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
696
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
697
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
698
+ * add constant 0.3 adjustment to the final score if
699
+ * `semantic_similarity_score` is NaN.
700
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
701
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
702
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
703
+ * of `semantic_smilarity_score`.
704
+ *
705
+ * The following signals are supported:
706
+ *
707
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
708
+ * calculated using the embeddings generated by a proprietary Google model.
709
+ * This score determines how semantically similar a search query is to a
710
+ * document.
711
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
712
+ * Match 25 (BM25) ranking function. This score is calculated using a
713
+ * probabilistic model to estimate the probability that a document is
714
+ * relevant to a given query.
715
+ * * `relevance_score`: semantic relevance adjustment that uses a
716
+ * proprietary Google model to determine the meaning and intent behind a
717
+ * user's query in context with the content in the documents.
718
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
719
+ * predicted Click-through rate (pCTR) to gauge the relevance and
720
+ * attractiveness of a search result from a user's perspective. A higher
721
+ * pCTR suggests that the result is more likely to satisfy the user's query
722
+ * and intent, making it a valuable signal for ranking.
723
+ * * `freshness_rank`: freshness adjustment as a rank
724
+ * * `document_age`: The time in hours elapsed since the document was last
725
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
726
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
727
+ * Google model to determine the keyword-based overlap between the query and
728
+ * the document.
729
+ * * `base_rank`: the default rank of the result
730
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
731
+ * The backend to use for the ranking expression evaluation.
606
732
  * @param {boolean} request.safeSearch
607
733
  * Whether to turn on safe search. This is only supported for
608
734
  * website search.
@@ -642,22 +768,16 @@ export declare class SearchServiceClient {
642
768
  * between /search API calls and /answer API calls.
643
769
  *
644
770
  * Example #1 (multi-turn /search API calls):
645
- * 1. Call /search API with the auto-session mode (see below).
646
- * 2. Call /search API with the session ID generated in the first call.
647
- * Here, the previous search query gets considered in query
648
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
649
- * and the current query is "How about 2023?", the current query will
650
- * be interpreted as "How did Alphabet do in 2023?".
771
+ * Call /search API with the session ID generated in the first call.
772
+ * Here, the previous search query gets considered in query
773
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
774
+ * and the current query is "How about 2023?", the current query will
775
+ * be interpreted as "How did Alphabet do in 2023?".
651
776
  *
652
777
  * Example #2 (coordination between /search API calls and /answer API calls):
653
- * 1. Call /search API with the auto-session mode (see below).
654
- * 2. Call /answer API with the session ID generated in the first call.
655
- * Here, the answer generation happens in the context of the search
656
- * results from the first search call.
657
- *
658
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
659
- * gets automatically created. Otherwise, users can use the create-session API
660
- * to create a session manually.
778
+ * Call /answer API with the session ID generated in the first call.
779
+ * Here, the answer generation happens in the context of the search
780
+ * results from the first search call.
661
781
  *
662
782
  * Multi-turn Search feature is currently at private GA stage. Please use
663
783
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -862,8 +982,14 @@ export declare class SearchServiceClient {
862
982
  * The ranking expression controls the customized ranking on retrieval
863
983
  * documents. This overrides
864
984
  * {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
865
- * The ranking expression is a single function or multiple functions that are
866
- * joined by "+".
985
+ * The syntax and supported features depend on the
986
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
987
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
988
+ *
989
+ * If
990
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
991
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
992
+ * function or multiple functions that are joined by "+".
867
993
  *
868
994
  * * ranking_expression = function, { " + ", function };
869
995
  *
@@ -878,13 +1004,73 @@ export declare class SearchServiceClient {
878
1004
  * between query and document.
879
1005
  * * `embedding_field_path`: the document embedding field
880
1006
  * used with query embedding vector.
881
- * * `dotProduct`: embedding function between embedding_field_path and query
882
- * embedding vector.
1007
+ * * `dotProduct`: embedding function between `embedding_field_path` and
1008
+ * query embedding vector.
883
1009
  *
884
1010
  * Example ranking expression:
885
1011
  *
886
1012
  * If document has an embedding field doc_embedding, the ranking expression
887
1013
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
1014
+ *
1015
+ * If
1016
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1017
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
1018
+ * combinations of those chained using + or
1019
+ * * operators) are supported:
1020
+ *
1021
+ * * `double`
1022
+ * * `signal`
1023
+ * * `log(signal)`
1024
+ * * `exp(signal)`
1025
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
1026
+ * argument being a denominator constant.
1027
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
1028
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
1029
+ * signal2 | double, else returns signal1.
1030
+ *
1031
+ * Here are a few examples of ranking formulas that use the supported
1032
+ * ranking expression types:
1033
+ *
1034
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
1035
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
1036
+ * `semantic_smilarity_score` adjustment.
1037
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
1038
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
1039
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
1040
+ * add constant 0.3 adjustment to the final score if
1041
+ * `semantic_similarity_score` is NaN.
1042
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
1043
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
1044
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
1045
+ * of `semantic_smilarity_score`.
1046
+ *
1047
+ * The following signals are supported:
1048
+ *
1049
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
1050
+ * calculated using the embeddings generated by a proprietary Google model.
1051
+ * This score determines how semantically similar a search query is to a
1052
+ * document.
1053
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
1054
+ * Match 25 (BM25) ranking function. This score is calculated using a
1055
+ * probabilistic model to estimate the probability that a document is
1056
+ * relevant to a given query.
1057
+ * * `relevance_score`: semantic relevance adjustment that uses a
1058
+ * proprietary Google model to determine the meaning and intent behind a
1059
+ * user's query in context with the content in the documents.
1060
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
1061
+ * predicted Click-through rate (pCTR) to gauge the relevance and
1062
+ * attractiveness of a search result from a user's perspective. A higher
1063
+ * pCTR suggests that the result is more likely to satisfy the user's query
1064
+ * and intent, making it a valuable signal for ranking.
1065
+ * * `freshness_rank`: freshness adjustment as a rank
1066
+ * * `document_age`: The time in hours elapsed since the document was last
1067
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
1068
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
1069
+ * Google model to determine the keyword-based overlap between the query and
1070
+ * the document.
1071
+ * * `base_rank`: the default rank of the result
1072
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1073
+ * The backend to use for the ranking expression evaluation.
888
1074
  * @param {boolean} request.safeSearch
889
1075
  * Whether to turn on safe search. This is only supported for
890
1076
  * website search.
@@ -924,22 +1110,16 @@ export declare class SearchServiceClient {
924
1110
  * between /search API calls and /answer API calls.
925
1111
  *
926
1112
  * Example #1 (multi-turn /search API calls):
927
- * 1. Call /search API with the auto-session mode (see below).
928
- * 2. Call /search API with the session ID generated in the first call.
929
- * Here, the previous search query gets considered in query
930
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
931
- * and the current query is "How about 2023?", the current query will
932
- * be interpreted as "How did Alphabet do in 2023?".
1113
+ * Call /search API with the session ID generated in the first call.
1114
+ * Here, the previous search query gets considered in query
1115
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1116
+ * and the current query is "How about 2023?", the current query will
1117
+ * be interpreted as "How did Alphabet do in 2023?".
933
1118
  *
934
1119
  * Example #2 (coordination between /search API calls and /answer API calls):
935
- * 1. Call /search API with the auto-session mode (see below).
936
- * 2. Call /answer API with the session ID generated in the first call.
937
- * Here, the answer generation happens in the context of the search
938
- * results from the first search call.
939
- *
940
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
941
- * gets automatically created. Otherwise, users can use the create-session API
942
- * to create a session manually.
1120
+ * Call /answer API with the session ID generated in the first call.
1121
+ * Here, the answer generation happens in the context of the search
1122
+ * results from the first search call.
943
1123
  *
944
1124
  * Multi-turn Search feature is currently at private GA stage. Please use
945
1125
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -1651,57 +1831,6 @@ export declare class SearchServiceClient {
1651
1831
  * @returns {string} A string representing the serving_config.
1652
1832
  */
1653
1833
  matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1654
- /**
1655
- * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
1656
- *
1657
- * @param {string} project
1658
- * @param {string} location
1659
- * @param {string} collection
1660
- * @param {string} data_store
1661
- * @param {string} session
1662
- * @returns {string} Resource name string.
1663
- */
1664
- projectLocationCollectionDataStoreSessionPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
1665
- /**
1666
- * Parse the project from ProjectLocationCollectionDataStoreSession resource.
1667
- *
1668
- * @param {string} projectLocationCollectionDataStoreSessionName
1669
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1670
- * @returns {string} A string representing the project.
1671
- */
1672
- matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1673
- /**
1674
- * Parse the location from ProjectLocationCollectionDataStoreSession resource.
1675
- *
1676
- * @param {string} projectLocationCollectionDataStoreSessionName
1677
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1678
- * @returns {string} A string representing the location.
1679
- */
1680
- matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1681
- /**
1682
- * Parse the collection from ProjectLocationCollectionDataStoreSession resource.
1683
- *
1684
- * @param {string} projectLocationCollectionDataStoreSessionName
1685
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1686
- * @returns {string} A string representing the collection.
1687
- */
1688
- matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1689
- /**
1690
- * Parse the data_store from ProjectLocationCollectionDataStoreSession resource.
1691
- *
1692
- * @param {string} projectLocationCollectionDataStoreSessionName
1693
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1694
- * @returns {string} A string representing the data_store.
1695
- */
1696
- matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1697
- /**
1698
- * Parse the session from ProjectLocationCollectionDataStoreSession resource.
1699
- *
1700
- * @param {string} projectLocationCollectionDataStoreSessionName
1701
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1702
- * @returns {string} A string representing the session.
1703
- */
1704
- matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1705
1834
  /**
1706
1835
  * Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
1707
1836
  *
@@ -1762,6 +1891,57 @@ export declare class SearchServiceClient {
1762
1891
  * @returns {string} A string representing the answer.
1763
1892
  */
1764
1893
  matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
1894
+ /**
1895
+ * Return a fully-qualified projectLocationCollectionDataStoreSessions resource name string.
1896
+ *
1897
+ * @param {string} project
1898
+ * @param {string} location
1899
+ * @param {string} collection
1900
+ * @param {string} data_store
1901
+ * @param {string} session
1902
+ * @returns {string} Resource name string.
1903
+ */
1904
+ projectLocationCollectionDataStoreSessionsPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
1905
+ /**
1906
+ * Parse the project from ProjectLocationCollectionDataStoreSessions resource.
1907
+ *
1908
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1909
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1910
+ * @returns {string} A string representing the project.
1911
+ */
1912
+ matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1913
+ /**
1914
+ * Parse the location from ProjectLocationCollectionDataStoreSessions resource.
1915
+ *
1916
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1917
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1918
+ * @returns {string} A string representing the location.
1919
+ */
1920
+ matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1921
+ /**
1922
+ * Parse the collection from ProjectLocationCollectionDataStoreSessions resource.
1923
+ *
1924
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1925
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1926
+ * @returns {string} A string representing the collection.
1927
+ */
1928
+ matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1929
+ /**
1930
+ * Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.
1931
+ *
1932
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1933
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1934
+ * @returns {string} A string representing the data_store.
1935
+ */
1936
+ matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1937
+ /**
1938
+ * Parse the session from ProjectLocationCollectionDataStoreSessions resource.
1939
+ *
1940
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1941
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1942
+ * @returns {string} A string representing the session.
1943
+ */
1944
+ matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1765
1945
  /**
1766
1946
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1767
1947
  *
@@ -2008,57 +2188,6 @@ export declare class SearchServiceClient {
2008
2188
  * @returns {string} A string representing the serving_config.
2009
2189
  */
2010
2190
  matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
2011
- /**
2012
- * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
2013
- *
2014
- * @param {string} project
2015
- * @param {string} location
2016
- * @param {string} collection
2017
- * @param {string} engine
2018
- * @param {string} session
2019
- * @returns {string} Resource name string.
2020
- */
2021
- projectLocationCollectionEngineSessionPath(project: string, location: string, collection: string, engine: string, session: string): string;
2022
- /**
2023
- * Parse the project from ProjectLocationCollectionEngineSession resource.
2024
- *
2025
- * @param {string} projectLocationCollectionEngineSessionName
2026
- * A fully-qualified path representing project_location_collection_engine_session resource.
2027
- * @returns {string} A string representing the project.
2028
- */
2029
- matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
2030
- /**
2031
- * Parse the location from ProjectLocationCollectionEngineSession resource.
2032
- *
2033
- * @param {string} projectLocationCollectionEngineSessionName
2034
- * A fully-qualified path representing project_location_collection_engine_session resource.
2035
- * @returns {string} A string representing the location.
2036
- */
2037
- matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
2038
- /**
2039
- * Parse the collection from ProjectLocationCollectionEngineSession resource.
2040
- *
2041
- * @param {string} projectLocationCollectionEngineSessionName
2042
- * A fully-qualified path representing project_location_collection_engine_session resource.
2043
- * @returns {string} A string representing the collection.
2044
- */
2045
- matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
2046
- /**
2047
- * Parse the engine from ProjectLocationCollectionEngineSession resource.
2048
- *
2049
- * @param {string} projectLocationCollectionEngineSessionName
2050
- * A fully-qualified path representing project_location_collection_engine_session resource.
2051
- * @returns {string} A string representing the engine.
2052
- */
2053
- matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
2054
- /**
2055
- * Parse the session from ProjectLocationCollectionEngineSession resource.
2056
- *
2057
- * @param {string} projectLocationCollectionEngineSessionName
2058
- * A fully-qualified path representing project_location_collection_engine_session resource.
2059
- * @returns {string} A string representing the session.
2060
- */
2061
- matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
2062
2191
  /**
2063
2192
  * Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
2064
2193
  *
@@ -2119,6 +2248,57 @@ export declare class SearchServiceClient {
2119
2248
  * @returns {string} A string representing the answer.
2120
2249
  */
2121
2250
  matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
2251
+ /**
2252
+ * Return a fully-qualified projectLocationCollectionEngineSessions resource name string.
2253
+ *
2254
+ * @param {string} project
2255
+ * @param {string} location
2256
+ * @param {string} collection
2257
+ * @param {string} engine
2258
+ * @param {string} session
2259
+ * @returns {string} Resource name string.
2260
+ */
2261
+ projectLocationCollectionEngineSessionsPath(project: string, location: string, collection: string, engine: string, session: string): string;
2262
+ /**
2263
+ * Parse the project from ProjectLocationCollectionEngineSessions resource.
2264
+ *
2265
+ * @param {string} projectLocationCollectionEngineSessionsName
2266
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
2267
+ * @returns {string} A string representing the project.
2268
+ */
2269
+ matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
2270
+ /**
2271
+ * Parse the location from ProjectLocationCollectionEngineSessions resource.
2272
+ *
2273
+ * @param {string} projectLocationCollectionEngineSessionsName
2274
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
2275
+ * @returns {string} A string representing the location.
2276
+ */
2277
+ matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
2278
+ /**
2279
+ * Parse the collection from ProjectLocationCollectionEngineSessions resource.
2280
+ *
2281
+ * @param {string} projectLocationCollectionEngineSessionsName
2282
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
2283
+ * @returns {string} A string representing the collection.
2284
+ */
2285
+ matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
2286
+ /**
2287
+ * Parse the engine from ProjectLocationCollectionEngineSessions resource.
2288
+ *
2289
+ * @param {string} projectLocationCollectionEngineSessionsName
2290
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
2291
+ * @returns {string} A string representing the engine.
2292
+ */
2293
+ matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
2294
+ /**
2295
+ * Parse the session from ProjectLocationCollectionEngineSessions resource.
2296
+ *
2297
+ * @param {string} projectLocationCollectionEngineSessionsName
2298
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
2299
+ * @returns {string} A string representing the session.
2300
+ */
2301
+ matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
2122
2302
  /**
2123
2303
  * Return a fully-qualified projectLocationDataStore resource name string.
2124
2304
  *
@@ -2548,48 +2728,6 @@ export declare class SearchServiceClient {
2548
2728
  * @returns {string} A string representing the serving_config.
2549
2729
  */
2550
2730
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2551
- /**
2552
- * Return a fully-qualified projectLocationDataStoreSession resource name string.
2553
- *
2554
- * @param {string} project
2555
- * @param {string} location
2556
- * @param {string} data_store
2557
- * @param {string} session
2558
- * @returns {string} Resource name string.
2559
- */
2560
- projectLocationDataStoreSessionPath(project: string, location: string, dataStore: string, session: string): string;
2561
- /**
2562
- * Parse the project from ProjectLocationDataStoreSession resource.
2563
- *
2564
- * @param {string} projectLocationDataStoreSessionName
2565
- * A fully-qualified path representing project_location_data_store_session resource.
2566
- * @returns {string} A string representing the project.
2567
- */
2568
- matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2569
- /**
2570
- * Parse the location from ProjectLocationDataStoreSession resource.
2571
- *
2572
- * @param {string} projectLocationDataStoreSessionName
2573
- * A fully-qualified path representing project_location_data_store_session resource.
2574
- * @returns {string} A string representing the location.
2575
- */
2576
- matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2577
- /**
2578
- * Parse the data_store from ProjectLocationDataStoreSession resource.
2579
- *
2580
- * @param {string} projectLocationDataStoreSessionName
2581
- * A fully-qualified path representing project_location_data_store_session resource.
2582
- * @returns {string} A string representing the data_store.
2583
- */
2584
- matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2585
- /**
2586
- * Parse the session from ProjectLocationDataStoreSession resource.
2587
- *
2588
- * @param {string} projectLocationDataStoreSessionName
2589
- * A fully-qualified path representing project_location_data_store_session resource.
2590
- * @returns {string} A string representing the session.
2591
- */
2592
- matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2593
2731
  /**
2594
2732
  * Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.
2595
2733
  *
@@ -2641,6 +2779,48 @@ export declare class SearchServiceClient {
2641
2779
  * @returns {string} A string representing the answer.
2642
2780
  */
2643
2781
  matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
2782
+ /**
2783
+ * Return a fully-qualified projectLocationDataStoreSessions resource name string.
2784
+ *
2785
+ * @param {string} project
2786
+ * @param {string} location
2787
+ * @param {string} data_store
2788
+ * @param {string} session
2789
+ * @returns {string} Resource name string.
2790
+ */
2791
+ projectLocationDataStoreSessionsPath(project: string, location: string, dataStore: string, session: string): string;
2792
+ /**
2793
+ * Parse the project from ProjectLocationDataStoreSessions resource.
2794
+ *
2795
+ * @param {string} projectLocationDataStoreSessionsName
2796
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2797
+ * @returns {string} A string representing the project.
2798
+ */
2799
+ matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2800
+ /**
2801
+ * Parse the location from ProjectLocationDataStoreSessions resource.
2802
+ *
2803
+ * @param {string} projectLocationDataStoreSessionsName
2804
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2805
+ * @returns {string} A string representing the location.
2806
+ */
2807
+ matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2808
+ /**
2809
+ * Parse the data_store from ProjectLocationDataStoreSessions resource.
2810
+ *
2811
+ * @param {string} projectLocationDataStoreSessionsName
2812
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2813
+ * @returns {string} A string representing the data_store.
2814
+ */
2815
+ matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2816
+ /**
2817
+ * Parse the session from ProjectLocationDataStoreSessions resource.
2818
+ *
2819
+ * @param {string} projectLocationDataStoreSessionsName
2820
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2821
+ * @returns {string} A string representing the session.
2822
+ */
2823
+ matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2644
2824
  /**
2645
2825
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
2646
2826
  *