@google-cloud/discoveryengine 2.2.0 → 2.4.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 (249) hide show
  1. package/README.md +30 -0
  2. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +17 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/assist_answer.proto +251 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/assistant.proto +44 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/assistant_service.proto +217 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +52 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto +300 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/common.proto +67 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/control.proto +1 -3
  10. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +18 -3
  11. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +54 -2
  12. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +14 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/document.proto +95 -4
  14. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +28 -1
  15. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +131 -6
  16. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +8 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +9 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto +84 -0
  19. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto +375 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +14 -14
  21. package/build/protos/google/cloud/discoveryengine/v1/session.proto +21 -8
  22. package/build/protos/google/cloud/discoveryengine/v1/session_service.proto +128 -0
  23. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +6 -0
  24. package/build/protos/google/cloud/discoveryengine/v1/user_license.proto +98 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto +191 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +15 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +30 -9
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +8 -14
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +238 -8
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/session_service.proto +201 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +26 -5
  32. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +8 -14
  33. package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +40 -8
  34. package/build/protos/google/cloud/discoveryengine/v1beta/session_service.proto +128 -0
  35. package/build/protos/protos.d.ts +21218 -11675
  36. package/build/protos/protos.js +92642 -66407
  37. package/build/protos/protos.json +5854 -2801
  38. package/build/src/index.d.ts +16 -1
  39. package/build/src/index.js +12 -2
  40. package/build/src/v1/assistant_service_client.d.ts +2058 -0
  41. package/build/src/v1/assistant_service_client.js +2957 -0
  42. package/build/src/v1/assistant_service_client_config.json +43 -0
  43. package/build/src/v1/assistant_service_proto_list.json +48 -0
  44. package/build/src/v1/cmek_config_service_client.d.ts +2398 -0
  45. package/build/src/v1/cmek_config_service_client.js +3426 -0
  46. package/build/src/v1/cmek_config_service_client_config.json +42 -0
  47. package/build/src/v1/cmek_config_service_proto_list.json +48 -0
  48. package/build/src/v1/completion_service_client.d.ts +345 -144
  49. package/build/src/v1/completion_service_client.js +482 -198
  50. package/build/src/v1/completion_service_proto_list.json +10 -1
  51. package/build/src/v1/control_service_client.d.ts +345 -144
  52. package/build/src/v1/control_service_client.js +498 -196
  53. package/build/src/v1/control_service_proto_list.json +10 -1
  54. package/build/src/v1/conversational_search_service_client.d.ts +392 -155
  55. package/build/src/v1/conversational_search_service_client.js +572 -204
  56. package/build/src/v1/conversational_search_service_proto_list.json +10 -1
  57. package/build/src/v1/data_store_service_client.d.ts +351 -144
  58. package/build/src/v1/data_store_service_client.js +488 -198
  59. package/build/src/v1/data_store_service_proto_list.json +10 -1
  60. package/build/src/v1/document_service_client.d.ts +345 -144
  61. package/build/src/v1/document_service_client.js +506 -198
  62. package/build/src/v1/document_service_proto_list.json +10 -1
  63. package/build/src/v1/engine_service_client.d.ts +345 -144
  64. package/build/src/v1/engine_service_client.js +488 -198
  65. package/build/src/v1/engine_service_proto_list.json +10 -1
  66. package/build/src/v1/gapic_metadata.json +270 -0
  67. package/build/src/v1/grounded_generation_service_client.d.ts +345 -144
  68. package/build/src/v1/grounded_generation_service_client.js +486 -196
  69. package/build/src/v1/grounded_generation_service_proto_list.json +10 -1
  70. package/build/src/v1/identity_mapping_store_service_client.d.ts +2581 -0
  71. package/build/src/v1/identity_mapping_store_service_client.js +3601 -0
  72. package/build/src/v1/identity_mapping_store_service_client_config.json +54 -0
  73. package/build/src/v1/identity_mapping_store_service_proto_list.json +48 -0
  74. package/build/src/v1/index.d.ts +5 -0
  75. package/build/src/v1/index.js +11 -1
  76. package/build/src/v1/project_service_client.d.ts +345 -144
  77. package/build/src/v1/project_service_client.js +476 -198
  78. package/build/src/v1/project_service_proto_list.json +10 -1
  79. package/build/src/v1/rank_service_client.d.ts +345 -144
  80. package/build/src/v1/rank_service_client.js +480 -196
  81. package/build/src/v1/rank_service_proto_list.json +10 -1
  82. package/build/src/v1/recommendation_service_client.d.ts +345 -144
  83. package/build/src/v1/recommendation_service_client.js +480 -196
  84. package/build/src/v1/recommendation_service_proto_list.json +10 -1
  85. package/build/src/v1/schema_service_client.d.ts +345 -144
  86. package/build/src/v1/schema_service_client.js +482 -198
  87. package/build/src/v1/schema_service_proto_list.json +10 -1
  88. package/build/src/v1/search_service_client.d.ts +393 -228
  89. package/build/src/v1/search_service_client.js +506 -252
  90. package/build/src/v1/search_service_proto_list.json +10 -1
  91. package/build/src/v1/search_tuning_service_client.d.ts +345 -144
  92. package/build/src/v1/search_tuning_service_client.js +482 -198
  93. package/build/src/v1/search_tuning_service_proto_list.json +10 -1
  94. package/build/src/v1/serving_config_service_client.d.ts +345 -144
  95. package/build/src/v1/serving_config_service_client.js +480 -196
  96. package/build/src/v1/serving_config_service_proto_list.json +10 -1
  97. package/build/src/v1/session_service_client.d.ts +2326 -0
  98. package/build/src/v1/session_service_client.js +3218 -0
  99. package/build/src/v1/session_service_client_config.json +63 -0
  100. package/build/src/v1/session_service_proto_list.json +48 -0
  101. package/build/src/v1/site_search_engine_service_client.d.ts +345 -144
  102. package/build/src/v1/site_search_engine_service_client.js +494 -198
  103. package/build/src/v1/site_search_engine_service_proto_list.json +10 -1
  104. package/build/src/v1/user_event_service_client.d.ts +345 -144
  105. package/build/src/v1/user_event_service_client.js +488 -198
  106. package/build/src/v1/user_event_service_proto_list.json +10 -1
  107. package/build/src/v1/user_license_service_client.d.ts +2367 -0
  108. package/build/src/v1/user_license_service_client.js +3346 -0
  109. package/build/src/v1/user_license_service_client_config.json +34 -0
  110. package/build/src/v1/user_license_service_proto_list.json +48 -0
  111. package/build/src/v1alpha/acl_config_service_client.d.ts +144 -144
  112. package/build/src/v1alpha/acl_config_service_client.js +208 -196
  113. package/build/src/v1alpha/acl_config_service_proto_list.json +1 -0
  114. package/build/src/v1alpha/chunk_service_client.d.ts +144 -144
  115. package/build/src/v1alpha/chunk_service_client.js +202 -196
  116. package/build/src/v1alpha/chunk_service_proto_list.json +1 -0
  117. package/build/src/v1alpha/completion_service_client.d.ts +144 -144
  118. package/build/src/v1alpha/completion_service_client.js +203 -197
  119. package/build/src/v1alpha/completion_service_proto_list.json +1 -0
  120. package/build/src/v1alpha/control_service_client.d.ts +144 -144
  121. package/build/src/v1alpha/control_service_client.js +220 -196
  122. package/build/src/v1alpha/control_service_proto_list.json +1 -0
  123. package/build/src/v1alpha/conversational_search_service_client.d.ts +221 -167
  124. package/build/src/v1alpha/conversational_search_service_client.js +310 -210
  125. package/build/src/v1alpha/conversational_search_service_proto_list.json +1 -0
  126. package/build/src/v1alpha/data_store_service_client.d.ts +144 -144
  127. package/build/src/v1alpha/data_store_service_client.js +221 -197
  128. package/build/src/v1alpha/data_store_service_proto_list.json +1 -0
  129. package/build/src/v1alpha/document_service_client.d.ts +144 -144
  130. package/build/src/v1alpha/document_service_client.js +233 -197
  131. package/build/src/v1alpha/document_service_proto_list.json +1 -0
  132. package/build/src/v1alpha/engine_service_client.d.ts +144 -144
  133. package/build/src/v1alpha/engine_service_client.js +221 -197
  134. package/build/src/v1alpha/engine_service_proto_list.json +1 -0
  135. package/build/src/v1alpha/estimate_billing_service_client.d.ts +144 -144
  136. package/build/src/v1alpha/estimate_billing_service_client.js +197 -197
  137. package/build/src/v1alpha/estimate_billing_service_proto_list.json +1 -0
  138. package/build/src/v1alpha/evaluation_service_client.d.ts +144 -144
  139. package/build/src/v1alpha/evaluation_service_client.js +203 -197
  140. package/build/src/v1alpha/evaluation_service_proto_list.json +1 -0
  141. package/build/src/v1alpha/gapic_metadata.json +82 -0
  142. package/build/src/v1alpha/grounded_generation_service_client.d.ts +144 -144
  143. package/build/src/v1alpha/grounded_generation_service_client.js +202 -196
  144. package/build/src/v1alpha/grounded_generation_service_proto_list.json +1 -0
  145. package/build/src/v1alpha/index.d.ts +1 -0
  146. package/build/src/v1alpha/index.js +3 -1
  147. package/build/src/v1alpha/project_service_client.d.ts +144 -144
  148. package/build/src/v1alpha/project_service_client.js +209 -197
  149. package/build/src/v1alpha/project_service_proto_list.json +1 -0
  150. package/build/src/v1alpha/rank_service_client.d.ts +144 -144
  151. package/build/src/v1alpha/rank_service_client.js +202 -196
  152. package/build/src/v1alpha/rank_service_proto_list.json +1 -0
  153. package/build/src/v1alpha/recommendation_service_client.d.ts +144 -144
  154. package/build/src/v1alpha/recommendation_service_client.js +202 -196
  155. package/build/src/v1alpha/recommendation_service_proto_list.json +1 -0
  156. package/build/src/v1alpha/sample_query_service_client.d.ts +144 -144
  157. package/build/src/v1alpha/sample_query_service_client.js +221 -197
  158. package/build/src/v1alpha/sample_query_service_proto_list.json +1 -0
  159. package/build/src/v1alpha/sample_query_set_service_client.d.ts +144 -144
  160. package/build/src/v1alpha/sample_query_set_service_client.js +220 -196
  161. package/build/src/v1alpha/sample_query_set_service_proto_list.json +1 -0
  162. package/build/src/v1alpha/schema_service_client.d.ts +144 -144
  163. package/build/src/v1alpha/schema_service_client.js +203 -197
  164. package/build/src/v1alpha/schema_service_proto_list.json +1 -0
  165. package/build/src/v1alpha/search_service_client.d.ts +168 -186
  166. package/build/src/v1alpha/search_service_client.js +212 -224
  167. package/build/src/v1alpha/search_service_proto_list.json +1 -0
  168. package/build/src/v1alpha/search_tuning_service_client.d.ts +144 -144
  169. package/build/src/v1alpha/search_tuning_service_client.js +203 -197
  170. package/build/src/v1alpha/search_tuning_service_proto_list.json +1 -0
  171. package/build/src/v1alpha/serving_config_service_client.d.ts +144 -144
  172. package/build/src/v1alpha/serving_config_service_client.js +208 -196
  173. package/build/src/v1alpha/serving_config_service_proto_list.json +1 -0
  174. package/build/src/v1alpha/session_service_client.d.ts +2331 -0
  175. package/build/src/v1alpha/session_service_client.js +3161 -0
  176. package/build/src/v1alpha/session_service_client_config.json +68 -0
  177. package/build/src/v1alpha/session_service_proto_list.json +49 -0
  178. package/build/src/v1alpha/site_search_engine_service_client.d.ts +144 -144
  179. package/build/src/v1alpha/site_search_engine_service_client.js +215 -197
  180. package/build/src/v1alpha/site_search_engine_service_proto_list.json +1 -0
  181. package/build/src/v1alpha/user_event_service_client.d.ts +144 -144
  182. package/build/src/v1alpha/user_event_service_client.js +209 -197
  183. package/build/src/v1alpha/user_event_service_proto_list.json +1 -0
  184. package/build/src/v1beta/completion_service_client.d.ts +144 -144
  185. package/build/src/v1beta/completion_service_client.js +209 -197
  186. package/build/src/v1beta/completion_service_proto_list.json +1 -0
  187. package/build/src/v1beta/control_service_client.d.ts +144 -144
  188. package/build/src/v1beta/control_service_client.js +220 -196
  189. package/build/src/v1beta/control_service_proto_list.json +1 -0
  190. package/build/src/v1beta/conversational_search_service_client.d.ts +215 -161
  191. package/build/src/v1beta/conversational_search_service_client.js +308 -208
  192. package/build/src/v1beta/conversational_search_service_proto_list.json +1 -0
  193. package/build/src/v1beta/data_store_service_client.d.ts +144 -144
  194. package/build/src/v1beta/data_store_service_client.js +209 -197
  195. package/build/src/v1beta/data_store_service_proto_list.json +1 -0
  196. package/build/src/v1beta/document_service_client.d.ts +144 -144
  197. package/build/src/v1beta/document_service_client.js +227 -197
  198. package/build/src/v1beta/document_service_proto_list.json +1 -0
  199. package/build/src/v1beta/engine_service_client.d.ts +144 -144
  200. package/build/src/v1beta/engine_service_client.js +221 -197
  201. package/build/src/v1beta/engine_service_proto_list.json +1 -0
  202. package/build/src/v1beta/evaluation_service_client.d.ts +144 -144
  203. package/build/src/v1beta/evaluation_service_client.js +203 -197
  204. package/build/src/v1beta/evaluation_service_proto_list.json +1 -0
  205. package/build/src/v1beta/gapic_metadata.json +68 -0
  206. package/build/src/v1beta/grounded_generation_service_client.d.ts +144 -144
  207. package/build/src/v1beta/grounded_generation_service_client.js +208 -196
  208. package/build/src/v1beta/grounded_generation_service_proto_list.json +1 -0
  209. package/build/src/v1beta/index.d.ts +1 -0
  210. package/build/src/v1beta/index.js +3 -1
  211. package/build/src/v1beta/project_service_client.d.ts +144 -144
  212. package/build/src/v1beta/project_service_client.js +197 -197
  213. package/build/src/v1beta/project_service_proto_list.json +1 -0
  214. package/build/src/v1beta/rank_service_client.d.ts +144 -144
  215. package/build/src/v1beta/rank_service_client.js +202 -196
  216. package/build/src/v1beta/rank_service_proto_list.json +1 -0
  217. package/build/src/v1beta/recommendation_service_client.d.ts +144 -144
  218. package/build/src/v1beta/recommendation_service_client.js +202 -196
  219. package/build/src/v1beta/recommendation_service_proto_list.json +1 -0
  220. package/build/src/v1beta/sample_query_service_client.d.ts +144 -144
  221. package/build/src/v1beta/sample_query_service_client.js +221 -197
  222. package/build/src/v1beta/sample_query_service_proto_list.json +1 -0
  223. package/build/src/v1beta/sample_query_set_service_client.d.ts +144 -144
  224. package/build/src/v1beta/sample_query_set_service_client.js +220 -196
  225. package/build/src/v1beta/sample_query_set_service_proto_list.json +1 -0
  226. package/build/src/v1beta/schema_service_client.d.ts +144 -144
  227. package/build/src/v1beta/schema_service_client.js +203 -197
  228. package/build/src/v1beta/schema_service_proto_list.json +1 -0
  229. package/build/src/v1beta/search_service_client.d.ts +192 -228
  230. package/build/src/v1beta/search_service_client.js +228 -252
  231. package/build/src/v1beta/search_service_proto_list.json +1 -0
  232. package/build/src/v1beta/search_tuning_service_client.d.ts +144 -144
  233. package/build/src/v1beta/search_tuning_service_client.js +203 -197
  234. package/build/src/v1beta/search_tuning_service_proto_list.json +1 -0
  235. package/build/src/v1beta/serving_config_service_client.d.ts +144 -144
  236. package/build/src/v1beta/serving_config_service_client.js +208 -196
  237. package/build/src/v1beta/serving_config_service_proto_list.json +1 -0
  238. package/build/src/v1beta/session_service_client.d.ts +2266 -0
  239. package/build/src/v1beta/session_service_client.js +3136 -0
  240. package/build/src/v1beta/session_service_client_config.json +63 -0
  241. package/build/src/v1beta/session_service_proto_list.json +45 -0
  242. package/build/src/v1beta/site_search_engine_service_client.d.ts +144 -144
  243. package/build/src/v1beta/site_search_engine_service_client.js +215 -197
  244. package/build/src/v1beta/site_search_engine_service_proto_list.json +1 -0
  245. package/build/src/v1beta/user_event_service_client.d.ts +144 -144
  246. package/build/src/v1beta/user_event_service_client.js +209 -197
  247. package/build/src/v1beta/user_event_service_proto_list.json +1 -0
  248. package/package.json +7 -7
  249. package/CHANGELOG.md +0 -274
@@ -41,6 +41,7 @@
41
41
  "../../protos/google/cloud/discoveryengine/v1alpha/serving_config.proto",
42
42
  "../../protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto",
43
43
  "../../protos/google/cloud/discoveryengine/v1alpha/session.proto",
44
+ "../../protos/google/cloud/discoveryengine/v1alpha/session_service.proto",
44
45
  "../../protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto",
45
46
  "../../protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto",
46
47
  "../../protos/google/cloud/discoveryengine/v1alpha/user_event.proto",
@@ -432,7 +432,7 @@ export declare class ConversationalSearchServiceClient {
432
432
  * The request object that will be sent.
433
433
  * @param {string} request.parent
434
434
  * Required. Full resource name of parent data store. Format:
435
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
435
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
436
436
  * @param {google.cloud.discoveryengine.v1alpha.Session} request.session
437
437
  * Required. The session to create.
438
438
  * @param {object} [options]
@@ -461,7 +461,7 @@ export declare class ConversationalSearchServiceClient {
461
461
  * The request object that will be sent.
462
462
  * @param {string} request.name
463
463
  * Required. The resource name of the Session to delete. Format:
464
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
464
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
465
465
  * @param {object} [options]
466
466
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
467
467
  * @returns {Promise} - The promise which resolves to an array.
@@ -520,7 +520,10 @@ export declare class ConversationalSearchServiceClient {
520
520
  * The request object that will be sent.
521
521
  * @param {string} request.name
522
522
  * Required. The resource name of the Session to get. Format:
523
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
523
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
524
+ * @param {boolean} [request.includeAnswerDetails]
525
+ * Optional. If set to true, the full session including all answer details
526
+ * will be returned.
524
527
  * @param {object} [options]
525
528
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
526
529
  * @returns {Promise} - The promise which resolves to an array.
@@ -683,7 +686,7 @@ export declare class ConversationalSearchServiceClient {
683
686
  * The request object that will be sent.
684
687
  * @param {string} request.parent
685
688
  * Required. The data store resource name. Format:
686
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
689
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
687
690
  * @param {number} request.pageSize
688
691
  * Maximum number of results to return. If unspecified, defaults
689
692
  * to 50. Max allowed value is 1000.
@@ -691,22 +694,39 @@ export declare class ConversationalSearchServiceClient {
691
694
  * A page token, received from a previous `ListSessions` call.
692
695
  * Provide this to retrieve the subsequent page.
693
696
  * @param {string} request.filter
694
- * A filter to apply on the list results. The supported features are:
695
- * user_pseudo_id, state.
697
+ * A comma-separated list of fields to filter by, in EBNF grammar.
698
+ * The supported fields are:
699
+ * * `user_pseudo_id`
700
+ * * `state`
701
+ * * `display_name`
702
+ * * `starred`
703
+ * * `is_pinned`
704
+ * * `labels`
705
+ * * `create_time`
706
+ * * `update_time`
696
707
  *
697
- * Example:
708
+ * Examples:
698
709
  * "user_pseudo_id = some_id"
710
+ * "display_name = \"some_name\""
711
+ * "starred = true"
712
+ * "is_pinned=true AND (NOT labels:hidden)"
713
+ * "create_time > \"1970-01-01T12:00:00Z\""
699
714
  * @param {string} request.orderBy
700
715
  * A comma-separated list of fields to order by, sorted in ascending order.
701
716
  * Use "desc" after a field name for descending.
702
717
  * Supported fields:
718
+ *
703
719
  * * `update_time`
704
720
  * * `create_time`
705
721
  * * `session_name`
722
+ * * `is_pinned`
706
723
  *
707
724
  * Example:
708
- * "update_time desc"
709
- * "create_time"
725
+ *
726
+ * * "update_time desc"
727
+ * * "create_time"
728
+ * * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
729
+ * by update_time.
710
730
  * @param {object} [options]
711
731
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
712
732
  * @returns {Promise} - The promise which resolves to an array.
@@ -732,7 +752,7 @@ export declare class ConversationalSearchServiceClient {
732
752
  * The request object that will be sent.
733
753
  * @param {string} request.parent
734
754
  * Required. The data store resource name. Format:
735
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
755
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
736
756
  * @param {number} request.pageSize
737
757
  * Maximum number of results to return. If unspecified, defaults
738
758
  * to 50. Max allowed value is 1000.
@@ -740,22 +760,39 @@ export declare class ConversationalSearchServiceClient {
740
760
  * A page token, received from a previous `ListSessions` call.
741
761
  * Provide this to retrieve the subsequent page.
742
762
  * @param {string} request.filter
743
- * A filter to apply on the list results. The supported features are:
744
- * user_pseudo_id, state.
745
- *
746
- * Example:
763
+ * A comma-separated list of fields to filter by, in EBNF grammar.
764
+ * The supported fields are:
765
+ * * `user_pseudo_id`
766
+ * * `state`
767
+ * * `display_name`
768
+ * * `starred`
769
+ * * `is_pinned`
770
+ * * `labels`
771
+ * * `create_time`
772
+ * * `update_time`
773
+ *
774
+ * Examples:
747
775
  * "user_pseudo_id = some_id"
776
+ * "display_name = \"some_name\""
777
+ * "starred = true"
778
+ * "is_pinned=true AND (NOT labels:hidden)"
779
+ * "create_time > \"1970-01-01T12:00:00Z\""
748
780
  * @param {string} request.orderBy
749
781
  * A comma-separated list of fields to order by, sorted in ascending order.
750
782
  * Use "desc" after a field name for descending.
751
783
  * Supported fields:
784
+ *
752
785
  * * `update_time`
753
786
  * * `create_time`
754
787
  * * `session_name`
788
+ * * `is_pinned`
755
789
  *
756
790
  * Example:
757
- * "update_time desc"
758
- * "create_time"
791
+ *
792
+ * * "update_time desc"
793
+ * * "create_time"
794
+ * * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
795
+ * by update_time.
759
796
  * @param {object} [options]
760
797
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
761
798
  * @returns {Stream}
@@ -776,7 +813,7 @@ export declare class ConversationalSearchServiceClient {
776
813
  * The request object that will be sent.
777
814
  * @param {string} request.parent
778
815
  * Required. The data store resource name. Format:
779
- * `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
816
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
780
817
  * @param {number} request.pageSize
781
818
  * Maximum number of results to return. If unspecified, defaults
782
819
  * to 50. Max allowed value is 1000.
@@ -784,22 +821,39 @@ export declare class ConversationalSearchServiceClient {
784
821
  * A page token, received from a previous `ListSessions` call.
785
822
  * Provide this to retrieve the subsequent page.
786
823
  * @param {string} request.filter
787
- * A filter to apply on the list results. The supported features are:
788
- * user_pseudo_id, state.
789
- *
790
- * Example:
824
+ * A comma-separated list of fields to filter by, in EBNF grammar.
825
+ * The supported fields are:
826
+ * * `user_pseudo_id`
827
+ * * `state`
828
+ * * `display_name`
829
+ * * `starred`
830
+ * * `is_pinned`
831
+ * * `labels`
832
+ * * `create_time`
833
+ * * `update_time`
834
+ *
835
+ * Examples:
791
836
  * "user_pseudo_id = some_id"
837
+ * "display_name = \"some_name\""
838
+ * "starred = true"
839
+ * "is_pinned=true AND (NOT labels:hidden)"
840
+ * "create_time > \"1970-01-01T12:00:00Z\""
792
841
  * @param {string} request.orderBy
793
842
  * A comma-separated list of fields to order by, sorted in ascending order.
794
843
  * Use "desc" after a field name for descending.
795
844
  * Supported fields:
845
+ *
796
846
  * * `update_time`
797
847
  * * `create_time`
798
848
  * * `session_name`
849
+ * * `is_pinned`
799
850
  *
800
851
  * Example:
801
- * "update_time desc"
802
- * "create_time"
852
+ *
853
+ * * "update_time desc"
854
+ * * "create_time"
855
+ * * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
856
+ * by update_time.
803
857
  * @param {object} [options]
804
858
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
805
859
  * @returns {Object}
@@ -1446,57 +1500,6 @@ export declare class ConversationalSearchServiceClient {
1446
1500
  * @returns {string} A string representing the serving_config.
1447
1501
  */
1448
1502
  matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1449
- /**
1450
- * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
1451
- *
1452
- * @param {string} project
1453
- * @param {string} location
1454
- * @param {string} collection
1455
- * @param {string} data_store
1456
- * @param {string} session
1457
- * @returns {string} Resource name string.
1458
- */
1459
- projectLocationCollectionDataStoreSessionPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
1460
- /**
1461
- * Parse the project from ProjectLocationCollectionDataStoreSession resource.
1462
- *
1463
- * @param {string} projectLocationCollectionDataStoreSessionName
1464
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1465
- * @returns {string} A string representing the project.
1466
- */
1467
- matchProjectFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1468
- /**
1469
- * Parse the location from ProjectLocationCollectionDataStoreSession resource.
1470
- *
1471
- * @param {string} projectLocationCollectionDataStoreSessionName
1472
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1473
- * @returns {string} A string representing the location.
1474
- */
1475
- matchLocationFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1476
- /**
1477
- * Parse the collection from ProjectLocationCollectionDataStoreSession resource.
1478
- *
1479
- * @param {string} projectLocationCollectionDataStoreSessionName
1480
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1481
- * @returns {string} A string representing the collection.
1482
- */
1483
- matchCollectionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1484
- /**
1485
- * Parse the data_store from ProjectLocationCollectionDataStoreSession resource.
1486
- *
1487
- * @param {string} projectLocationCollectionDataStoreSessionName
1488
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1489
- * @returns {string} A string representing the data_store.
1490
- */
1491
- matchDataStoreFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1492
- /**
1493
- * Parse the session from ProjectLocationCollectionDataStoreSession resource.
1494
- *
1495
- * @param {string} projectLocationCollectionDataStoreSessionName
1496
- * A fully-qualified path representing project_location_collection_data_store_session resource.
1497
- * @returns {string} A string representing the session.
1498
- */
1499
- matchSessionFromProjectLocationCollectionDataStoreSessionName(projectLocationCollectionDataStoreSessionName: string): string | number;
1500
1503
  /**
1501
1504
  * Return a fully-qualified projectLocationCollectionDataStoreSessionAnswer resource name string.
1502
1505
  *
@@ -1557,6 +1560,57 @@ export declare class ConversationalSearchServiceClient {
1557
1560
  * @returns {string} A string representing the answer.
1558
1561
  */
1559
1562
  matchAnswerFromProjectLocationCollectionDataStoreSessionAnswerName(projectLocationCollectionDataStoreSessionAnswerName: string): string | number;
1563
+ /**
1564
+ * Return a fully-qualified projectLocationCollectionDataStoreSessions resource name string.
1565
+ *
1566
+ * @param {string} project
1567
+ * @param {string} location
1568
+ * @param {string} collection
1569
+ * @param {string} data_store
1570
+ * @param {string} session
1571
+ * @returns {string} Resource name string.
1572
+ */
1573
+ projectLocationCollectionDataStoreSessionsPath(project: string, location: string, collection: string, dataStore: string, session: string): string;
1574
+ /**
1575
+ * Parse the project from ProjectLocationCollectionDataStoreSessions resource.
1576
+ *
1577
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1578
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1579
+ * @returns {string} A string representing the project.
1580
+ */
1581
+ matchProjectFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1582
+ /**
1583
+ * Parse the location from ProjectLocationCollectionDataStoreSessions resource.
1584
+ *
1585
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1586
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1587
+ * @returns {string} A string representing the location.
1588
+ */
1589
+ matchLocationFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1590
+ /**
1591
+ * Parse the collection from ProjectLocationCollectionDataStoreSessions resource.
1592
+ *
1593
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1594
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1595
+ * @returns {string} A string representing the collection.
1596
+ */
1597
+ matchCollectionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1598
+ /**
1599
+ * Parse the data_store from ProjectLocationCollectionDataStoreSessions resource.
1600
+ *
1601
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1602
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1603
+ * @returns {string} A string representing the data_store.
1604
+ */
1605
+ matchDataStoreFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1606
+ /**
1607
+ * Parse the session from ProjectLocationCollectionDataStoreSessions resource.
1608
+ *
1609
+ * @param {string} projectLocationCollectionDataStoreSessionsName
1610
+ * A fully-qualified path representing project_location_collection_data_store_sessions resource.
1611
+ * @returns {string} A string representing the session.
1612
+ */
1613
+ matchSessionFromProjectLocationCollectionDataStoreSessionsName(projectLocationCollectionDataStoreSessionsName: string): string | number;
1560
1614
  /**
1561
1615
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1562
1616
  *
@@ -1803,57 +1857,6 @@ export declare class ConversationalSearchServiceClient {
1803
1857
  * @returns {string} A string representing the serving_config.
1804
1858
  */
1805
1859
  matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1806
- /**
1807
- * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
1808
- *
1809
- * @param {string} project
1810
- * @param {string} location
1811
- * @param {string} collection
1812
- * @param {string} engine
1813
- * @param {string} session
1814
- * @returns {string} Resource name string.
1815
- */
1816
- projectLocationCollectionEngineSessionPath(project: string, location: string, collection: string, engine: string, session: string): string;
1817
- /**
1818
- * Parse the project from ProjectLocationCollectionEngineSession resource.
1819
- *
1820
- * @param {string} projectLocationCollectionEngineSessionName
1821
- * A fully-qualified path representing project_location_collection_engine_session resource.
1822
- * @returns {string} A string representing the project.
1823
- */
1824
- matchProjectFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
1825
- /**
1826
- * Parse the location from ProjectLocationCollectionEngineSession resource.
1827
- *
1828
- * @param {string} projectLocationCollectionEngineSessionName
1829
- * A fully-qualified path representing project_location_collection_engine_session resource.
1830
- * @returns {string} A string representing the location.
1831
- */
1832
- matchLocationFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
1833
- /**
1834
- * Parse the collection from ProjectLocationCollectionEngineSession resource.
1835
- *
1836
- * @param {string} projectLocationCollectionEngineSessionName
1837
- * A fully-qualified path representing project_location_collection_engine_session resource.
1838
- * @returns {string} A string representing the collection.
1839
- */
1840
- matchCollectionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
1841
- /**
1842
- * Parse the engine from ProjectLocationCollectionEngineSession resource.
1843
- *
1844
- * @param {string} projectLocationCollectionEngineSessionName
1845
- * A fully-qualified path representing project_location_collection_engine_session resource.
1846
- * @returns {string} A string representing the engine.
1847
- */
1848
- matchEngineFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
1849
- /**
1850
- * Parse the session from ProjectLocationCollectionEngineSession resource.
1851
- *
1852
- * @param {string} projectLocationCollectionEngineSessionName
1853
- * A fully-qualified path representing project_location_collection_engine_session resource.
1854
- * @returns {string} A string representing the session.
1855
- */
1856
- matchSessionFromProjectLocationCollectionEngineSessionName(projectLocationCollectionEngineSessionName: string): string | number;
1857
1860
  /**
1858
1861
  * Return a fully-qualified projectLocationCollectionEngineSessionAnswer resource name string.
1859
1862
  *
@@ -1914,6 +1917,57 @@ export declare class ConversationalSearchServiceClient {
1914
1917
  * @returns {string} A string representing the answer.
1915
1918
  */
1916
1919
  matchAnswerFromProjectLocationCollectionEngineSessionAnswerName(projectLocationCollectionEngineSessionAnswerName: string): string | number;
1920
+ /**
1921
+ * Return a fully-qualified projectLocationCollectionEngineSessions resource name string.
1922
+ *
1923
+ * @param {string} project
1924
+ * @param {string} location
1925
+ * @param {string} collection
1926
+ * @param {string} engine
1927
+ * @param {string} session
1928
+ * @returns {string} Resource name string.
1929
+ */
1930
+ projectLocationCollectionEngineSessionsPath(project: string, location: string, collection: string, engine: string, session: string): string;
1931
+ /**
1932
+ * Parse the project from ProjectLocationCollectionEngineSessions resource.
1933
+ *
1934
+ * @param {string} projectLocationCollectionEngineSessionsName
1935
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
1936
+ * @returns {string} A string representing the project.
1937
+ */
1938
+ matchProjectFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
1939
+ /**
1940
+ * Parse the location from ProjectLocationCollectionEngineSessions resource.
1941
+ *
1942
+ * @param {string} projectLocationCollectionEngineSessionsName
1943
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
1944
+ * @returns {string} A string representing the location.
1945
+ */
1946
+ matchLocationFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
1947
+ /**
1948
+ * Parse the collection from ProjectLocationCollectionEngineSessions resource.
1949
+ *
1950
+ * @param {string} projectLocationCollectionEngineSessionsName
1951
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
1952
+ * @returns {string} A string representing the collection.
1953
+ */
1954
+ matchCollectionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
1955
+ /**
1956
+ * Parse the engine from ProjectLocationCollectionEngineSessions resource.
1957
+ *
1958
+ * @param {string} projectLocationCollectionEngineSessionsName
1959
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
1960
+ * @returns {string} A string representing the engine.
1961
+ */
1962
+ matchEngineFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
1963
+ /**
1964
+ * Parse the session from ProjectLocationCollectionEngineSessions resource.
1965
+ *
1966
+ * @param {string} projectLocationCollectionEngineSessionsName
1967
+ * A fully-qualified path representing project_location_collection_engine_sessions resource.
1968
+ * @returns {string} A string representing the session.
1969
+ */
1970
+ matchSessionFromProjectLocationCollectionEngineSessionsName(projectLocationCollectionEngineSessionsName: string): string | number;
1917
1971
  /**
1918
1972
  * Return a fully-qualified projectLocationDataStore resource name string.
1919
1973
  *
@@ -2301,48 +2355,6 @@ export declare class ConversationalSearchServiceClient {
2301
2355
  * @returns {string} A string representing the serving_config.
2302
2356
  */
2303
2357
  matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2304
- /**
2305
- * Return a fully-qualified projectLocationDataStoreSession resource name string.
2306
- *
2307
- * @param {string} project
2308
- * @param {string} location
2309
- * @param {string} data_store
2310
- * @param {string} session
2311
- * @returns {string} Resource name string.
2312
- */
2313
- projectLocationDataStoreSessionPath(project: string, location: string, dataStore: string, session: string): string;
2314
- /**
2315
- * Parse the project from ProjectLocationDataStoreSession resource.
2316
- *
2317
- * @param {string} projectLocationDataStoreSessionName
2318
- * A fully-qualified path representing project_location_data_store_session resource.
2319
- * @returns {string} A string representing the project.
2320
- */
2321
- matchProjectFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2322
- /**
2323
- * Parse the location from ProjectLocationDataStoreSession resource.
2324
- *
2325
- * @param {string} projectLocationDataStoreSessionName
2326
- * A fully-qualified path representing project_location_data_store_session resource.
2327
- * @returns {string} A string representing the location.
2328
- */
2329
- matchLocationFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2330
- /**
2331
- * Parse the data_store from ProjectLocationDataStoreSession resource.
2332
- *
2333
- * @param {string} projectLocationDataStoreSessionName
2334
- * A fully-qualified path representing project_location_data_store_session resource.
2335
- * @returns {string} A string representing the data_store.
2336
- */
2337
- matchDataStoreFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2338
- /**
2339
- * Parse the session from ProjectLocationDataStoreSession resource.
2340
- *
2341
- * @param {string} projectLocationDataStoreSessionName
2342
- * A fully-qualified path representing project_location_data_store_session resource.
2343
- * @returns {string} A string representing the session.
2344
- */
2345
- matchSessionFromProjectLocationDataStoreSessionName(projectLocationDataStoreSessionName: string): string | number;
2346
2358
  /**
2347
2359
  * Return a fully-qualified projectLocationDataStoreSessionAnswer resource name string.
2348
2360
  *
@@ -2394,6 +2406,48 @@ export declare class ConversationalSearchServiceClient {
2394
2406
  * @returns {string} A string representing the answer.
2395
2407
  */
2396
2408
  matchAnswerFromProjectLocationDataStoreSessionAnswerName(projectLocationDataStoreSessionAnswerName: string): string | number;
2409
+ /**
2410
+ * Return a fully-qualified projectLocationDataStoreSessions resource name string.
2411
+ *
2412
+ * @param {string} project
2413
+ * @param {string} location
2414
+ * @param {string} data_store
2415
+ * @param {string} session
2416
+ * @returns {string} Resource name string.
2417
+ */
2418
+ projectLocationDataStoreSessionsPath(project: string, location: string, dataStore: string, session: string): string;
2419
+ /**
2420
+ * Parse the project from ProjectLocationDataStoreSessions resource.
2421
+ *
2422
+ * @param {string} projectLocationDataStoreSessionsName
2423
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2424
+ * @returns {string} A string representing the project.
2425
+ */
2426
+ matchProjectFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2427
+ /**
2428
+ * Parse the location from ProjectLocationDataStoreSessions resource.
2429
+ *
2430
+ * @param {string} projectLocationDataStoreSessionsName
2431
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2432
+ * @returns {string} A string representing the location.
2433
+ */
2434
+ matchLocationFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2435
+ /**
2436
+ * Parse the data_store from ProjectLocationDataStoreSessions resource.
2437
+ *
2438
+ * @param {string} projectLocationDataStoreSessionsName
2439
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2440
+ * @returns {string} A string representing the data_store.
2441
+ */
2442
+ matchDataStoreFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2443
+ /**
2444
+ * Parse the session from ProjectLocationDataStoreSessions resource.
2445
+ *
2446
+ * @param {string} projectLocationDataStoreSessionsName
2447
+ * A fully-qualified path representing project_location_data_store_sessions resource.
2448
+ * @returns {string} A string representing the session.
2449
+ */
2450
+ matchSessionFromProjectLocationDataStoreSessionsName(projectLocationDataStoreSessionsName: string): string | number;
2397
2451
  /**
2398
2452
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
2399
2453
  *