@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
@@ -176,16 +176,16 @@ class SearchServiceClient {
176
176
  projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
177
177
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
178
178
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
179
- projectLocationCollectionDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
180
179
  projectLocationCollectionDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
180
+ projectLocationCollectionDataStoreSessionsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
181
181
  projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
182
182
  projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
183
183
  projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
184
184
  projectLocationCollectionEngineControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/controls/{control}'),
185
185
  projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
186
186
  projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
187
- projectLocationCollectionEngineSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}'),
188
187
  projectLocationCollectionEngineSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}'),
188
+ projectLocationCollectionEngineSessionsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}'),
189
189
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
190
190
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
191
191
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
@@ -196,8 +196,8 @@ class SearchServiceClient {
196
196
  projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
197
197
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
198
198
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
199
- projectLocationDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
200
199
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
200
+ projectLocationDataStoreSessionsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
201
201
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
202
202
  projectLocationDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
203
203
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
@@ -532,8 +532,14 @@ class SearchServiceClient {
532
532
  * The ranking expression controls the customized ranking on retrieval
533
533
  * documents. This overrides
534
534
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
535
- * The ranking expression is a single function or multiple functions that are
536
- * joined by "+".
535
+ * The syntax and supported features depend on the
536
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
537
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
538
+ *
539
+ * If
540
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
541
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
542
+ * function or multiple functions that are joined by "+".
537
543
  *
538
544
  * * ranking_expression = function, { " + ", function };
539
545
  *
@@ -548,13 +554,73 @@ class SearchServiceClient {
548
554
  * between query and document.
549
555
  * * `embedding_field_path`: the document embedding field
550
556
  * used with query embedding vector.
551
- * * `dotProduct`: embedding function between embedding_field_path and query
552
- * embedding vector.
557
+ * * `dotProduct`: embedding function between `embedding_field_path` and
558
+ * query embedding vector.
553
559
  *
554
560
  * Example ranking expression:
555
561
  *
556
562
  * If document has an embedding field doc_embedding, the ranking expression
557
563
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
564
+ *
565
+ * If
566
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
567
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
568
+ * combinations of those chained using + or
569
+ * * operators) are supported:
570
+ *
571
+ * * `double`
572
+ * * `signal`
573
+ * * `log(signal)`
574
+ * * `exp(signal)`
575
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
576
+ * argument being a denominator constant.
577
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
578
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
579
+ * signal2 | double, else returns signal1.
580
+ *
581
+ * Here are a few examples of ranking formulas that use the supported
582
+ * ranking expression types:
583
+ *
584
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
585
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
586
+ * `semantic_smilarity_score` adjustment.
587
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
588
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
589
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
590
+ * add constant 0.3 adjustment to the final score if
591
+ * `semantic_similarity_score` is NaN.
592
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
593
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
594
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
595
+ * of `semantic_smilarity_score`.
596
+ *
597
+ * The following signals are supported:
598
+ *
599
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
600
+ * calculated using the embeddings generated by a proprietary Google model.
601
+ * This score determines how semantically similar a search query is to a
602
+ * document.
603
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
604
+ * Match 25 (BM25) ranking function. This score is calculated using a
605
+ * probabilistic model to estimate the probability that a document is
606
+ * relevant to a given query.
607
+ * * `relevance_score`: semantic relevance adjustment that uses a
608
+ * proprietary Google model to determine the meaning and intent behind a
609
+ * user's query in context with the content in the documents.
610
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
611
+ * predicted Click-through rate (pCTR) to gauge the relevance and
612
+ * attractiveness of a search result from a user's perspective. A higher
613
+ * pCTR suggests that the result is more likely to satisfy the user's query
614
+ * and intent, making it a valuable signal for ranking.
615
+ * * `freshness_rank`: freshness adjustment as a rank
616
+ * * `document_age`: The time in hours elapsed since the document was last
617
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
618
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
619
+ * Google model to determine the keyword-based overlap between the query and
620
+ * the document.
621
+ * * `base_rank`: the default rank of the result
622
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
623
+ * The backend to use for the ranking expression evaluation.
558
624
  * @param {boolean} request.safeSearch
559
625
  * Whether to turn on safe search. This is only supported for
560
626
  * website search.
@@ -590,22 +656,16 @@ class SearchServiceClient {
590
656
  * between /search API calls and /answer API calls.
591
657
  *
592
658
  * Example #1 (multi-turn /search API calls):
593
- * 1. Call /search API with the auto-session mode (see below).
594
- * 2. Call /search API with the session ID generated in the first call.
595
- * Here, the previous search query gets considered in query
596
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
597
- * and the current query is "How about 2023?", the current query will
598
- * be interpreted as "How did Alphabet do in 2023?".
659
+ * Call /search API with the session ID generated in the first call.
660
+ * Here, the previous search query gets considered in query
661
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
662
+ * and the current query is "How about 2023?", the current query will
663
+ * be interpreted as "How did Alphabet do in 2023?".
599
664
  *
600
665
  * Example #2 (coordination between /search API calls and /answer API calls):
601
- * 1. Call /search API with the auto-session mode (see below).
602
- * 2. Call /answer API with the session ID generated in the first call.
603
- * Here, the answer generation happens in the context of the search
604
- * results from the first search call.
605
- *
606
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
607
- * gets automatically created. Otherwise, users can use the create-session API
608
- * to create a session manually.
666
+ * Call /answer API with the session ID generated in the first call.
667
+ * Here, the answer generation happens in the context of the search
668
+ * results from the first search call.
609
669
  *
610
670
  * Multi-turn Search feature is currently at private GA stage. Please use
611
671
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -837,8 +897,14 @@ class SearchServiceClient {
837
897
  * The ranking expression controls the customized ranking on retrieval
838
898
  * documents. This overrides
839
899
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
840
- * The ranking expression is a single function or multiple functions that are
841
- * joined by "+".
900
+ * The syntax and supported features depend on the
901
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
902
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
903
+ *
904
+ * If
905
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
906
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
907
+ * function or multiple functions that are joined by "+".
842
908
  *
843
909
  * * ranking_expression = function, { " + ", function };
844
910
  *
@@ -853,13 +919,73 @@ class SearchServiceClient {
853
919
  * between query and document.
854
920
  * * `embedding_field_path`: the document embedding field
855
921
  * used with query embedding vector.
856
- * * `dotProduct`: embedding function between embedding_field_path and query
857
- * embedding vector.
922
+ * * `dotProduct`: embedding function between `embedding_field_path` and
923
+ * query embedding vector.
858
924
  *
859
925
  * Example ranking expression:
860
926
  *
861
927
  * If document has an embedding field doc_embedding, the ranking expression
862
928
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
929
+ *
930
+ * If
931
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
932
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
933
+ * combinations of those chained using + or
934
+ * * operators) are supported:
935
+ *
936
+ * * `double`
937
+ * * `signal`
938
+ * * `log(signal)`
939
+ * * `exp(signal)`
940
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
941
+ * argument being a denominator constant.
942
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
943
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
944
+ * signal2 | double, else returns signal1.
945
+ *
946
+ * Here are a few examples of ranking formulas that use the supported
947
+ * ranking expression types:
948
+ *
949
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
950
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
951
+ * `semantic_smilarity_score` adjustment.
952
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
953
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
954
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
955
+ * add constant 0.3 adjustment to the final score if
956
+ * `semantic_similarity_score` is NaN.
957
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
958
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
959
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
960
+ * of `semantic_smilarity_score`.
961
+ *
962
+ * The following signals are supported:
963
+ *
964
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
965
+ * calculated using the embeddings generated by a proprietary Google model.
966
+ * This score determines how semantically similar a search query is to a
967
+ * document.
968
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
969
+ * Match 25 (BM25) ranking function. This score is calculated using a
970
+ * probabilistic model to estimate the probability that a document is
971
+ * relevant to a given query.
972
+ * * `relevance_score`: semantic relevance adjustment that uses a
973
+ * proprietary Google model to determine the meaning and intent behind a
974
+ * user's query in context with the content in the documents.
975
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
976
+ * predicted Click-through rate (pCTR) to gauge the relevance and
977
+ * attractiveness of a search result from a user's perspective. A higher
978
+ * pCTR suggests that the result is more likely to satisfy the user's query
979
+ * and intent, making it a valuable signal for ranking.
980
+ * * `freshness_rank`: freshness adjustment as a rank
981
+ * * `document_age`: The time in hours elapsed since the document was last
982
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
983
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
984
+ * Google model to determine the keyword-based overlap between the query and
985
+ * the document.
986
+ * * `base_rank`: the default rank of the result
987
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
988
+ * The backend to use for the ranking expression evaluation.
863
989
  * @param {boolean} request.safeSearch
864
990
  * Whether to turn on safe search. This is only supported for
865
991
  * website search.
@@ -895,22 +1021,16 @@ class SearchServiceClient {
895
1021
  * between /search API calls and /answer API calls.
896
1022
  *
897
1023
  * Example #1 (multi-turn /search API calls):
898
- * 1. Call /search API with the auto-session mode (see below).
899
- * 2. Call /search API with the session ID generated in the first call.
900
- * Here, the previous search query gets considered in query
901
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
902
- * and the current query is "How about 2023?", the current query will
903
- * be interpreted as "How did Alphabet do in 2023?".
1024
+ * Call /search API with the session ID generated in the first call.
1025
+ * Here, the previous search query gets considered in query
1026
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1027
+ * and the current query is "How about 2023?", the current query will
1028
+ * be interpreted as "How did Alphabet do in 2023?".
904
1029
  *
905
1030
  * Example #2 (coordination between /search API calls and /answer API calls):
906
- * 1. Call /search API with the auto-session mode (see below).
907
- * 2. Call /answer API with the session ID generated in the first call.
908
- * Here, the answer generation happens in the context of the search
909
- * results from the first search call.
910
- *
911
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
912
- * gets automatically created. Otherwise, users can use the create-session API
913
- * to create a session manually.
1031
+ * Call /answer API with the session ID generated in the first call.
1032
+ * Here, the answer generation happens in the context of the search
1033
+ * results from the first search call.
914
1034
  *
915
1035
  * Multi-turn Search feature is currently at private GA stage. Please use
916
1036
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -1172,8 +1292,14 @@ class SearchServiceClient {
1172
1292
  * The ranking expression controls the customized ranking on retrieval
1173
1293
  * documents. This overrides
1174
1294
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1175
- * The ranking expression is a single function or multiple functions that are
1176
- * joined by "+".
1295
+ * The syntax and supported features depend on the
1296
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
1297
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
1298
+ *
1299
+ * If
1300
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1301
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
1302
+ * function or multiple functions that are joined by "+".
1177
1303
  *
1178
1304
  * * ranking_expression = function, { " + ", function };
1179
1305
  *
@@ -1188,13 +1314,73 @@ class SearchServiceClient {
1188
1314
  * between query and document.
1189
1315
  * * `embedding_field_path`: the document embedding field
1190
1316
  * used with query embedding vector.
1191
- * * `dotProduct`: embedding function between embedding_field_path and query
1192
- * embedding vector.
1317
+ * * `dotProduct`: embedding function between `embedding_field_path` and
1318
+ * query embedding vector.
1193
1319
  *
1194
1320
  * Example ranking expression:
1195
1321
  *
1196
1322
  * If document has an embedding field doc_embedding, the ranking expression
1197
1323
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
1324
+ *
1325
+ * If
1326
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1327
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
1328
+ * combinations of those chained using + or
1329
+ * * operators) are supported:
1330
+ *
1331
+ * * `double`
1332
+ * * `signal`
1333
+ * * `log(signal)`
1334
+ * * `exp(signal)`
1335
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
1336
+ * argument being a denominator constant.
1337
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
1338
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
1339
+ * signal2 | double, else returns signal1.
1340
+ *
1341
+ * Here are a few examples of ranking formulas that use the supported
1342
+ * ranking expression types:
1343
+ *
1344
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
1345
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
1346
+ * `semantic_smilarity_score` adjustment.
1347
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
1348
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
1349
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
1350
+ * add constant 0.3 adjustment to the final score if
1351
+ * `semantic_similarity_score` is NaN.
1352
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
1353
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
1354
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
1355
+ * of `semantic_smilarity_score`.
1356
+ *
1357
+ * The following signals are supported:
1358
+ *
1359
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
1360
+ * calculated using the embeddings generated by a proprietary Google model.
1361
+ * This score determines how semantically similar a search query is to a
1362
+ * document.
1363
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
1364
+ * Match 25 (BM25) ranking function. This score is calculated using a
1365
+ * probabilistic model to estimate the probability that a document is
1366
+ * relevant to a given query.
1367
+ * * `relevance_score`: semantic relevance adjustment that uses a
1368
+ * proprietary Google model to determine the meaning and intent behind a
1369
+ * user's query in context with the content in the documents.
1370
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
1371
+ * predicted Click-through rate (pCTR) to gauge the relevance and
1372
+ * attractiveness of a search result from a user's perspective. A higher
1373
+ * pCTR suggests that the result is more likely to satisfy the user's query
1374
+ * and intent, making it a valuable signal for ranking.
1375
+ * * `freshness_rank`: freshness adjustment as a rank
1376
+ * * `document_age`: The time in hours elapsed since the document was last
1377
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
1378
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
1379
+ * Google model to determine the keyword-based overlap between the query and
1380
+ * the document.
1381
+ * * `base_rank`: the default rank of the result
1382
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1383
+ * The backend to use for the ranking expression evaluation.
1198
1384
  * @param {boolean} request.safeSearch
1199
1385
  * Whether to turn on safe search. This is only supported for
1200
1386
  * website search.
@@ -1230,22 +1416,16 @@ class SearchServiceClient {
1230
1416
  * between /search API calls and /answer API calls.
1231
1417
  *
1232
1418
  * Example #1 (multi-turn /search API calls):
1233
- * 1. Call /search API with the auto-session mode (see below).
1234
- * 2. Call /search API with the session ID generated in the first call.
1235
- * Here, the previous search query gets considered in query
1236
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1237
- * and the current query is "How about 2023?", the current query will
1238
- * be interpreted as "How did Alphabet do in 2023?".
1419
+ * Call /search API with the session ID generated in the first call.
1420
+ * Here, the previous search query gets considered in query
1421
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1422
+ * and the current query is "How about 2023?", the current query will
1423
+ * be interpreted as "How did Alphabet do in 2023?".
1239
1424
  *
1240
1425
  * Example #2 (coordination between /search API calls and /answer API calls):
1241
- * 1. Call /search API with the auto-session mode (see below).
1242
- * 2. Call /answer API with the session ID generated in the first call.
1243
- * Here, the answer generation happens in the context of the search
1244
- * results from the first search call.
1245
- *
1246
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
1247
- * gets automatically created. Otherwise, users can use the create-session API
1248
- * to create a session manually.
1426
+ * Call /answer API with the session ID generated in the first call.
1427
+ * Here, the answer generation happens in the context of the search
1428
+ * results from the first search call.
1249
1429
  *
1250
1430
  * Multi-turn Search feature is currently at private GA stage. Please use
1251
1431
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -1477,8 +1657,14 @@ class SearchServiceClient {
1477
1657
  * The ranking expression controls the customized ranking on retrieval
1478
1658
  * documents. This overrides
1479
1659
  * {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
1480
- * The ranking expression is a single function or multiple functions that are
1481
- * joined by "+".
1660
+ * The syntax and supported features depend on the
1661
+ * `ranking_expression_backend` value. If `ranking_expression_backend` is not
1662
+ * provided, it defaults to `RANK_BY_EMBEDDING`.
1663
+ *
1664
+ * If
1665
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1666
+ * is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
1667
+ * function or multiple functions that are joined by "+".
1482
1668
  *
1483
1669
  * * ranking_expression = function, { " + ", function };
1484
1670
  *
@@ -1493,13 +1679,73 @@ class SearchServiceClient {
1493
1679
  * between query and document.
1494
1680
  * * `embedding_field_path`: the document embedding field
1495
1681
  * used with query embedding vector.
1496
- * * `dotProduct`: embedding function between embedding_field_path and query
1497
- * embedding vector.
1682
+ * * `dotProduct`: embedding function between `embedding_field_path` and
1683
+ * query embedding vector.
1498
1684
  *
1499
1685
  * Example ranking expression:
1500
1686
  *
1501
1687
  * If document has an embedding field doc_embedding, the ranking expression
1502
1688
  * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
1689
+ *
1690
+ * If
1691
+ * {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend|ranking_expression_backend}
1692
+ * is set to `RANK_BY_FORMULA`, the following expression types (and
1693
+ * combinations of those chained using + or
1694
+ * * operators) are supported:
1695
+ *
1696
+ * * `double`
1697
+ * * `signal`
1698
+ * * `log(signal)`
1699
+ * * `exp(signal)`
1700
+ * * `rr(signal, double > 0)` -- reciprocal rank transformation with second
1701
+ * argument being a denominator constant.
1702
+ * * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
1703
+ * * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns
1704
+ * signal2 | double, else returns signal1.
1705
+ *
1706
+ * Here are a few examples of ranking formulas that use the supported
1707
+ * ranking expression types:
1708
+ *
1709
+ * - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)`
1710
+ * -- mostly rank by the logarithm of `keyword_similarity_score` with slight
1711
+ * `semantic_smilarity_score` adjustment.
1712
+ * - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
1713
+ * is_nan(keyword_similarity_score)` -- rank by the exponent of
1714
+ * `semantic_similarity_score` filling the value with 0 if it's NaN, also
1715
+ * add constant 0.3 adjustment to the final score if
1716
+ * `semantic_similarity_score` is NaN.
1717
+ * - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
1718
+ * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank
1719
+ * of `keyword_similarity_score` with slight adjustment of reciprocal rank
1720
+ * of `semantic_smilarity_score`.
1721
+ *
1722
+ * The following signals are supported:
1723
+ *
1724
+ * * `semantic_similarity_score`: semantic similarity adjustment that is
1725
+ * calculated using the embeddings generated by a proprietary Google model.
1726
+ * This score determines how semantically similar a search query is to a
1727
+ * document.
1728
+ * * `keyword_similarity_score`: keyword match adjustment uses the Best
1729
+ * Match 25 (BM25) ranking function. This score is calculated using a
1730
+ * probabilistic model to estimate the probability that a document is
1731
+ * relevant to a given query.
1732
+ * * `relevance_score`: semantic relevance adjustment that uses a
1733
+ * proprietary Google model to determine the meaning and intent behind a
1734
+ * user's query in context with the content in the documents.
1735
+ * * `pctr_rank`: predicted conversion rate adjustment as a rank use
1736
+ * predicted Click-through rate (pCTR) to gauge the relevance and
1737
+ * attractiveness of a search result from a user's perspective. A higher
1738
+ * pCTR suggests that the result is more likely to satisfy the user's query
1739
+ * and intent, making it a valuable signal for ranking.
1740
+ * * `freshness_rank`: freshness adjustment as a rank
1741
+ * * `document_age`: The time in hours elapsed since the document was last
1742
+ * updated, a floating-point number (e.g., 0.25 means 15 minutes).
1743
+ * * `topicality_rank`: topicality adjustment as a rank. Uses proprietary
1744
+ * Google model to determine the keyword-based overlap between the query and
1745
+ * the document.
1746
+ * * `base_rank`: the default rank of the result
1747
+ * @param {google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend} [request.rankingExpressionBackend]
1748
+ * The backend to use for the ranking expression evaluation.
1503
1749
  * @param {boolean} request.safeSearch
1504
1750
  * Whether to turn on safe search. This is only supported for
1505
1751
  * website search.
@@ -1535,22 +1781,16 @@ class SearchServiceClient {
1535
1781
  * between /search API calls and /answer API calls.
1536
1782
  *
1537
1783
  * Example #1 (multi-turn /search API calls):
1538
- * 1. Call /search API with the auto-session mode (see below).
1539
- * 2. Call /search API with the session ID generated in the first call.
1540
- * Here, the previous search query gets considered in query
1541
- * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1542
- * and the current query is "How about 2023?", the current query will
1543
- * be interpreted as "How did Alphabet do in 2023?".
1784
+ * Call /search API with the session ID generated in the first call.
1785
+ * Here, the previous search query gets considered in query
1786
+ * standing. I.e., if the first query is "How did Alphabet do in 2022?"
1787
+ * and the current query is "How about 2023?", the current query will
1788
+ * be interpreted as "How did Alphabet do in 2023?".
1544
1789
  *
1545
1790
  * Example #2 (coordination between /search API calls and /answer API calls):
1546
- * 1. Call /search API with the auto-session mode (see below).
1547
- * 2. Call /answer API with the session ID generated in the first call.
1548
- * Here, the answer generation happens in the context of the search
1549
- * results from the first search call.
1550
- *
1551
- * Auto-session mode: when `projects/.../sessions/-` is used, a new session
1552
- * gets automatically created. Otherwise, users can use the create-session API
1553
- * to create a session manually.
1791
+ * Call /answer API with the session ID generated in the first call.
1792
+ * Here, the answer generation happens in the context of the search
1793
+ * results from the first search call.
1554
1794
  *
1555
1795
  * Multi-turn Search feature is currently at private GA stage. Please use
1556
1796
  * v1alpha or v1beta version instead before we launch this feature to public
@@ -2531,154 +2771,154 @@ class SearchServiceClient {
2531
2771
  return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
2532
2772
  }
2533
2773
  /**
2534
- * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
2774
+ * Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
2535
2775
  *
2536
2776
  * @param {string} project
2537
2777
  * @param {string} location
2538
2778
  * @param {string} collection
2539
2779
  * @param {string} data_store
2540
2780
  * @param {string} session
2781
+ * @param {string} answer
2541
2782
  * @returns {string} Resource name string.
2542
2783
  */
2543
- projectLocationCollectionDataStoreSessionPath(project, location, collection, dataStore, session) {
2544
- return this.pathTemplates.projectLocationCollectionDataStoreSessionPathTemplate.render({
2784
+ projectLocationCollectionDataStoreSessionAnswerPath(project, location, collection, dataStore, session, answer) {
2785
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.render({
2545
2786
  project: project,
2546
2787
  location: location,
2547
2788
  collection: collection,
2548
2789
  data_store: dataStore,
2549
2790
  session: session,
2791
+ answer: answer,
2550
2792
  });
2551
2793
  }
2552
2794
  /**
2553
- * Parse the project from ProjectLocationCollectionDataStoreSession resource.
2795
+ * Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.
2554
2796
  *
2555
- * @param {string} projectLocationCollectionDataStoreSessionName
2556
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2797
+ * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2798
+ * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2557
2799
  * @returns {string} A string representing the project.
2558
2800
  */
2559
- matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName) {
2560
- return this.pathTemplates.projectLocationCollectionDataStoreSessionPathTemplate.match(projectLocationCollectionDataStoreSessionName).project;
2801
+ matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2802
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).project;
2561
2803
  }
2562
2804
  /**
2563
- * Parse the location from ProjectLocationCollectionDataStoreSession resource.
2805
+ * Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.
2564
2806
  *
2565
- * @param {string} projectLocationCollectionDataStoreSessionName
2566
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2807
+ * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2808
+ * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2567
2809
  * @returns {string} A string representing the location.
2568
2810
  */
2569
- matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName) {
2570
- return this.pathTemplates.projectLocationCollectionDataStoreSessionPathTemplate.match(projectLocationCollectionDataStoreSessionName).location;
2811
+ matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2812
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).location;
2571
2813
  }
2572
2814
  /**
2573
- * Parse the collection from ProjectLocationCollectionDataStoreSession resource.
2815
+ * Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.
2574
2816
  *
2575
- * @param {string} projectLocationCollectionDataStoreSessionName
2576
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2817
+ * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2818
+ * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2577
2819
  * @returns {string} A string representing the collection.
2578
2820
  */
2579
- matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName) {
2580
- return this.pathTemplates.projectLocationCollectionDataStoreSessionPathTemplate.match(projectLocationCollectionDataStoreSessionName).collection;
2821
+ matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2822
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).collection;
2581
2823
  }
2582
2824
  /**
2583
- * Parse the data_store from ProjectLocationCollectionDataStoreSession resource.
2825
+ * Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.
2584
2826
  *
2585
- * @param {string} projectLocationCollectionDataStoreSessionName
2586
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2827
+ * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2828
+ * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2587
2829
  * @returns {string} A string representing the data_store.
2588
2830
  */
2589
- matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName) {
2590
- return this.pathTemplates.projectLocationCollectionDataStoreSessionPathTemplate.match(projectLocationCollectionDataStoreSessionName).data_store;
2831
+ matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2832
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).data_store;
2591
2833
  }
2592
2834
  /**
2593
- * Parse the session from ProjectLocationCollectionDataStoreSession resource.
2835
+ * Parse the session from ProjectLocationCollectionDataStoreSessionAnswer resource.
2594
2836
  *
2595
- * @param {string} projectLocationCollectionDataStoreSessionName
2596
- * A fully-qualified path representing project_location_collection_data_store_session resource.
2837
+ * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2838
+ * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2597
2839
  * @returns {string} A string representing the session.
2598
2840
  */
2599
- matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName) {
2600
- return this.pathTemplates.projectLocationCollectionDataStoreSessionPathTemplate.match(projectLocationCollectionDataStoreSessionName).session;
2841
+ matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2842
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).session;
2601
2843
  }
2602
2844
  /**
2603
- * Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
2845
+ * Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.
2846
+ *
2847
+ * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2848
+ * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2849
+ * @returns {string} A string representing the answer.
2850
+ */
2851
+ matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2852
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).answer;
2853
+ }
2854
+ /**
2855
+ * Return a fully-qualified projectLocationCollectionDataStoreSessions resource name string.
2604
2856
  *
2605
2857
  * @param {string} project
2606
2858
  * @param {string} location
2607
2859
  * @param {string} collection
2608
2860
  * @param {string} data_store
2609
2861
  * @param {string} session
2610
- * @param {string} answer
2611
2862
  * @returns {string} Resource name string.
2612
2863
  */
2613
- projectLocationCollectionDataStoreSessionAnswerPath(project, location, collection, dataStore, session, answer) {
2614
- return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.render({
2864
+ projectLocationCollectionDataStoreSessionsPath(project, location, collection, dataStore, session) {
2865
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.render({
2615
2866
  project: project,
2616
2867
  location: location,
2617
2868
  collection: collection,
2618
2869
  data_store: dataStore,
2619
2870
  session: session,
2620
- answer: answer,
2621
2871
  });
2622
2872
  }
2623
2873
  /**
2624
- * Parse the project from ProjectLocationCollectionDataStoreSessionAnswer resource.
2874
+ * Parse the project from ProjectLocationCollectionDataStoreSessions resource.
2625
2875
  *
2626
- * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2627
- * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2876
+ * @param {string} projectLocationCollectionDataStoreSessionsName
2877
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
2628
2878
  * @returns {string} A string representing the project.
2629
2879
  */
2630
- matchProjectFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2631
- return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).project;
2880
+ matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
2881
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).project;
2632
2882
  }
2633
2883
  /**
2634
- * Parse the location from ProjectLocationCollectionDataStoreSessionAnswer resource.
2884
+ * Parse the location from ProjectLocationCollectionDataStoreSessions resource.
2635
2885
  *
2636
- * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2637
- * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2886
+ * @param {string} projectLocationCollectionDataStoreSessionsName
2887
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
2638
2888
  * @returns {string} A string representing the location.
2639
2889
  */
2640
- matchLocationFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2641
- return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).location;
2890
+ matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
2891
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).location;
2642
2892
  }
2643
2893
  /**
2644
- * Parse the collection from ProjectLocationCollectionDataStoreSessionAnswer resource.
2894
+ * Parse the collection from ProjectLocationCollectionDataStoreSessions resource.
2645
2895
  *
2646
- * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2647
- * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2896
+ * @param {string} projectLocationCollectionDataStoreSessionsName
2897
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
2648
2898
  * @returns {string} A string representing the collection.
2649
2899
  */
2650
- matchCollectionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2651
- return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).collection;
2900
+ matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
2901
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).collection;
2652
2902
  }
2653
2903
  /**
2654
- * Parse the data_store from ProjectLocationCollectionDataStoreSessionAnswer resource.
2904
+ * Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.
2655
2905
  *
2656
- * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2657
- * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2906
+ * @param {string} projectLocationCollectionDataStoreSessionsName
2907
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
2658
2908
  * @returns {string} A string representing the data_store.
2659
2909
  */
2660
- matchDataStoreFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2661
- return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).data_store;
2910
+ matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
2911
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).data_store;
2662
2912
  }
2663
2913
  /**
2664
- * Parse the session from ProjectLocationCollectionDataStoreSessionAnswer resource.
2914
+ * Parse the session from ProjectLocationCollectionDataStoreSessions resource.
2665
2915
  *
2666
- * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2667
- * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2916
+ * @param {string} projectLocationCollectionDataStoreSessionsName
2917
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
2668
2918
  * @returns {string} A string representing the session.
2669
2919
  */
2670
- matchSessionFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2671
- return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).session;
2672
- }
2673
- /**
2674
- * Parse the answer from ProjectLocationCollectionDataStoreSessionAnswer resource.
2675
- *
2676
- * @param {string} projectLocationCollectionDataStoreSessionAnswerName
2677
- * A fully-qualified path representing project_location_collection_data_store_session_answer resource.
2678
- * @returns {string} A string representing the answer.
2679
- */
2680
- matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName) {
2681
- return this.pathTemplates.projectLocationCollectionDataStoreSessionAnswerPathTemplate.match(projectLocationCollectionDataStoreSessionAnswerName).answer;
2920
+ matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName) {
2921
+ return this.pathTemplates.projectLocationCollectionDataStoreSessionsPathTemplate.match(projectLocationCollectionDataStoreSessionsName).session;
2682
2922
  }
2683
2923
  /**
2684
2924
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
@@ -3083,154 +3323,154 @@ class SearchServiceClient {
3083
3323
  return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
3084
3324
  }
3085
3325
  /**
3086
- * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
3326
+ * Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
3087
3327
  *
3088
3328
  * @param {string} project
3089
3329
  * @param {string} location
3090
3330
  * @param {string} collection
3091
3331
  * @param {string} engine
3092
3332
  * @param {string} session
3333
+ * @param {string} answer
3093
3334
  * @returns {string} Resource name string.
3094
3335
  */
3095
- projectLocationCollectionEngineSessionPath(project, location, collection, engine, session) {
3096
- return this.pathTemplates.projectLocationCollectionEngineSessionPathTemplate.render({
3336
+ projectLocationCollectionEngineSessionAnswerPath(project, location, collection, engine, session, answer) {
3337
+ return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.render({
3097
3338
  project: project,
3098
3339
  location: location,
3099
3340
  collection: collection,
3100
3341
  engine: engine,
3101
3342
  session: session,
3343
+ answer: answer,
3102
3344
  });
3103
3345
  }
3104
3346
  /**
3105
- * Parse the project from ProjectLocationCollectionEngineSession resource.
3347
+ * Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.
3106
3348
  *
3107
- * @param {string} projectLocationCollectionEngineSessionName
3108
- * A fully-qualified path representing project_location_collection_engine_session resource.
3349
+ * @param {string} projectLocationCollectionEngineSessionAnswerName
3350
+ * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3109
3351
  * @returns {string} A string representing the project.
3110
3352
  */
3111
- matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName) {
3112
- return this.pathTemplates.projectLocationCollectionEngineSessionPathTemplate.match(projectLocationCollectionEngineSessionName).project;
3353
+ matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3354
+ return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).project;
3113
3355
  }
3114
3356
  /**
3115
- * Parse the location from ProjectLocationCollectionEngineSession resource.
3357
+ * Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.
3116
3358
  *
3117
- * @param {string} projectLocationCollectionEngineSessionName
3118
- * A fully-qualified path representing project_location_collection_engine_session resource.
3359
+ * @param {string} projectLocationCollectionEngineSessionAnswerName
3360
+ * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3119
3361
  * @returns {string} A string representing the location.
3120
3362
  */
3121
- matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName) {
3122
- return this.pathTemplates.projectLocationCollectionEngineSessionPathTemplate.match(projectLocationCollectionEngineSessionName).location;
3363
+ matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3364
+ return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).location;
3123
3365
  }
3124
3366
  /**
3125
- * Parse the collection from ProjectLocationCollectionEngineSession resource.
3367
+ * Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.
3126
3368
  *
3127
- * @param {string} projectLocationCollectionEngineSessionName
3128
- * A fully-qualified path representing project_location_collection_engine_session resource.
3369
+ * @param {string} projectLocationCollectionEngineSessionAnswerName
3370
+ * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3129
3371
  * @returns {string} A string representing the collection.
3130
3372
  */
3131
- matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName) {
3132
- return this.pathTemplates.projectLocationCollectionEngineSessionPathTemplate.match(projectLocationCollectionEngineSessionName).collection;
3373
+ matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3374
+ return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).collection;
3133
3375
  }
3134
3376
  /**
3135
- * Parse the engine from ProjectLocationCollectionEngineSession resource.
3377
+ * Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.
3136
3378
  *
3137
- * @param {string} projectLocationCollectionEngineSessionName
3138
- * A fully-qualified path representing project_location_collection_engine_session resource.
3379
+ * @param {string} projectLocationCollectionEngineSessionAnswerName
3380
+ * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3139
3381
  * @returns {string} A string representing the engine.
3140
3382
  */
3141
- matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName) {
3142
- return this.pathTemplates.projectLocationCollectionEngineSessionPathTemplate.match(projectLocationCollectionEngineSessionName).engine;
3383
+ matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3384
+ return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).engine;
3143
3385
  }
3144
3386
  /**
3145
- * Parse the session from ProjectLocationCollectionEngineSession resource.
3387
+ * Parse the session from ProjectLocationCollectionEngineSessionAnswer resource.
3146
3388
  *
3147
- * @param {string} projectLocationCollectionEngineSessionName
3148
- * A fully-qualified path representing project_location_collection_engine_session resource.
3389
+ * @param {string} projectLocationCollectionEngineSessionAnswerName
3390
+ * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3149
3391
  * @returns {string} A string representing the session.
3150
3392
  */
3151
- matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName) {
3152
- return this.pathTemplates.projectLocationCollectionEngineSessionPathTemplate.match(projectLocationCollectionEngineSessionName).session;
3393
+ matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3394
+ return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).session;
3153
3395
  }
3154
3396
  /**
3155
- * Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
3397
+ * Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.
3398
+ *
3399
+ * @param {string} projectLocationCollectionEngineSessionAnswerName
3400
+ * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3401
+ * @returns {string} A string representing the answer.
3402
+ */
3403
+ matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3404
+ return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).answer;
3405
+ }
3406
+ /**
3407
+ * Return a fully-qualified projectLocationCollectionEngineSessions resource name string.
3156
3408
  *
3157
3409
  * @param {string} project
3158
3410
  * @param {string} location
3159
3411
  * @param {string} collection
3160
3412
  * @param {string} engine
3161
3413
  * @param {string} session
3162
- * @param {string} answer
3163
3414
  * @returns {string} Resource name string.
3164
3415
  */
3165
- projectLocationCollectionEngineSessionAnswerPath(project, location, collection, engine, session, answer) {
3166
- return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.render({
3416
+ projectLocationCollectionEngineSessionsPath(project, location, collection, engine, session) {
3417
+ return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.render({
3167
3418
  project: project,
3168
3419
  location: location,
3169
3420
  collection: collection,
3170
3421
  engine: engine,
3171
3422
  session: session,
3172
- answer: answer,
3173
3423
  });
3174
3424
  }
3175
3425
  /**
3176
- * Parse the project from ProjectLocationCollectionEngineSessionAnswer resource.
3426
+ * Parse the project from ProjectLocationCollectionEngineSessions resource.
3177
3427
  *
3178
- * @param {string} projectLocationCollectionEngineSessionAnswerName
3179
- * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3428
+ * @param {string} projectLocationCollectionEngineSessionsName
3429
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3180
3430
  * @returns {string} A string representing the project.
3181
3431
  */
3182
- matchProjectFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3183
- return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).project;
3432
+ matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
3433
+ return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).project;
3184
3434
  }
3185
3435
  /**
3186
- * Parse the location from ProjectLocationCollectionEngineSessionAnswer resource.
3436
+ * Parse the location from ProjectLocationCollectionEngineSessions resource.
3187
3437
  *
3188
- * @param {string} projectLocationCollectionEngineSessionAnswerName
3189
- * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3438
+ * @param {string} projectLocationCollectionEngineSessionsName
3439
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3190
3440
  * @returns {string} A string representing the location.
3191
3441
  */
3192
- matchLocationFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3193
- return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).location;
3442
+ matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
3443
+ return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).location;
3194
3444
  }
3195
3445
  /**
3196
- * Parse the collection from ProjectLocationCollectionEngineSessionAnswer resource.
3446
+ * Parse the collection from ProjectLocationCollectionEngineSessions resource.
3197
3447
  *
3198
- * @param {string} projectLocationCollectionEngineSessionAnswerName
3199
- * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3448
+ * @param {string} projectLocationCollectionEngineSessionsName
3449
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3200
3450
  * @returns {string} A string representing the collection.
3201
3451
  */
3202
- matchCollectionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3203
- return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).collection;
3452
+ matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
3453
+ return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).collection;
3204
3454
  }
3205
3455
  /**
3206
- * Parse the engine from ProjectLocationCollectionEngineSessionAnswer resource.
3456
+ * Parse the engine from ProjectLocationCollectionEngineSessions resource.
3207
3457
  *
3208
- * @param {string} projectLocationCollectionEngineSessionAnswerName
3209
- * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3458
+ * @param {string} projectLocationCollectionEngineSessionsName
3459
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3210
3460
  * @returns {string} A string representing the engine.
3211
3461
  */
3212
- matchEngineFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3213
- return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).engine;
3462
+ matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
3463
+ return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).engine;
3214
3464
  }
3215
3465
  /**
3216
- * Parse the session from ProjectLocationCollectionEngineSessionAnswer resource.
3466
+ * Parse the session from ProjectLocationCollectionEngineSessions resource.
3217
3467
  *
3218
- * @param {string} projectLocationCollectionEngineSessionAnswerName
3219
- * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3468
+ * @param {string} projectLocationCollectionEngineSessionsName
3469
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
3220
3470
  * @returns {string} A string representing the session.
3221
3471
  */
3222
- matchSessionFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3223
- return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).session;
3224
- }
3225
- /**
3226
- * Parse the answer from ProjectLocationCollectionEngineSessionAnswer resource.
3227
- *
3228
- * @param {string} projectLocationCollectionEngineSessionAnswerName
3229
- * A fully-qualified path representing project_location_collection_engine_session_answer resource.
3230
- * @returns {string} A string representing the answer.
3231
- */
3232
- matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName) {
3233
- return this.pathTemplates.projectLocationCollectionEngineSessionAnswerPathTemplate.match(projectLocationCollectionEngineSessionAnswerName).answer;
3472
+ matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName) {
3473
+ return this.pathTemplates.projectLocationCollectionEngineSessionsPathTemplate.match(projectLocationCollectionEngineSessionsName).session;
3234
3474
  }
3235
3475
  /**
3236
3476
  * Return a fully-qualified projectLocationDataStore resource name string.
@@ -3814,63 +4054,6 @@ class SearchServiceClient {
3814
4054
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
3815
4055
  return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
3816
4056
  }
3817
- /**
3818
- * Return a fully-qualified projectLocationDataStoreSession resource name string.
3819
- *
3820
- * @param {string} project
3821
- * @param {string} location
3822
- * @param {string} data_store
3823
- * @param {string} session
3824
- * @returns {string} Resource name string.
3825
- */
3826
- projectLocationDataStoreSessionPath(project, location, dataStore, session) {
3827
- return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.render({
3828
- project: project,
3829
- location: location,
3830
- data_store: dataStore,
3831
- session: session,
3832
- });
3833
- }
3834
- /**
3835
- * Parse the project from ProjectLocationDataStoreSession resource.
3836
- *
3837
- * @param {string} projectLocationDataStoreSessionName
3838
- * A fully-qualified path representing project_location_data_store_session resource.
3839
- * @returns {string} A string representing the project.
3840
- */
3841
- matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
3842
- return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).project;
3843
- }
3844
- /**
3845
- * Parse the location from ProjectLocationDataStoreSession resource.
3846
- *
3847
- * @param {string} projectLocationDataStoreSessionName
3848
- * A fully-qualified path representing project_location_data_store_session resource.
3849
- * @returns {string} A string representing the location.
3850
- */
3851
- matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
3852
- return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).location;
3853
- }
3854
- /**
3855
- * Parse the data_store from ProjectLocationDataStoreSession resource.
3856
- *
3857
- * @param {string} projectLocationDataStoreSessionName
3858
- * A fully-qualified path representing project_location_data_store_session resource.
3859
- * @returns {string} A string representing the data_store.
3860
- */
3861
- matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
3862
- return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).data_store;
3863
- }
3864
- /**
3865
- * Parse the session from ProjectLocationDataStoreSession resource.
3866
- *
3867
- * @param {string} projectLocationDataStoreSessionName
3868
- * A fully-qualified path representing project_location_data_store_session resource.
3869
- * @returns {string} A string representing the session.
3870
- */
3871
- matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName) {
3872
- return this.pathTemplates.projectLocationDataStoreSessionPathTemplate.match(projectLocationDataStoreSessionName).session;
3873
- }
3874
4057
  /**
3875
4058
  * Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.
3876
4059
  *
@@ -3940,6 +4123,63 @@ class SearchServiceClient {
3940
4123
  matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName) {
3941
4124
  return this.pathTemplates.projectLocationDataStoreSessionAnswerPathTemplate.match(projectLocationDataStoreSessionAnswerName).answer;
3942
4125
  }
4126
+ /**
4127
+ * Return a fully-qualified projectLocationDataStoreSessions resource name string.
4128
+ *
4129
+ * @param {string} project
4130
+ * @param {string} location
4131
+ * @param {string} data_store
4132
+ * @param {string} session
4133
+ * @returns {string} Resource name string.
4134
+ */
4135
+ projectLocationDataStoreSessionsPath(project, location, dataStore, session) {
4136
+ return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.render({
4137
+ project: project,
4138
+ location: location,
4139
+ data_store: dataStore,
4140
+ session: session,
4141
+ });
4142
+ }
4143
+ /**
4144
+ * Parse the project from ProjectLocationDataStoreSessions resource.
4145
+ *
4146
+ * @param {string} projectLocationDataStoreSessionsName
4147
+ * A fully-qualified path representing project_location_data_store_sessions resource.
4148
+ * @returns {string} A string representing the project.
4149
+ */
4150
+ matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
4151
+ return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).project;
4152
+ }
4153
+ /**
4154
+ * Parse the location from ProjectLocationDataStoreSessions resource.
4155
+ *
4156
+ * @param {string} projectLocationDataStoreSessionsName
4157
+ * A fully-qualified path representing project_location_data_store_sessions resource.
4158
+ * @returns {string} A string representing the location.
4159
+ */
4160
+ matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
4161
+ return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).location;
4162
+ }
4163
+ /**
4164
+ * Parse the data_store from ProjectLocationDataStoreSessions resource.
4165
+ *
4166
+ * @param {string} projectLocationDataStoreSessionsName
4167
+ * A fully-qualified path representing project_location_data_store_sessions resource.
4168
+ * @returns {string} A string representing the data_store.
4169
+ */
4170
+ matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
4171
+ return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).data_store;
4172
+ }
4173
+ /**
4174
+ * Parse the session from ProjectLocationDataStoreSessions resource.
4175
+ *
4176
+ * @param {string} projectLocationDataStoreSessionsName
4177
+ * A fully-qualified path representing project_location_data_store_sessions resource.
4178
+ * @returns {string} A string representing the session.
4179
+ */
4180
+ matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName) {
4181
+ return this.pathTemplates.projectLocationDataStoreSessionsPathTemplate.match(projectLocationDataStoreSessionsName).session;
4182
+ }
3943
4183
  /**
3944
4184
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
3945
4185
  *