@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
@@ -296,8 +296,14 @@ export declare class SearchServiceClient {
296
296
  * The ranking expression controls the customized ranking on retrieval
297
297
  * documents. This overrides
298
298
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
299
- * The ranking expression is a single function or multiple functions that are
300
- * joined by "+".
299
+ * The syntax and supported features depend on the
300
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
301
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
302
+ *
303
+ * If
304
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
305
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
306
+ * function or multiple functions that are joined by "+".
301
307
  *
302
308
  * * ranking_expression = function, { " + ", function };
303
309
  *
@@ -312,13 +318,73 @@ export declare class SearchServiceClient {
312
318
  * between query and document.
313
319
  * * `embedding_field_path`: the document embedding field
314
320
  * used with query embedding vector.
315
- * * `dotProduct`: embedding function between embedding_field_path and query
316
- * embedding vector.
321
+ * * `dotProduct`: embedding function between `embedding_field_path` and
322
+ * query embedding vector.
317
323
  *
318
324
  * Example ranking expression:
319
325
  *
320
326
  * If document has an embedding field doc_embedding, the ranking expression
321
327
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
328
+ *
329
+ * If
330
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
331
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
332
+ * combinations of those chained using + or
333
+ * * operators) are supported:
334
+ *
335
+ * * `double`
336
+ * * `signal`
337
+ * * `log(signal)`
338
+ * * `exp(signal)`
339
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
340
+ * argument being a denominator constant.
341
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
342
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
343
+ * signal2 | double, else returns signal1.
344
+ *
345
+ * Here are a few examples of ranking formulas that use the supported
346
+ * ranking expression types:
347
+ *
348
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
349
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
350
+ * `semantic_smilarity_score` adjustment.
351
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
352
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
353
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
354
+ * add constant 0.3 adjustment to the final score if
355
+ * `semantic_similarity_score` is NaN.
356
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
357
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
358
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
359
+ * of `semantic_smilarity_score`.
360
+ *
361
+ * The following signals are supported:
362
+ *
363
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
364
+ * calculated using the embeddings generated by a proprietary Google model.
365
+ * This score determines how semantically similar a search query is to a
366
+ * document.
367
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
368
+ * Match 25 (BM25) ranking function. This score is calculated using a
369
+ * probabilistic model to estimate the probability that a document is
370
+ * relevant to a given query.
371
+ * * `relevance_score`: semantic relevance adjustment that uses a
372
+ * proprietary Google model to determine the meaning and intent behind a
373
+ * user's query in context with the content in the documents.
374
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
375
+ * predicted Click-through rate (pCTR) to gauge the relevance and
376
+ * attractiveness of a search result from a user's perspective. A higher
377
+ * pCTR suggests that the result is more likely to satisfy the user's query
378
+ * and intent, making it a valuable signal for ranking.
379
+ * * `freshness_rank`: freshness adjustment as a rank
380
+ * * `document_age`: The time in hours elapsed since the document was last
381
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
382
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
383
+ * Google model to determine the keyword-based overlap between the query and
384
+ * the document.
385
+ * * `base_rank`: the default rank of the result
386
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
387
+ * The backend to use for the ranking expression evaluation.
322
388
  * @param {boolean} request.safeSearch
323
389
  * Whether to turn on safe search. This is only supported for
324
390
  * website search.
@@ -354,22 +420,16 @@ export declare class SearchServiceClient {
354
420
  * between /search API calls and /answer API calls.
355
421
  *
356
422
  * Example #1 (multi-turn /search API calls):
357
- * 1. Call /search API with the auto-session mode (see below).
358
- * 2. Call /search API with the session ID generated in the first call.
359
- * Here, the previous search query gets considered in query
360
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
361
- * and the current query is "How about 2023?", the current query will
362
- * be interpreted as "How did Alphabet do in 2023?".
423
+ * Call /search API with the session ID generated in the first call.
424
+ * Here, the previous search query gets considered in query
425
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
426
+ * and the current query is "How about 2023?", the current query will
427
+ * be interpreted as "How did Alphabet do in 2023?".
363
428
  *
364
429
  * Example #2 (coordination between /search API calls and /answer API calls):
365
- * 1. Call /search API with the auto-session mode (see below).
366
- * 2. Call /answer API with the session ID generated in the first call.
367
- * Here, the answer generation happens in the context of the search
368
- * results from the first search call.
369
- *
370
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
371
- * gets automatically created. Otherwise, users can use the create-session API
372
- * to create a session manually.
430
+ * Call /answer API with the session ID generated in the first call.
431
+ * Here, the answer generation happens in the context of the search
432
+ * results from the first search call.
373
433
  *
374
434
  * Multi-turn Search feature is currently at private GA stage. Please use
375
435
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -593,8 +653,14 @@ export declare class SearchServiceClient {
593
653
  * The ranking expression controls the customized ranking on retrieval
594
654
  * documents. This overrides
595
655
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
596
- * The ranking expression is a single function or multiple functions that are
597
- * joined by "+".
656
+ * The syntax and supported features depend on the
657
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
658
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
659
+ *
660
+ * If
661
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
662
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
663
+ * function or multiple functions that are joined by "+".
598
664
  *
599
665
  * * ranking_expression = function, { " + ", function };
600
666
  *
@@ -609,13 +675,73 @@ export declare class SearchServiceClient {
609
675
  * between query and document.
610
676
  * * `embedding_field_path`: the document embedding field
611
677
  * used with query embedding vector.
612
- * * `dotProduct`: embedding function between embedding_field_path and query
613
- * embedding vector.
678
+ * * `dotProduct`: embedding function between `embedding_field_path` and
679
+ * query embedding vector.
614
680
  *
615
681
  * Example ranking expression:
616
682
  *
617
683
  * If document has an embedding field doc_embedding, the ranking expression
618
684
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
685
+ *
686
+ * If
687
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
688
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
689
+ * combinations of those chained using + or
690
+ * * operators) are supported:
691
+ *
692
+ * * `double`
693
+ * * `signal`
694
+ * * `log(signal)`
695
+ * * `exp(signal)`
696
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
697
+ * argument being a denominator constant.
698
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
699
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
700
+ * signal2 | double, else returns signal1.
701
+ *
702
+ * Here are a few examples of ranking formulas that use the supported
703
+ * ranking expression types:
704
+ *
705
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
706
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
707
+ * `semantic_smilarity_score` adjustment.
708
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
709
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
710
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
711
+ * add constant 0.3 adjustment to the final score if
712
+ * `semantic_similarity_score` is NaN.
713
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
714
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
715
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
716
+ * of `semantic_smilarity_score`.
717
+ *
718
+ * The following signals are supported:
719
+ *
720
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
721
+ * calculated using the embeddings generated by a proprietary Google model.
722
+ * This score determines how semantically similar a search query is to a
723
+ * document.
724
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
725
+ * Match 25 (BM25) ranking function. This score is calculated using a
726
+ * probabilistic model to estimate the probability that a document is
727
+ * relevant to a given query.
728
+ * * `relevance_score`: semantic relevance adjustment that uses a
729
+ * proprietary Google model to determine the meaning and intent behind a
730
+ * user's query in context with the content in the documents.
731
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
732
+ * predicted Click-through rate (pCTR) to gauge the relevance and
733
+ * attractiveness of a search result from a user's perspective. A higher
734
+ * pCTR suggests that the result is more likely to satisfy the user's query
735
+ * and intent, making it a valuable signal for ranking.
736
+ * * `freshness_rank`: freshness adjustment as a rank
737
+ * * `document_age`: The time in hours elapsed since the document was last
738
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
739
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
740
+ * Google model to determine the keyword-based overlap between the query and
741
+ * the document.
742
+ * * `base_rank`: the default rank of the result
743
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
744
+ * The backend to use for the ranking expression evaluation.
619
745
  * @param {boolean} request.safeSearch
620
746
  * Whether to turn on safe search. This is only supported for
621
747
  * website search.
@@ -651,22 +777,16 @@ export declare class SearchServiceClient {
651
777
  * between /search API calls and /answer API calls.
652
778
  *
653
779
  * Example #1 (multi-turn /search API calls):
654
- * 1. Call /search API with the auto-session mode (see below).
655
- * 2. Call /search API with the session ID generated in the first call.
656
- * Here, the previous search query gets considered in query
657
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
658
- * and the current query is "How about 2023?", the current query will
659
- * be interpreted as "How did Alphabet do in 2023?".
780
+ * Call /search API with the session ID generated in the first call.
781
+ * Here, the previous search query gets considered in query
782
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
783
+ * and the current query is "How about 2023?", the current query will
784
+ * be interpreted as "How did Alphabet do in 2023?".
660
785
  *
661
786
  * Example #2 (coordination between /search API calls and /answer API calls):
662
- * 1. Call /search API with the auto-session mode (see below).
663
- * 2. Call /answer API with the session ID generated in the first call.
664
- * Here, the answer generation happens in the context of the search
665
- * results from the first search call.
666
- *
667
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
668
- * gets automatically created. Otherwise, users can use the create-session API
669
- * to create a session manually.
787
+ * Call /answer API with the session ID generated in the first call.
788
+ * Here, the answer generation happens in the context of the search
789
+ * results from the first search call.
670
790
  *
671
791
  * Multi-turn Search feature is currently at private GA stage. Please use
672
792
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -885,8 +1005,14 @@ export declare class SearchServiceClient {
885
1005
  * The ranking expression controls the customized ranking on retrieval
886
1006
  * documents. This overrides
887
1007
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
888
- * The ranking expression is a single function or multiple functions that are
889
- * joined by "+".
1008
+ * The syntax and supported features depend on the
1009
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
1010
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
1011
+ *
1012
+ * If
1013
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1014
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
1015
+ * function or multiple functions that are joined by "+".
890
1016
  *
891
1017
  * * ranking_expression = function, { " + ", function };
892
1018
  *
@@ -901,13 +1027,73 @@ export declare class SearchServiceClient {
901
1027
  * between query and document.
902
1028
  * * `embedding_field_path`: the document embedding field
903
1029
  * used with query embedding vector.
904
- * * `dotProduct`: embedding function between embedding_field_path and query
905
- * embedding vector.
1030
+ * * `dotProduct`: embedding function between `embedding_field_path` and
1031
+ * query embedding vector.
906
1032
  *
907
1033
  * Example ranking expression:
908
1034
  *
909
1035
  * If document has an embedding field doc_embedding, the ranking expression
910
1036
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
1037
+ *
1038
+ * If
1039
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1040
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
1041
+ * combinations of those chained using + or
1042
+ * * operators) are supported:
1043
+ *
1044
+ * * `double`
1045
+ * * `signal`
1046
+ * * `log(signal)`
1047
+ * * `exp(signal)`
1048
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
1049
+ * argument being a denominator constant.
1050
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
1051
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
1052
+ * signal2 | double, else returns signal1.
1053
+ *
1054
+ * Here are a few examples of ranking formulas that use the supported
1055
+ * ranking expression types:
1056
+ *
1057
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
1058
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
1059
+ * `semantic_smilarity_score` adjustment.
1060
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
1061
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
1062
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
1063
+ * add constant 0.3 adjustment to the final score if
1064
+ * `semantic_similarity_score` is NaN.
1065
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
1066
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
1067
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
1068
+ * of `semantic_smilarity_score`.
1069
+ *
1070
+ * The following signals are supported:
1071
+ *
1072
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
1073
+ * calculated using the embeddings generated by a proprietary Google model.
1074
+ * This score determines how semantically similar a search query is to a
1075
+ * document.
1076
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
1077
+ * Match 25 (BM25) ranking function. This score is calculated using a
1078
+ * probabilistic model to estimate the probability that a document is
1079
+ * relevant to a given query.
1080
+ * * `relevance_score`: semantic relevance adjustment that uses a
1081
+ * proprietary Google model to determine the meaning and intent behind a
1082
+ * user's query in context with the content in the documents.
1083
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
1084
+ * predicted Click-through rate (pCTR) to gauge the relevance and
1085
+ * attractiveness of a search result from a user's perspective. A higher
1086
+ * pCTR suggests that the result is more likely to satisfy the user's query
1087
+ * and intent, making it a valuable signal for ranking.
1088
+ * * `freshness_rank`: freshness adjustment as a rank
1089
+ * * `document_age`: The time in hours elapsed since the document was last
1090
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
1091
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
1092
+ * Google model to determine the keyword-based overlap between the query and
1093
+ * the document.
1094
+ * * `base_rank`: the default rank of the result
1095
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1096
+ * The backend to use for the ranking expression evaluation.
911
1097
  * @param {boolean} request.safeSearch
912
1098
  * Whether to turn on safe search. This is only supported for
913
1099
  * website search.
@@ -943,22 +1129,16 @@ export declare class SearchServiceClient {
943
1129
  * between /search API calls and /answer API calls.
944
1130
  *
945
1131
  * Example #1 (multi-turn /search API calls):
946
- * 1. Call /search API with the auto-session mode (see below).
947
- * 2. Call /search API with the session ID generated in the first call.
948
- * Here, the previous search query gets considered in query
949
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
950
- * and the current query is "How about 2023?", the current query will
951
- * be interpreted as "How did Alphabet do in 2023?".
1132
+ * Call /search API with the session ID generated in the first call.
1133
+ * Here, the previous search query gets considered in query
1134
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1135
+ * and the current query is "How about 2023?", the current query will
1136
+ * be interpreted as "How did Alphabet do in 2023?".
952
1137
  *
953
1138
  * Example #2 (coordination between /search API calls and /answer API calls):
954
- * 1. Call /search API with the auto-session mode (see below).
955
- * 2. Call /answer API with the session ID generated in the first call.
956
- * Here, the answer generation happens in the context of the search
957
- * results from the first search call.
958
- *
959
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
960
- * gets automatically created. Otherwise, users can use the create-session API
961
- * to create a session manually.
1139
+ * Call /answer API with the session ID generated in the first call.
1140
+ * Here, the answer generation happens in the context of the search
1141
+ * results from the first search call.
962
1142
  *
963
1143
  * Multi-turn Search feature is currently at private GA stage. Please use
964
1144
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -1189,8 +1369,14 @@ export declare class SearchServiceClient {
1189
1369
  * The ranking expression controls the customized ranking on retrieval
1190
1370
  * documents. This overrides
1191
1371
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1192
- * The ranking expression is a single function or multiple functions that are
1193
- * joined by "+".
1372
+ * The syntax and supported features depend on the
1373
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
1374
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
1375
+ *
1376
+ * If
1377
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1378
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
1379
+ * function or multiple functions that are joined by "+".
1194
1380
  *
1195
1381
  * * ranking_expression = function, { " + ", function };
1196
1382
  *
@@ -1205,13 +1391,73 @@ export declare class SearchServiceClient {
1205
1391
  * between query and document.
1206
1392
  * * `embedding_field_path`: the document embedding field
1207
1393
  * used with query embedding vector.
1208
- * * `dotProduct`: embedding function between embedding_field_path and query
1209
- * embedding vector.
1394
+ * * `dotProduct`: embedding function between `embedding_field_path` and
1395
+ * query embedding vector.
1210
1396
  *
1211
1397
  * Example ranking expression:
1212
1398
  *
1213
1399
  * If document has an embedding field doc_embedding, the ranking expression
1214
1400
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
1401
+ *
1402
+ * If
1403
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1404
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
1405
+ * combinations of those chained using + or
1406
+ * * operators) are supported:
1407
+ *
1408
+ * * `double`
1409
+ * * `signal`
1410
+ * * `log(signal)`
1411
+ * * `exp(signal)`
1412
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
1413
+ * argument being a denominator constant.
1414
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
1415
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
1416
+ * signal2 | double, else returns signal1.
1417
+ *
1418
+ * Here are a few examples of ranking formulas that use the supported
1419
+ * ranking expression types:
1420
+ *
1421
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
1422
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
1423
+ * `semantic_smilarity_score` adjustment.
1424
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
1425
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
1426
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
1427
+ * add constant 0.3 adjustment to the final score if
1428
+ * `semantic_similarity_score` is NaN.
1429
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
1430
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
1431
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
1432
+ * of `semantic_smilarity_score`.
1433
+ *
1434
+ * The following signals are supported:
1435
+ *
1436
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
1437
+ * calculated using the embeddings generated by a proprietary Google model.
1438
+ * This score determines how semantically similar a search query is to a
1439
+ * document.
1440
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
1441
+ * Match 25 (BM25) ranking function. This score is calculated using a
1442
+ * probabilistic model to estimate the probability that a document is
1443
+ * relevant to a given query.
1444
+ * * `relevance_score`: semantic relevance adjustment that uses a
1445
+ * proprietary Google model to determine the meaning and intent behind a
1446
+ * user's query in context with the content in the documents.
1447
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
1448
+ * predicted Click-through rate (pCTR) to gauge the relevance and
1449
+ * attractiveness of a search result from a user's perspective. A higher
1450
+ * pCTR suggests that the result is more likely to satisfy the user's query
1451
+ * and intent, making it a valuable signal for ranking.
1452
+ * * `freshness_rank`: freshness adjustment as a rank
1453
+ * * `document_age`: The time in hours elapsed since the document was last
1454
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
1455
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
1456
+ * Google model to determine the keyword-based overlap between the query and
1457
+ * the document.
1458
+ * * `base_rank`: the default rank of the result
1459
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1460
+ * The backend to use for the ranking expression evaluation.
1215
1461
  * @param {boolean} request.safeSearch
1216
1462
  * Whether to turn on safe search. This is only supported for
1217
1463
  * website search.
@@ -1247,22 +1493,16 @@ export declare class SearchServiceClient {
1247
1493
  * between /search API calls and /answer API calls.
1248
1494
  *
1249
1495
  * Example #1 (multi-turn /search API calls):
1250
- * 1. Call /search API with the auto-session mode (see below).
1251
- * 2. Call /search API with the session ID generated in the first call.
1252
- * Here, the previous search query gets considered in query
1253
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1254
- * and the current query is "How about 2023?", the current query will
1255
- * be interpreted as "How did Alphabet do in 2023?".
1496
+ * Call /search API with the session ID generated in the first call.
1497
+ * Here, the previous search query gets considered in query
1498
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1499
+ * and the current query is "How about 2023?", the current query will
1500
+ * be interpreted as "How did Alphabet do in 2023?".
1256
1501
  *
1257
1502
  * Example #2 (coordination between /search API calls and /answer API calls):
1258
- * 1. Call /search API with the auto-session mode (see below).
1259
- * 2. Call /answer API with the session ID generated in the first call.
1260
- * Here, the answer generation happens in the context of the search
1261
- * results from the first search call.
1262
- *
1263
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
1264
- * gets automatically created. Otherwise, users can use the create-session API
1265
- * to create a session manually.
1503
+ * Call /answer API with the session ID generated in the first call.
1504
+ * Here, the answer generation happens in the context of the search
1505
+ * results from the first search call.
1266
1506
  *
1267
1507
  * Multi-turn Search feature is currently at private GA stage. Please use
1268
1508
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -1486,8 +1726,14 @@ export declare class SearchServiceClient {
1486
1726
  * The ranking expression controls the customized ranking on retrieval
1487
1727
  * documents. This overrides
1488
1728
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1489
- * The ranking expression is a single function or multiple functions that are
1490
- * joined by "+".
1729
+ * The syntax and supported features depend on the
1730
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
1731
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
1732
+ *
1733
+ * If
1734
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1735
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
1736
+ * function or multiple functions that are joined by "+".
1491
1737
  *
1492
1738
  * * ranking_expression = function, { " + ", function };
1493
1739
  *
@@ -1502,13 +1748,73 @@ export declare class SearchServiceClient {
1502
1748
  * between query and document.
1503
1749
  * * `embedding_field_path`: the document embedding field
1504
1750
  * used with query embedding vector.
1505
- * * `dotProduct`: embedding function between embedding_field_path and query
1506
- * embedding vector.
1751
+ * * `dotProduct`: embedding function between `embedding_field_path` and
1752
+ * query embedding vector.
1507
1753
  *
1508
1754
  * Example ranking expression:
1509
1755
  *
1510
1756
  * If document has an embedding field doc_embedding, the ranking expression
1511
1757
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
1758
+ *
1759
+ * If
1760
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1761
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
1762
+ * combinations of those chained using + or
1763
+ * * operators) are supported:
1764
+ *
1765
+ * * `double`
1766
+ * * `signal`
1767
+ * * `log(signal)`
1768
+ * * `exp(signal)`
1769
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
1770
+ * argument being a denominator constant.
1771
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
1772
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
1773
+ * signal2 | double, else returns signal1.
1774
+ *
1775
+ * Here are a few examples of ranking formulas that use the supported
1776
+ * ranking expression types:
1777
+ *
1778
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
1779
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
1780
+ * `semantic_smilarity_score` adjustment.
1781
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
1782
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
1783
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
1784
+ * add constant 0.3 adjustment to the final score if
1785
+ * `semantic_similarity_score` is NaN.
1786
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
1787
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
1788
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
1789
+ * of `semantic_smilarity_score`.
1790
+ *
1791
+ * The following signals are supported:
1792
+ *
1793
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
1794
+ * calculated using the embeddings generated by a proprietary Google model.
1795
+ * This score determines how semantically similar a search query is to a
1796
+ * document.
1797
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
1798
+ * Match 25 (BM25) ranking function. This score is calculated using a
1799
+ * probabilistic model to estimate the probability that a document is
1800
+ * relevant to a given query.
1801
+ * * `relevance_score`: semantic relevance adjustment that uses a
1802
+ * proprietary Google model to determine the meaning and intent behind a
1803
+ * user's query in context with the content in the documents.
1804
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
1805
+ * predicted Click-through rate (pCTR) to gauge the relevance and
1806
+ * attractiveness of a search result from a user's perspective. A higher
1807
+ * pCTR suggests that the result is more likely to satisfy the user's query
1808
+ * and intent, making it a valuable signal for ranking.
1809
+ * * `freshness_rank`: freshness adjustment as a rank
1810
+ * * `document_age`: The time in hours elapsed since the document was last
1811
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
1812
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
1813
+ * Google model to determine the keyword-based overlap between the query and
1814
+ * the document.
1815
+ * * `base_rank`: the default rank of the result
1816
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1817
+ * The backend to use for the ranking expression evaluation.
1512
1818
  * @param {boolean} request.safeSearch
1513
1819
  * Whether to turn on safe search. This is only supported for
1514
1820
  * website search.
@@ -1544,22 +1850,16 @@ export declare class SearchServiceClient {
1544
1850
  * between /search API calls and /answer API calls.
1545
1851
  *
1546
1852
  * Example #1 (multi-turn /search API calls):
1547
- * 1. Call /search API with the auto-session mode (see below).
1548
- * 2. Call /search API with the session ID generated in the first call.
1549
- * Here, the previous search query gets considered in query
1550
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1551
- * and the current query is "How about 2023?", the current query will
1552
- * be interpreted as "How did Alphabet do in 2023?".
1853
+ * Call /search API with the session ID generated in the first call.
1854
+ * Here, the previous search query gets considered in query
1855
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1856
+ * and the current query is "How about 2023?", the current query will
1857
+ * be interpreted as "How did Alphabet do in 2023?".
1553
1858
  *
1554
1859
  * Example #2 (coordination between /search API calls and /answer API calls):
1555
- * 1. Call /search API with the auto-session mode (see below).
1556
- * 2. Call /answer API with the session ID generated in the first call.
1557
- * Here, the answer generation happens in the context of the search
1558
- * results from the first search call.
1559
- *
1560
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
1561
- * gets automatically created. Otherwise, users can use the create-session API
1562
- * to create a session manually.
1860
+ * Call /answer API with the session ID generated in the first call.
1861
+ * Here, the answer generation happens in the context of the search
1862
+ * results from the first search call.
1563
1863
  *
1564
1864
  * Multi-turn Search feature is currently at private GA stage. Please use
1565
1865
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -1778,8 +2078,14 @@ export declare class SearchServiceClient {
1778
2078
  * The ranking expression controls the customized ranking on retrieval
1779
2079
  * documents. This overrides
1780
2080
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1781
- * The ranking expression is a single function or multiple functions that are
1782
- * joined by "+".
2081
+ * The syntax and supported features depend on the
2082
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
2083
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
2084
+ *
2085
+ * If
2086
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
2087
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
2088
+ * function or multiple functions that are joined by "+".
1783
2089
  *
1784
2090
  * * ranking_expression = function, { " + ", function };
1785
2091
  *
@@ -1794,13 +2100,73 @@ export declare class SearchServiceClient {
1794
2100
  * between query and document.
1795
2101
  * * `embedding_field_path`: the document embedding field
1796
2102
  * used with query embedding vector.
1797
- * * `dotProduct`: embedding function between embedding_field_path and query
1798
- * embedding vector.
2103
+ * * `dotProduct`: embedding function between `embedding_field_path` and
2104
+ * query embedding vector.
1799
2105
  *
1800
2106
  * Example ranking expression:
1801
2107
  *
1802
2108
  * If document has an embedding field doc_embedding, the ranking expression
1803
2109
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
2110
+ *
2111
+ * If
2112
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
2113
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
2114
+ * combinations of those chained using + or
2115
+ * * operators) are supported:
2116
+ *
2117
+ * * `double`
2118
+ * * `signal`
2119
+ * * `log(signal)`
2120
+ * * `exp(signal)`
2121
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
2122
+ * argument being a denominator constant.
2123
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
2124
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
2125
+ * signal2 | double, else returns signal1.
2126
+ *
2127
+ * Here are a few examples of ranking formulas that use the supported
2128
+ * ranking expression types:
2129
+ *
2130
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
2131
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
2132
+ * `semantic_smilarity_score` adjustment.
2133
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
2134
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
2135
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
2136
+ * add constant 0.3 adjustment to the final score if
2137
+ * `semantic_similarity_score` is NaN.
2138
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
2139
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
2140
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
2141
+ * of `semantic_smilarity_score`.
2142
+ *
2143
+ * The following signals are supported:
2144
+ *
2145
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
2146
+ * calculated using the embeddings generated by a proprietary Google model.
2147
+ * This score determines how semantically similar a search query is to a
2148
+ * document.
2149
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
2150
+ * Match 25 (BM25) ranking function. This score is calculated using a
2151
+ * probabilistic model to estimate the probability that a document is
2152
+ * relevant to a given query.
2153
+ * * `relevance_score`: semantic relevance adjustment that uses a
2154
+ * proprietary Google model to determine the meaning and intent behind a
2155
+ * user's query in context with the content in the documents.
2156
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
2157
+ * predicted Click-through rate (pCTR) to gauge the relevance and
2158
+ * attractiveness of a search result from a user's perspective. A higher
2159
+ * pCTR suggests that the result is more likely to satisfy the user's query
2160
+ * and intent, making it a valuable signal for ranking.
2161
+ * * `freshness_rank`: freshness adjustment as a rank
2162
+ * * `document_age`: The time in hours elapsed since the document was last
2163
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
2164
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
2165
+ * Google model to determine the keyword-based overlap between the query and
2166
+ * the document.
2167
+ * * `base_rank`: the default rank of the result
2168
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
2169
+ * The backend to use for the ranking expression evaluation.
1804
2170
  * @param {boolean} request.safeSearch
1805
2171
  * Whether to turn on safe search. This is only supported for
1806
2172
  * website search.
@@ -1836,22 +2202,16 @@ export declare class SearchServiceClient {
1836
2202
  * between /search API calls and /answer API calls.
1837
2203
  *
1838
2204
  * Example #1 (multi-turn /search API calls):
1839
- * 1. Call /search API with the auto-session mode (see below).
1840
- * 2. Call /search API with the session ID generated in the first call.
1841
- * Here, the previous search query gets considered in query
1842
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1843
- * and the current query is "How about 2023?", the current query will
1844
- * be interpreted as "How did Alphabet do in 2023?".
2205
+ * Call /search API with the session ID generated in the first call.
2206
+ * Here, the previous search query gets considered in query
2207
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
2208
+ * and the current query is "How about 2023?", the current query will
2209
+ * be interpreted as "How did Alphabet do in 2023?".
1845
2210
  *
1846
2211
  * Example #2 (coordination between /search API calls and /answer API calls):
1847
- * 1. Call /search API with the auto-session mode (see below).
1848
- * 2. Call /answer API with the session ID generated in the first call.
1849
- * Here, the answer generation happens in the context of the search
1850
- * results from the first search call.
1851
- *
1852
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
1853
- * gets automatically created. Otherwise, users can use the create-session API
1854
- * to create a session manually.
2212
+ * Call /answer API with the session ID generated in the first call.
2213
+ * Here, the answer generation happens in the context of the search
2214
+ * results from the first search call.
1855
2215
  *
1856
2216
  * Multi-turn Search feature is currently at private GA stage. Please use
1857
2217
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -2583,57 +2943,6 @@ export declare class SearchServiceClient {
2583
2943
  * @returns {string} A string representing the serving_config.
2584
2944
  */
2585
2945
  matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
2586
- /**
2587
- * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
2588
- *
2589
- * @param {string} project
2590
- * @param {string} location
2591
- * @param {string} collection
2592
- * @param {string} data_store
2593
- * @param {string} session
2594
- * @returns {string} Resource name string.
2595
- */
2596
- projectLocationCollectionDataStoreSessionPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
2597
- /**
2598
- * Parse the project from ProjectLocationCollectionDataStoreSession resource.
2599
- *
2600
- * @param {string} projectLocationCollectionDataStoreSessionName
2601
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2602
- * @returns {string} A string representing the project.
2603
- */
2604
- matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
2605
- /**
2606
- * Parse the location from ProjectLocationCollectionDataStoreSession resource.
2607
- *
2608
- * @param {string} projectLocationCollectionDataStoreSessionName
2609
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2610
- * @returns {string} A string representing the location.
2611
- */
2612
- matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
2613
- /**
2614
- * Parse the collection from ProjectLocationCollectionDataStoreSession resource.
2615
- *
2616
- * @param {string} projectLocationCollectionDataStoreSessionName
2617
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2618
- * @returns {string} A string representing the collection.
2619
- */
2620
- matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
2621
- /**
2622
- * Parse the data_store from ProjectLocationCollectionDataStoreSession resource.
2623
- *
2624
- * @param {string} projectLocationCollectionDataStoreSessionName
2625
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2626
- * @returns {string} A string representing the data_store.
2627
- */
2628
- matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
2629
- /**
2630
- * Parse the session from ProjectLocationCollectionDataStoreSession resource.
2631
- *
2632
- * @param {string} projectLocationCollectionDataStoreSessionName
2633
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2634
- * @returns {string} A string representing the session.
2635
- */
2636
- matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
2637
2946
  /**
2638
2947
  * Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
2639
2948
  *
@@ -2694,6 +3003,57 @@ export declare class SearchServiceClient {
2694
3003
  * @returns {string} A string representing the answer.
2695
3004
  */
2696
3005
  matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
3006
+ /**
3007
+ * Return a fully-qualified projectLocationCollectionDataStoreSessions resource name string.
3008
+ *
3009
+ * @param {string} project
3010
+ * @param {string} location
3011
+ * @param {string} collection
3012
+ * @param {string} data_store
3013
+ * @param {string} session
3014
+ * @returns {string} Resource name string.
3015
+ */
3016
+ projectLocationCollectionDataStoreSessionsPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
3017
+ /**
3018
+ * Parse the project from ProjectLocationCollectionDataStoreSessions resource.
3019
+ *
3020
+ * @param {string} projectLocationCollectionDataStoreSessionsName
3021
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
3022
+ * @returns {string} A string representing the project.
3023
+ */
3024
+ matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
3025
+ /**
3026
+ * Parse the location from ProjectLocationCollectionDataStoreSessions resource.
3027
+ *
3028
+ * @param {string} projectLocationCollectionDataStoreSessionsName
3029
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
3030
+ * @returns {string} A string representing the location.
3031
+ */
3032
+ matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
3033
+ /**
3034
+ * Parse the collection from ProjectLocationCollectionDataStoreSessions resource.
3035
+ *
3036
+ * @param {string} projectLocationCollectionDataStoreSessionsName
3037
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
3038
+ * @returns {string} A string representing the collection.
3039
+ */
3040
+ matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
3041
+ /**
3042
+ * Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.
3043
+ *
3044
+ * @param {string} projectLocationCollectionDataStoreSessionsName
3045
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
3046
+ * @returns {string} A string representing the data_store.
3047
+ */
3048
+ matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
3049
+ /**
3050
+ * Parse the session from ProjectLocationCollectionDataStoreSessions resource.
3051
+ *
3052
+ * @param {string} projectLocationCollectionDataStoreSessionsName
3053
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
3054
+ * @returns {string} A string representing the session.
3055
+ */
3056
+ matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
2697
3057
  /**
2698
3058
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
2699
3059
  *
@@ -2991,57 +3351,6 @@ export declare class SearchServiceClient {
2991
3351
  * @returns {string} A string representing the serving_config.
2992
3352
  */
2993
3353
  matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
2994
- /**
2995
- * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
2996
- *
2997
- * @param {string} project
2998
- * @param {string} location
2999
- * @param {string} collection
3000
- * @param {string} engine
3001
- * @param {string} session
3002
- * @returns {string} Resource name string.
3003
- */
3004
- projectLocationCollectionEngineSessionPath(project: string, location: string, collection: string, engine: string, session: string): string;
3005
- /**
3006
- * Parse the project from ProjectLocationCollectionEngineSession resource.
3007
- *
3008
- * @param {string} projectLocationCollectionEngineSessionName
3009
- * A fully-qualified path representing project_location_collection_engine_session resource.
3010
- * @returns {string} A string representing the project.
3011
- */
3012
- matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
3013
- /**
3014
- * Parse the location from ProjectLocationCollectionEngineSession resource.
3015
- *
3016
- * @param {string} projectLocationCollectionEngineSessionName
3017
- * A fully-qualified path representing project_location_collection_engine_session resource.
3018
- * @returns {string} A string representing the location.
3019
- */
3020
- matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
3021
- /**
3022
- * Parse the collection from ProjectLocationCollectionEngineSession resource.
3023
- *
3024
- * @param {string} projectLocationCollectionEngineSessionName
3025
- * A fully-qualified path representing project_location_collection_engine_session resource.
3026
- * @returns {string} A string representing the collection.
3027
- */
3028
- matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
3029
- /**
3030
- * Parse the engine from ProjectLocationCollectionEngineSession resource.
3031
- *
3032
- * @param {string} projectLocationCollectionEngineSessionName
3033
- * A fully-qualified path representing project_location_collection_engine_session resource.
3034
- * @returns {string} A string representing the engine.
3035
- */
3036
- matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
3037
- /**
3038
- * Parse the session from ProjectLocationCollectionEngineSession resource.
3039
- *
3040
- * @param {string} projectLocationCollectionEngineSessionName
3041
- * A fully-qualified path representing project_location_collection_engine_session resource.
3042
- * @returns {string} A string representing the session.
3043
- */
3044
- matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
3045
3354
  /**
3046
3355
  * Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
3047
3356
  *
@@ -3102,6 +3411,57 @@ export declare class SearchServiceClient {
3102
3411
  * @returns {string} A string representing the answer.
3103
3412
  */
3104
3413
  matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
3414
+ /**
3415
+ * Return a fully-qualified projectLocationCollectionEngineSessions resource name string.
3416
+ *
3417
+ * @param {string} project
3418
+ * @param {string} location
3419
+ * @param {string} collection
3420
+ * @param {string} engine
3421
+ * @param {string} session
3422
+ * @returns {string} Resource name string.
3423
+ */
3424
+ projectLocationCollectionEngineSessionsPath(project: string, location: string, collection: string, engine: string, session: string): string;
3425
+ /**
3426
+ * Parse the project from ProjectLocationCollectionEngineSessions resource.
3427
+ *
3428
+ * @param {string} projectLocationCollectionEngineSessionsName
3429
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3430
+ * @returns {string} A string representing the project.
3431
+ */
3432
+ matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
3433
+ /**
3434
+ * Parse the location from ProjectLocationCollectionEngineSessions resource.
3435
+ *
3436
+ * @param {string} projectLocationCollectionEngineSessionsName
3437
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3438
+ * @returns {string} A string representing the location.
3439
+ */
3440
+ matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
3441
+ /**
3442
+ * Parse the collection from ProjectLocationCollectionEngineSessions resource.
3443
+ *
3444
+ * @param {string} projectLocationCollectionEngineSessionsName
3445
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3446
+ * @returns {string} A string representing the collection.
3447
+ */
3448
+ matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
3449
+ /**
3450
+ * Parse the engine from ProjectLocationCollectionEngineSessions resource.
3451
+ *
3452
+ * @param {string} projectLocationCollectionEngineSessionsName
3453
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3454
+ * @returns {string} A string representing the engine.
3455
+ */
3456
+ matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
3457
+ /**
3458
+ * Parse the session from ProjectLocationCollectionEngineSessions resource.
3459
+ *
3460
+ * @param {string} projectLocationCollectionEngineSessionsName
3461
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3462
+ * @returns {string} A string representing the session.
3463
+ */
3464
+ matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
3105
3465
  /**
3106
3466
  * Return a fully-qualified projectLocationDataStore resource name string.
3107
3467
  *
@@ -3531,48 +3891,6 @@ export declare class SearchServiceClient {
3531
3891
  * @returns {string} A string representing the serving_config.
3532
3892
  */
3533
3893
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
3534
- /**
3535
- * Return a fully-qualified projectLocationDataStoreSession resource name string.
3536
- *
3537
- * @param {string} project
3538
- * @param {string} location
3539
- * @param {string} data_store
3540
- * @param {string} session
3541
- * @returns {string} Resource name string.
3542
- */
3543
- projectLocationDataStoreSessionPath(project: string, location: string, dataStore: string, session: string): string;
3544
- /**
3545
- * Parse the project from ProjectLocationDataStoreSession resource.
3546
- *
3547
- * @param {string} projectLocationDataStoreSessionName
3548
- * A fully-qualified path representing project_location_data_store_session resource.
3549
- * @returns {string} A string representing the project.
3550
- */
3551
- matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
3552
- /**
3553
- * Parse the location from ProjectLocationDataStoreSession resource.
3554
- *
3555
- * @param {string} projectLocationDataStoreSessionName
3556
- * A fully-qualified path representing project_location_data_store_session resource.
3557
- * @returns {string} A string representing the location.
3558
- */
3559
- matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
3560
- /**
3561
- * Parse the data_store from ProjectLocationDataStoreSession resource.
3562
- *
3563
- * @param {string} projectLocationDataStoreSessionName
3564
- * A fully-qualified path representing project_location_data_store_session resource.
3565
- * @returns {string} A string representing the data_store.
3566
- */
3567
- matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
3568
- /**
3569
- * Parse the session from ProjectLocationDataStoreSession resource.
3570
- *
3571
- * @param {string} projectLocationDataStoreSessionName
3572
- * A fully-qualified path representing project_location_data_store_session resource.
3573
- * @returns {string} A string representing the session.
3574
- */
3575
- matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
3576
3894
  /**
3577
3895
  * Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.
3578
3896
  *
@@ -3624,6 +3942,48 @@ export declare class SearchServiceClient {
3624
3942
  * @returns {string} A string representing the answer.
3625
3943
  */
3626
3944
  matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
3945
+ /**
3946
+ * Return a fully-qualified projectLocationDataStoreSessions resource name string.
3947
+ *
3948
+ * @param {string} project
3949
+ * @param {string} location
3950
+ * @param {string} data_store
3951
+ * @param {string} session
3952
+ * @returns {string} Resource name string.
3953
+ */
3954
+ projectLocationDataStoreSessionsPath(project: string, location: string, dataStore: string, session: string): string;
3955
+ /**
3956
+ * Parse the project from ProjectLocationDataStoreSessions resource.
3957
+ *
3958
+ * @param {string} projectLocationDataStoreSessionsName
3959
+ * A fully-qualified path representing project_location_data_store_sessions resource.
3960
+ * @returns {string} A string representing the project.
3961
+ */
3962
+ matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
3963
+ /**
3964
+ * Parse the location from ProjectLocationDataStoreSessions resource.
3965
+ *
3966
+ * @param {string} projectLocationDataStoreSessionsName
3967
+ * A fully-qualified path representing project_location_data_store_sessions resource.
3968
+ * @returns {string} A string representing the location.
3969
+ */
3970
+ matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
3971
+ /**
3972
+ * Parse the data_store from ProjectLocationDataStoreSessions resource.
3973
+ *
3974
+ * @param {string} projectLocationDataStoreSessionsName
3975
+ * A fully-qualified path representing project_location_data_store_sessions resource.
3976
+ * @returns {string} A string representing the data_store.
3977
+ */
3978
+ matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
3979
+ /**
3980
+ * Parse the session from ProjectLocationDataStoreSessions resource.
3981
+ *
3982
+ * @param {string} projectLocationDataStoreSessionsName
3983
+ * A fully-qualified path representing project_location_data_store_sessions resource.
3984
+ * @returns {string} A string representing the session.
3985
+ */
3986
+ matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
3627
3987
  /**
3628
3988
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
3629
3989
  *