@google-cloud/discoveryengine 1.8.0 → 1.9.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 (199) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +33 -4
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +337 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/common.proto +33 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/control.proto +214 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/control_service.proto +236 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +2 -2
  8. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +569 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +4 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +2 -2
  11. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +92 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +6 -6
  13. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +4 -4
  14. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +149 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +58 -0
  16. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +4 -4
  17. package/build/protos/google/cloud/discoveryengine/v1/project.proto +103 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/project_service.proto +90 -0
  19. package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +131 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +20 -19
  21. package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto +5 -5
  22. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +23 -18
  23. package/build/protos/google/cloud/discoveryengine/v1/session.proto +97 -0
  24. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +3 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +28 -3
  26. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +18 -2
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +9 -0
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +7 -0
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +16 -0
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/control.proto +217 -0
  31. package/build/protos/google/cloud/discoveryengine/v1alpha/control_service.proto +236 -0
  32. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +2 -2
  33. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +19 -3
  34. package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +87 -0
  35. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +2 -2
  36. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +1 -0
  37. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +12 -9
  38. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +4 -4
  39. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +30 -1
  40. package/build/protos/google/cloud/discoveryengine/v1alpha/grounding.proto +3 -0
  41. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +4 -4
  42. package/build/protos/google/cloud/discoveryengine/v1alpha/project.proto +1 -0
  43. package/build/protos/google/cloud/discoveryengine/v1alpha/project_service.proto +2 -0
  44. package/build/protos/google/cloud/discoveryengine/v1alpha/rank_service.proto +19 -0
  45. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +20 -19
  46. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +37 -2
  47. package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +6 -6
  48. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +28 -31
  49. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +39 -0
  50. package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +3 -0
  51. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +3 -0
  52. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +29 -3
  53. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +18 -2
  54. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +10 -1
  55. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +16 -0
  56. package/build/protos/google/cloud/discoveryengine/v1beta/control.proto +216 -0
  57. package/build/protos/google/cloud/discoveryengine/v1beta/control_service.proto +236 -0
  58. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +2 -2
  59. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +19 -3
  60. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +87 -0
  61. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +2 -2
  62. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +1 -0
  63. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +7 -8
  64. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +4 -4
  65. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +30 -1
  66. package/build/protos/google/cloud/discoveryengine/v1beta/grounding.proto +3 -0
  67. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +4 -4
  68. package/build/protos/google/cloud/discoveryengine/v1beta/project.proto +103 -0
  69. package/build/protos/google/cloud/discoveryengine/v1beta/project_service.proto +90 -0
  70. package/build/protos/google/cloud/discoveryengine/v1beta/rank_service.proto +19 -0
  71. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +20 -19
  72. package/build/protos/google/cloud/discoveryengine/v1beta/schema_service.proto +5 -5
  73. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +30 -24
  74. package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +39 -0
  75. package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +4 -1
  76. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +3 -0
  77. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +28 -3
  78. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +18 -2
  79. package/build/protos/protos.d.ts +52350 -38733
  80. package/build/protos/protos.js +136479 -103212
  81. package/build/protos/protos.json +9460 -5916
  82. package/build/src/index.d.ts +13 -1
  83. package/build/src/index.js +13 -1
  84. package/build/src/v1/completion_service_client.d.ts +549 -0
  85. package/build/src/v1/completion_service_client.js +771 -0
  86. package/build/src/v1/control_service_client.d.ts +1623 -0
  87. package/build/src/v1/control_service_client.js +2218 -0
  88. package/build/src/v1/control_service_client_config.json +63 -0
  89. package/build/src/v1/conversational_search_service_client.d.ts +893 -0
  90. package/build/src/v1/conversational_search_service_client.js +1040 -14
  91. package/build/src/v1/conversational_search_service_client_config.json +35 -0
  92. package/build/src/v1/data_store_service_client.d.ts +555 -6
  93. package/build/src/v1/data_store_service_client.js +775 -4
  94. package/build/src/v1/document_service_client.d.ts +557 -8
  95. package/build/src/v1/document_service_client.js +773 -2
  96. package/build/src/v1/engine_service_client.d.ts +549 -0
  97. package/build/src/v1/engine_service_client.js +771 -0
  98. package/build/src/v1/grounded_generation_service_client.d.ts +1439 -0
  99. package/build/src/v1/grounded_generation_service_client.js +2036 -0
  100. package/build/src/v1/grounded_generation_service_client_config.json +43 -0
  101. package/build/src/v1/index.d.ts +4 -0
  102. package/build/src/v1/index.js +9 -1
  103. package/build/src/v1/project_service_client.d.ts +1533 -0
  104. package/build/src/v1/project_service_client.js +2255 -0
  105. package/build/src/v1/project_service_client_config.json +43 -0
  106. package/build/src/v1/rank_service_client.d.ts +1449 -0
  107. package/build/src/v1/rank_service_client.js +2037 -0
  108. package/build/src/v1/rank_service_client_config.json +43 -0
  109. package/build/src/v1/recommendation_service_client.d.ts +568 -18
  110. package/build/src/v1/recommendation_service_client.js +756 -0
  111. package/build/src/v1/schema_service_client.d.ts +558 -9
  112. package/build/src/v1/schema_service_client.js +775 -4
  113. package/build/src/v1/search_service_client.d.ts +579 -21
  114. package/build/src/v1/search_service_client.js +776 -14
  115. package/build/src/v1/site_search_engine_service_client.d.ts +549 -0
  116. package/build/src/v1/site_search_engine_service_client.js +771 -0
  117. package/build/src/v1/user_event_service_client.d.ts +562 -2
  118. package/build/src/v1/user_event_service_client.js +771 -0
  119. package/build/src/v1alpha/acl_config_service_client.d.ts +237 -0
  120. package/build/src/v1alpha/acl_config_service_client.js +326 -0
  121. package/build/src/v1alpha/chunk_service_client.d.ts +237 -0
  122. package/build/src/v1alpha/chunk_service_client.js +326 -0
  123. package/build/src/v1alpha/completion_service_client.d.ts +237 -0
  124. package/build/src/v1alpha/completion_service_client.js +340 -0
  125. package/build/src/v1alpha/control_service_client.d.ts +2013 -0
  126. package/build/src/v1alpha/control_service_client.js +2757 -0
  127. package/build/src/v1alpha/control_service_client_config.json +63 -0
  128. package/build/src/v1alpha/conversational_search_service_client.d.ts +239 -2
  129. package/build/src/v1alpha/conversational_search_service_client.js +326 -0
  130. package/build/src/v1alpha/data_store_service_client.d.ts +243 -6
  131. package/build/src/v1alpha/data_store_service_client.js +344 -4
  132. package/build/src/v1alpha/document_service_client.d.ts +246 -9
  133. package/build/src/v1alpha/document_service_client.js +342 -2
  134. package/build/src/v1alpha/engine_service_client.d.ts +237 -0
  135. package/build/src/v1alpha/engine_service_client.js +340 -0
  136. package/build/src/v1alpha/estimate_billing_service_client.d.ts +237 -0
  137. package/build/src/v1alpha/estimate_billing_service_client.js +340 -0
  138. package/build/src/v1alpha/grounded_generation_service_client.d.ts +256 -1
  139. package/build/src/v1alpha/grounded_generation_service_client.js +326 -0
  140. package/build/src/v1alpha/index.d.ts +1 -0
  141. package/build/src/v1alpha/index.js +3 -1
  142. package/build/src/v1alpha/project_service_client.d.ts +239 -0
  143. package/build/src/v1alpha/project_service_client.js +340 -0
  144. package/build/src/v1alpha/project_service_client_config.json +21 -6
  145. package/build/src/v1alpha/rank_service_client.d.ts +255 -0
  146. package/build/src/v1alpha/rank_service_client.js +326 -0
  147. package/build/src/v1alpha/recommendation_service_client.d.ts +256 -18
  148. package/build/src/v1alpha/recommendation_service_client.js +326 -0
  149. package/build/src/v1alpha/schema_service_client.d.ts +247 -10
  150. package/build/src/v1alpha/schema_service_client.js +344 -4
  151. package/build/src/v1alpha/search_service_client.d.ts +267 -21
  152. package/build/src/v1alpha/search_service_client.js +346 -14
  153. package/build/src/v1alpha/search_tuning_service_client.d.ts +265 -0
  154. package/build/src/v1alpha/search_tuning_service_client.js +365 -1
  155. package/build/src/v1alpha/search_tuning_service_client_config.json +4 -0
  156. package/build/src/v1alpha/serving_config_service_client.d.ts +237 -0
  157. package/build/src/v1alpha/serving_config_service_client.js +326 -0
  158. package/build/src/v1alpha/site_search_engine_service_client.d.ts +237 -0
  159. package/build/src/v1alpha/site_search_engine_service_client.js +340 -0
  160. package/build/src/v1alpha/user_event_service_client.d.ts +250 -2
  161. package/build/src/v1alpha/user_event_service_client.js +340 -0
  162. package/build/src/v1beta/completion_service_client.d.ts +252 -0
  163. package/build/src/v1beta/completion_service_client.js +359 -0
  164. package/build/src/v1beta/control_service_client.d.ts +1860 -0
  165. package/build/src/v1beta/control_service_client.js +2545 -0
  166. package/build/src/v1beta/control_service_client_config.json +63 -0
  167. package/build/src/v1beta/conversational_search_service_client.d.ts +254 -2
  168. package/build/src/v1beta/conversational_search_service_client.js +348 -0
  169. package/build/src/v1beta/data_store_service_client.d.ts +258 -6
  170. package/build/src/v1beta/data_store_service_client.js +363 -4
  171. package/build/src/v1beta/document_service_client.d.ts +261 -10
  172. package/build/src/v1beta/document_service_client.js +361 -2
  173. package/build/src/v1beta/engine_service_client.d.ts +252 -0
  174. package/build/src/v1beta/engine_service_client.js +359 -0
  175. package/build/src/v1beta/grounded_generation_service_client.d.ts +271 -1
  176. package/build/src/v1beta/grounded_generation_service_client.js +348 -0
  177. package/build/src/v1beta/index.d.ts +2 -0
  178. package/build/src/v1beta/index.js +5 -1
  179. package/build/src/v1beta/project_service_client.d.ts +1770 -0
  180. package/build/src/v1beta/project_service_client.js +2576 -0
  181. package/build/src/v1beta/project_service_client_config.json +43 -0
  182. package/build/src/v1beta/rank_service_client.d.ts +270 -0
  183. package/build/src/v1beta/rank_service_client.js +348 -0
  184. package/build/src/v1beta/recommendation_service_client.d.ts +271 -18
  185. package/build/src/v1beta/recommendation_service_client.js +348 -0
  186. package/build/src/v1beta/schema_service_client.d.ts +261 -9
  187. package/build/src/v1beta/schema_service_client.js +363 -4
  188. package/build/src/v1beta/search_service_client.d.ts +282 -21
  189. package/build/src/v1beta/search_service_client.js +368 -14
  190. package/build/src/v1beta/search_tuning_service_client.d.ts +280 -0
  191. package/build/src/v1beta/search_tuning_service_client.js +384 -1
  192. package/build/src/v1beta/search_tuning_service_client_config.json +4 -0
  193. package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
  194. package/build/src/v1beta/serving_config_service_client.js +326 -0
  195. package/build/src/v1beta/site_search_engine_service_client.d.ts +252 -0
  196. package/build/src/v1beta/site_search_engine_service_client.js +359 -0
  197. package/build/src/v1beta/user_event_service_client.d.ts +265 -2
  198. package/build/src/v1beta/user_event_service_client.js +359 -0
  199. package/package.json +2 -2
@@ -156,7 +156,9 @@ class SearchServiceClient {
156
156
  projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
157
157
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
158
158
  projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
159
+ projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
159
160
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
161
+ projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
160
162
  projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
161
163
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
162
164
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
@@ -164,6 +166,7 @@ class SearchServiceClient {
164
166
  projectLocationCollectionDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
165
167
  projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
166
168
  projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
169
+ projectLocationCollectionEngineControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/controls/{control}'),
167
170
  projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
168
171
  projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
169
172
  projectLocationCollectionEngineSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}'),
@@ -172,7 +175,9 @@ class SearchServiceClient {
172
175
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
173
176
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
174
177
  projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
178
+ projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
175
179
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
180
+ projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
176
181
  projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
177
182
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
178
183
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
@@ -370,7 +375,10 @@ class SearchServiceClient {
370
375
  *
371
376
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
372
377
  * @param {number[]} request.dataStoreSpecs
373
- * A list of data store specs to apply on a search call.
378
+ * Specs defining dataStores to filter on in a search call and configurations
379
+ * for those dataStores. This is only considered for engines with multiple
380
+ * dataStores use case. For single dataStore within an engine, they should
381
+ * use the specs at the top level.
374
382
  * @param {string} request.filter
375
383
  * The filter syntax consists of an expression language for constructing a
376
384
  * predicate from one or more fields of the documents being filtered. Filter
@@ -404,7 +412,9 @@ class SearchServiceClient {
404
412
  * The order in which documents are returned. Documents can be ordered by
405
413
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
406
414
  * object. Leave it unset if ordered by relevance. `order_by` expression is
407
- * case-sensitive. For more information on ordering, see
415
+ * case-sensitive.
416
+ *
417
+ * For more information on ordering for retail search, see
408
418
  * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
409
419
  *
410
420
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -421,7 +431,7 @@ class SearchServiceClient {
421
431
  * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec} request.boostSpec
422
432
  * Boost specification to boost certain documents.
423
433
  * For more information on boosting, see
424
- * [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
434
+ * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
425
435
  * @param {number[]} request.params
426
436
  * Additional search parameters.
427
437
  *
@@ -429,8 +439,7 @@ class SearchServiceClient {
429
439
  *
430
440
  * * `user_country_code`: string. Default empty. If set to non-empty, results
431
441
  * are restricted or boosted based on the location provided.
432
- * Example:
433
- * user_country_code: "au"
442
+ * For example, `user_country_code: "au"`
434
443
  *
435
444
  * For available codes see [Country
436
445
  * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -438,8 +447,7 @@ class SearchServiceClient {
438
447
  * * `search_type`: double. Default empty. Enables non-webpage searching
439
448
  * depending on the value. The only valid non-default value is 1,
440
449
  * which enables image searching.
441
- * Example:
442
- * search_type: 1
450
+ * For example, `search_type: 1`
443
451
  * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
444
452
  * The query expansion specification that specifies the conditions under which
445
453
  * query expansion occurs.
@@ -597,7 +605,10 @@ class SearchServiceClient {
597
605
  *
598
606
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
599
607
  * @param {number[]} request.dataStoreSpecs
600
- * A list of data store specs to apply on a search call.
608
+ * Specs defining dataStores to filter on in a search call and configurations
609
+ * for those dataStores. This is only considered for engines with multiple
610
+ * dataStores use case. For single dataStore within an engine, they should
611
+ * use the specs at the top level.
601
612
  * @param {string} request.filter
602
613
  * The filter syntax consists of an expression language for constructing a
603
614
  * predicate from one or more fields of the documents being filtered. Filter
@@ -631,7 +642,9 @@ class SearchServiceClient {
631
642
  * The order in which documents are returned. Documents can be ordered by
632
643
  * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
633
644
  * object. Leave it unset if ordered by relevance. `order_by` expression is
634
- * case-sensitive. For more information on ordering, see
645
+ * case-sensitive.
646
+ *
647
+ * For more information on ordering for retail search, see
635
648
  * [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
636
649
  *
637
650
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -648,7 +661,7 @@ class SearchServiceClient {
648
661
  * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec} request.boostSpec
649
662
  * Boost specification to boost certain documents.
650
663
  * For more information on boosting, see
651
- * [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
664
+ * [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
652
665
  * @param {number[]} request.params
653
666
  * Additional search parameters.
654
667
  *
@@ -656,8 +669,7 @@ class SearchServiceClient {
656
669
  *
657
670
  * * `user_country_code`: string. Default empty. If set to non-empty, results
658
671
  * are restricted or boosted based on the location provided.
659
- * Example:
660
- * user_country_code: "au"
672
+ * For example, `user_country_code: "au"`
661
673
  *
662
674
  * For available codes see [Country
663
675
  * Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -665,8 +677,7 @@ class SearchServiceClient {
665
677
  * * `search_type`: double. Default empty. Enables non-webpage searching
666
678
  * depending on the value. The only valid non-default value is 1,
667
679
  * which enables image searching.
668
- * Example:
669
- * search_type: 1
680
+ * For example, `search_type: 1`
670
681
  * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
671
682
  * The query expansion specification that specifies the conditions under which
672
683
  * query expansion occurs.
@@ -1243,6 +1254,75 @@ class SearchServiceClient {
1243
1254
  matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1244
1255
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).chunk;
1245
1256
  }
1257
+ /**
1258
+ * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
1259
+ *
1260
+ * @param {string} project
1261
+ * @param {string} location
1262
+ * @param {string} collection
1263
+ * @param {string} data_store
1264
+ * @param {string} control
1265
+ * @returns {string} Resource name string.
1266
+ */
1267
+ projectLocationCollectionDataStoreControlPath(project, location, collection, dataStore, control) {
1268
+ return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.render({
1269
+ project: project,
1270
+ location: location,
1271
+ collection: collection,
1272
+ data_store: dataStore,
1273
+ control: control,
1274
+ });
1275
+ }
1276
+ /**
1277
+ * Parse the project from ProjectLocationCollectionDataStoreControl resource.
1278
+ *
1279
+ * @param {string} projectLocationCollectionDataStoreControlName
1280
+ * A fully-qualified path representing project_location_collection_data_store_control resource.
1281
+ * @returns {string} A string representing the project.
1282
+ */
1283
+ matchProjectFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName) {
1284
+ return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).project;
1285
+ }
1286
+ /**
1287
+ * Parse the location from ProjectLocationCollectionDataStoreControl resource.
1288
+ *
1289
+ * @param {string} projectLocationCollectionDataStoreControlName
1290
+ * A fully-qualified path representing project_location_collection_data_store_control resource.
1291
+ * @returns {string} A string representing the location.
1292
+ */
1293
+ matchLocationFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName) {
1294
+ return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).location;
1295
+ }
1296
+ /**
1297
+ * Parse the collection from ProjectLocationCollectionDataStoreControl resource.
1298
+ *
1299
+ * @param {string} projectLocationCollectionDataStoreControlName
1300
+ * A fully-qualified path representing project_location_collection_data_store_control resource.
1301
+ * @returns {string} A string representing the collection.
1302
+ */
1303
+ matchCollectionFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName) {
1304
+ return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).collection;
1305
+ }
1306
+ /**
1307
+ * Parse the data_store from ProjectLocationCollectionDataStoreControl resource.
1308
+ *
1309
+ * @param {string} projectLocationCollectionDataStoreControlName
1310
+ * A fully-qualified path representing project_location_collection_data_store_control resource.
1311
+ * @returns {string} A string representing the data_store.
1312
+ */
1313
+ matchDataStoreFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName) {
1314
+ return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).data_store;
1315
+ }
1316
+ /**
1317
+ * Parse the control from ProjectLocationCollectionDataStoreControl resource.
1318
+ *
1319
+ * @param {string} projectLocationCollectionDataStoreControlName
1320
+ * A fully-qualified path representing project_location_collection_data_store_control resource.
1321
+ * @returns {string} A string representing the control.
1322
+ */
1323
+ matchControlFromProjectLocationCollectionDataStoreControlName(projectLocationCollectionDataStoreControlName) {
1324
+ return this.pathTemplates.projectLocationCollectionDataStoreControlPathTemplate.match(projectLocationCollectionDataStoreControlName).control;
1325
+ }
1246
1326
  /**
1247
1327
  * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
1248
1328
  *
@@ -1312,6 +1392,75 @@ class SearchServiceClient {
1312
1392
  matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1313
1393
  return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1314
1394
  }
1395
+ /**
1396
+ * Return a fully-qualified projectLocationCollectionDataStoreCustomTuningModel resource name string.
1397
+ *
1398
+ * @param {string} project
1399
+ * @param {string} location
1400
+ * @param {string} collection
1401
+ * @param {string} data_store
1402
+ * @param {string} custom_tuning_model
1403
+ * @returns {string} Resource name string.
1404
+ */
1405
+ projectLocationCollectionDataStoreCustomTuningModelPath(project, location, collection, dataStore, customTuningModel) {
1406
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.render({
1407
+ project: project,
1408
+ location: location,
1409
+ collection: collection,
1410
+ data_store: dataStore,
1411
+ custom_tuning_model: customTuningModel,
1412
+ });
1413
+ }
1414
+ /**
1415
+ * Parse the project from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1416
+ *
1417
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1418
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1419
+ * @returns {string} A string representing the project.
1420
+ */
1421
+ matchProjectFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1422
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).project;
1423
+ }
1424
+ /**
1425
+ * Parse the location from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1426
+ *
1427
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1428
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1429
+ * @returns {string} A string representing the location.
1430
+ */
1431
+ matchLocationFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1432
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).location;
1433
+ }
1434
+ /**
1435
+ * Parse the collection from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1436
+ *
1437
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1438
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1439
+ * @returns {string} A string representing the collection.
1440
+ */
1441
+ matchCollectionFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1442
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).collection;
1443
+ }
1444
+ /**
1445
+ * Parse the data_store from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1446
+ *
1447
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1448
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1449
+ * @returns {string} A string representing the data_store.
1450
+ */
1451
+ matchDataStoreFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1452
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).data_store;
1453
+ }
1454
+ /**
1455
+ * Parse the custom_tuning_model from ProjectLocationCollectionDataStoreCustomTuningModel resource.
1456
+ *
1457
+ * @param {string} projectLocationCollectionDataStoreCustomTuningModelName
1458
+ * A fully-qualified path representing project_location_collection_data_store_custom_tuning_model resource.
1459
+ * @returns {string} A string representing the custom_tuning_model.
1460
+ */
1461
+ matchCustomTuningModelFromProjectLocationCollectionDataStoreCustomTuningModelName(projectLocationCollectionDataStoreCustomTuningModelName) {
1462
+ return this.pathTemplates.projectLocationCollectionDataStoreCustomTuningModelPathTemplate.match(projectLocationCollectionDataStoreCustomTuningModelName).custom_tuning_model;
1463
+ }
1315
1464
  /**
1316
1465
  * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
1317
1466
  *
@@ -1783,6 +1932,75 @@ class SearchServiceClient {
1783
1932
  matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1784
1933
  return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
1785
1934
  }
1935
+ /**
1936
+ * Return a fully-qualified projectLocationCollectionEngineControl resource name string.
1937
+ *
1938
+ * @param {string} project
1939
+ * @param {string} location
1940
+ * @param {string} collection
1941
+ * @param {string} engine
1942
+ * @param {string} control
1943
+ * @returns {string} Resource name string.
1944
+ */
1945
+ projectLocationCollectionEngineControlPath(project, location, collection, engine, control) {
1946
+ return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.render({
1947
+ project: project,
1948
+ location: location,
1949
+ collection: collection,
1950
+ engine: engine,
1951
+ control: control,
1952
+ });
1953
+ }
1954
+ /**
1955
+ * Parse the project from ProjectLocationCollectionEngineControl resource.
1956
+ *
1957
+ * @param {string} projectLocationCollectionEngineControlName
1958
+ * A fully-qualified path representing project_location_collection_engine_control resource.
1959
+ * @returns {string} A string representing the project.
1960
+ */
1961
+ matchProjectFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName) {
1962
+ return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).project;
1963
+ }
1964
+ /**
1965
+ * Parse the location from ProjectLocationCollectionEngineControl resource.
1966
+ *
1967
+ * @param {string} projectLocationCollectionEngineControlName
1968
+ * A fully-qualified path representing project_location_collection_engine_control resource.
1969
+ * @returns {string} A string representing the location.
1970
+ */
1971
+ matchLocationFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName) {
1972
+ return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).location;
1973
+ }
1974
+ /**
1975
+ * Parse the collection from ProjectLocationCollectionEngineControl resource.
1976
+ *
1977
+ * @param {string} projectLocationCollectionEngineControlName
1978
+ * A fully-qualified path representing project_location_collection_engine_control resource.
1979
+ * @returns {string} A string representing the collection.
1980
+ */
1981
+ matchCollectionFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName) {
1982
+ return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).collection;
1983
+ }
1984
+ /**
1985
+ * Parse the engine from ProjectLocationCollectionEngineControl resource.
1986
+ *
1987
+ * @param {string} projectLocationCollectionEngineControlName
1988
+ * A fully-qualified path representing project_location_collection_engine_control resource.
1989
+ * @returns {string} A string representing the engine.
1990
+ */
1991
+ matchEngineFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName) {
1992
+ return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).engine;
1993
+ }
1994
+ /**
1995
+ * Parse the control from ProjectLocationCollectionEngineControl resource.
1996
+ *
1997
+ * @param {string} projectLocationCollectionEngineControlName
1998
+ * A fully-qualified path representing project_location_collection_engine_control resource.
1999
+ * @returns {string} A string representing the control.
2000
+ */
2001
+ matchControlFromProjectLocationCollectionEngineControlName(projectLocationCollectionEngineControlName) {
2002
+ return this.pathTemplates.projectLocationCollectionEngineControlPathTemplate.match(projectLocationCollectionEngineControlName).control;
2003
+ }
1786
2004
  /**
1787
2005
  * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1788
2006
  *
@@ -2323,6 +2541,63 @@ class SearchServiceClient {
2323
2541
  matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2324
2542
  return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).chunk;
2325
2543
  }
2544
+ /**
2545
+ * Return a fully-qualified projectLocationDataStoreControl resource name string.
2546
+ *
2547
+ * @param {string} project
2548
+ * @param {string} location
2549
+ * @param {string} data_store
2550
+ * @param {string} control
2551
+ * @returns {string} Resource name string.
2552
+ */
2553
+ projectLocationDataStoreControlPath(project, location, dataStore, control) {
2554
+ return this.pathTemplates.projectLocationDataStoreControlPathTemplate.render({
2555
+ project: project,
2556
+ location: location,
2557
+ data_store: dataStore,
2558
+ control: control,
2559
+ });
2560
+ }
2561
+ /**
2562
+ * Parse the project from ProjectLocationDataStoreControl resource.
2563
+ *
2564
+ * @param {string} projectLocationDataStoreControlName
2565
+ * A fully-qualified path representing project_location_data_store_control resource.
2566
+ * @returns {string} A string representing the project.
2567
+ */
2568
+ matchProjectFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName) {
2569
+ return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).project;
2570
+ }
2571
+ /**
2572
+ * Parse the location from ProjectLocationDataStoreControl resource.
2573
+ *
2574
+ * @param {string} projectLocationDataStoreControlName
2575
+ * A fully-qualified path representing project_location_data_store_control resource.
2576
+ * @returns {string} A string representing the location.
2577
+ */
2578
+ matchLocationFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName) {
2579
+ return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).location;
2580
+ }
2581
+ /**
2582
+ * Parse the data_store from ProjectLocationDataStoreControl resource.
2583
+ *
2584
+ * @param {string} projectLocationDataStoreControlName
2585
+ * A fully-qualified path representing project_location_data_store_control resource.
2586
+ * @returns {string} A string representing the data_store.
2587
+ */
2588
+ matchDataStoreFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName) {
2589
+ return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).data_store;
2590
+ }
2591
+ /**
2592
+ * Parse the control from ProjectLocationDataStoreControl resource.
2593
+ *
2594
+ * @param {string} projectLocationDataStoreControlName
2595
+ * A fully-qualified path representing project_location_data_store_control resource.
2596
+ * @returns {string} A string representing the control.
2597
+ */
2598
+ matchControlFromProjectLocationDataStoreControlName(projectLocationDataStoreControlName) {
2599
+ return this.pathTemplates.projectLocationDataStoreControlPathTemplate.match(projectLocationDataStoreControlName).control;
2600
+ }
2326
2601
  /**
2327
2602
  * Return a fully-qualified projectLocationDataStoreConversation resource name string.
2328
2603
  *
@@ -2380,6 +2655,63 @@ class SearchServiceClient {
2380
2655
  matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
2381
2656
  return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
2382
2657
  }
2658
+ /**
2659
+ * Return a fully-qualified projectLocationDataStoreCustomTuningModel resource name string.
2660
+ *
2661
+ * @param {string} project
2662
+ * @param {string} location
2663
+ * @param {string} data_store
2664
+ * @param {string} custom_tuning_model
2665
+ * @returns {string} Resource name string.
2666
+ */
2667
+ projectLocationDataStoreCustomTuningModelPath(project, location, dataStore, customTuningModel) {
2668
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.render({
2669
+ project: project,
2670
+ location: location,
2671
+ data_store: dataStore,
2672
+ custom_tuning_model: customTuningModel,
2673
+ });
2674
+ }
2675
+ /**
2676
+ * Parse the project from ProjectLocationDataStoreCustomTuningModel resource.
2677
+ *
2678
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2679
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2680
+ * @returns {string} A string representing the project.
2681
+ */
2682
+ matchProjectFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2683
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).project;
2684
+ }
2685
+ /**
2686
+ * Parse the location from ProjectLocationDataStoreCustomTuningModel resource.
2687
+ *
2688
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2689
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2690
+ * @returns {string} A string representing the location.
2691
+ */
2692
+ matchLocationFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2693
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).location;
2694
+ }
2695
+ /**
2696
+ * Parse the data_store from ProjectLocationDataStoreCustomTuningModel resource.
2697
+ *
2698
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2699
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2700
+ * @returns {string} A string representing the data_store.
2701
+ */
2702
+ matchDataStoreFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2703
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).data_store;
2704
+ }
2705
+ /**
2706
+ * Parse the custom_tuning_model from ProjectLocationDataStoreCustomTuningModel resource.
2707
+ *
2708
+ * @param {string} projectLocationDataStoreCustomTuningModelName
2709
+ * A fully-qualified path representing project_location_data_store_custom_tuning_model resource.
2710
+ * @returns {string} A string representing the custom_tuning_model.
2711
+ */
2712
+ matchCustomTuningModelFromProjectLocationDataStoreCustomTuningModelName(projectLocationDataStoreCustomTuningModelName) {
2713
+ return this.pathTemplates.projectLocationDataStoreCustomTuningModelPathTemplate.match(projectLocationDataStoreCustomTuningModelName).custom_tuning_model;
2714
+ }
2383
2715
  /**
2384
2716
  * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
2385
2717
  *