@google-cloud/discoveryengine 1.4.0 → 1.4.1

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 (107) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +13 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +49 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +79 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +72 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +137 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +77 -4
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +52 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +44 -2
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +6 -1
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +44 -0
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +80 -1
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +83 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +127 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +6 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +13 -8
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +3 -2
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +130 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +64 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +66 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +3 -1
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +3 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +74 -13
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +24 -20
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +271 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +147 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +9 -3
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +7 -4
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -3
  30. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +5 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +22 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +9 -0
  33. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +94 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +3 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +19 -4
  36. package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +151 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +4 -3
  38. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +6 -5
  39. package/build/protos/protos.d.ts +15133 -7787
  40. package/build/protos/protos.js +50444 -32043
  41. package/build/protos/protos.json +4132 -2305
  42. package/build/src/v1alpha/acl_config_service_client.d.ts +1233 -0
  43. package/build/src/v1alpha/acl_config_service_client.js +1765 -0
  44. package/build/src/v1alpha/acl_config_service_client_config.json +34 -0
  45. package/build/src/v1alpha/chunk_service_client.d.ts +1350 -0
  46. package/build/src/v1alpha/chunk_service_client.js +1886 -0
  47. package/build/src/v1alpha/chunk_service_client_config.json +34 -0
  48. package/build/src/v1alpha/completion_service_client.d.ts +588 -3
  49. package/build/src/v1alpha/completion_service_client.js +831 -2
  50. package/build/src/v1alpha/completion_service_client_config.json +10 -0
  51. package/build/src/v1alpha/conversational_search_service_client.d.ts +233 -1
  52. package/build/src/v1alpha/conversational_search_service_client.js +316 -0
  53. package/build/src/v1alpha/data_store_service_client.d.ts +451 -3
  54. package/build/src/v1alpha/data_store_service_client.js +562 -2
  55. package/build/src/v1alpha/data_store_service_client_config.json +8 -0
  56. package/build/src/v1alpha/document_service_client.d.ts +382 -0
  57. package/build/src/v1alpha/document_service_client.js +514 -0
  58. package/build/src/v1alpha/engine_service_client.d.ts +375 -2
  59. package/build/src/v1alpha/engine_service_client.js +514 -0
  60. package/build/src/v1alpha/estimate_billing_service_client.d.ts +1367 -0
  61. package/build/src/v1alpha/estimate_billing_service_client.js +2028 -0
  62. package/build/src/v1alpha/estimate_billing_service_client_config.json +30 -0
  63. package/build/src/v1alpha/index.d.ts +4 -0
  64. package/build/src/v1alpha/index.js +9 -1
  65. package/build/src/v1alpha/recommendation_service_client.d.ts +231 -1
  66. package/build/src/v1alpha/recommendation_service_client.js +316 -0
  67. package/build/src/v1alpha/schema_service_client.d.ts +372 -0
  68. package/build/src/v1alpha/schema_service_client.js +514 -0
  69. package/build/src/v1alpha/search_service_client.d.ts +258 -15
  70. package/build/src/v1alpha/search_service_client.js +336 -10
  71. package/build/src/v1alpha/search_tuning_service_client.d.ts +373 -1
  72. package/build/src/v1alpha/search_tuning_service_client.js +514 -0
  73. package/build/src/v1alpha/serving_config_service_client.d.ts +1369 -0
  74. package/build/src/v1alpha/serving_config_service_client.js +1935 -0
  75. package/build/src/v1alpha/serving_config_service_client_config.json +38 -0
  76. package/build/src/v1alpha/site_search_engine_service_client.d.ts +372 -0
  77. package/build/src/v1alpha/site_search_engine_service_client.js +514 -0
  78. package/build/src/v1alpha/user_event_service_client.d.ts +372 -0
  79. package/build/src/v1alpha/user_event_service_client.js +514 -0
  80. package/build/src/v1beta/completion_service_client.d.ts +75 -0
  81. package/build/src/v1beta/completion_service_client.js +104 -0
  82. package/build/src/v1beta/conversational_search_service_client.d.ts +79 -0
  83. package/build/src/v1beta/conversational_search_service_client.js +104 -0
  84. package/build/src/v1beta/data_store_service_client.d.ts +75 -0
  85. package/build/src/v1beta/data_store_service_client.js +104 -0
  86. package/build/src/v1beta/document_service_client.d.ts +75 -0
  87. package/build/src/v1beta/document_service_client.js +104 -0
  88. package/build/src/v1beta/engine_service_client.d.ts +75 -0
  89. package/build/src/v1beta/engine_service_client.js +104 -0
  90. package/build/src/v1beta/index.d.ts +1 -0
  91. package/build/src/v1beta/index.js +3 -1
  92. package/build/src/v1beta/recommendation_service_client.d.ts +75 -0
  93. package/build/src/v1beta/recommendation_service_client.js +104 -0
  94. package/build/src/v1beta/schema_service_client.d.ts +75 -0
  95. package/build/src/v1beta/schema_service_client.js +104 -0
  96. package/build/src/v1beta/search_service_client.d.ts +81 -0
  97. package/build/src/v1beta/search_service_client.js +108 -0
  98. package/build/src/v1beta/search_tuning_service_client.d.ts +1196 -0
  99. package/build/src/v1beta/search_tuning_service_client.js +1781 -0
  100. package/build/src/v1beta/search_tuning_service_client_config.json +30 -0
  101. package/build/src/v1beta/serving_config_service_client.d.ts +123 -8
  102. package/build/src/v1beta/serving_config_service_client.js +166 -5
  103. package/build/src/v1beta/site_search_engine_service_client.d.ts +75 -0
  104. package/build/src/v1beta/site_search_engine_service_client.js +104 -0
  105. package/build/src/v1beta/user_event_service_client.d.ts +75 -0
  106. package/build/src/v1beta/user_event_service_client.js +104 -0
  107. package/package.json +3 -3
@@ -151,6 +151,7 @@ class SearchServiceClient {
151
151
  projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
152
152
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
153
153
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
154
+ projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig'),
154
155
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
155
156
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
156
157
  projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
@@ -161,6 +162,7 @@ class SearchServiceClient {
161
162
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
162
163
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
163
164
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
165
+ projectLocationDataStoreDocumentProcessingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig'),
164
166
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
165
167
  projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
166
168
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
@@ -349,6 +351,8 @@ class SearchServiceClient {
349
351
  * is unset.
350
352
  *
351
353
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
354
+ * @param {number[]} request.dataStoreSpecs
355
+ * A list of data store specs to apply on a search call.
352
356
  * @param {string} request.filter
353
357
  * The filter syntax consists of an expression language for constructing a
354
358
  * predicate from one or more fields of the documents being filtered. Filter
@@ -566,6 +570,8 @@ class SearchServiceClient {
566
570
  * is unset.
567
571
  *
568
572
  * If this field is negative, an `INVALID_ARGUMENT` is returned.
573
+ * @param {number[]} request.dataStoreSpecs
574
+ * A list of data store specs to apply on a search call.
569
575
  * @param {string} request.filter
570
576
  * The filter syntax consists of an expression language for constructing a
571
577
  * predicate from one or more fields of the documents being filtered. Filter
@@ -1128,6 +1134,63 @@ class SearchServiceClient {
1128
1134
  matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1129
1135
  return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1130
1136
  }
1137
+ /**
1138
+ * Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
1139
+ *
1140
+ * @param {string} project
1141
+ * @param {string} location
1142
+ * @param {string} collection
1143
+ * @param {string} data_store
1144
+ * @returns {string} Resource name string.
1145
+ */
1146
+ projectLocationCollectionDataStoreDocumentProcessingConfigPath(project, location, collection, dataStore) {
1147
+ return this.pathTemplates.projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate.render({
1148
+ project: project,
1149
+ location: location,
1150
+ collection: collection,
1151
+ data_store: dataStore,
1152
+ });
1153
+ }
1154
+ /**
1155
+ * Parse the project from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
1156
+ *
1157
+ * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
1158
+ * A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
1159
+ * @returns {string} A string representing the project.
1160
+ */
1161
+ matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName) {
1162
+ return this.pathTemplates.projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate.match(projectLocationCollectionDataStoreDocumentProcessingConfigName).project;
1163
+ }
1164
+ /**
1165
+ * Parse the location from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
1166
+ *
1167
+ * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
1168
+ * A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
1169
+ * @returns {string} A string representing the location.
1170
+ */
1171
+ matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName) {
1172
+ return this.pathTemplates.projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate.match(projectLocationCollectionDataStoreDocumentProcessingConfigName).location;
1173
+ }
1174
+ /**
1175
+ * Parse the collection from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
1176
+ *
1177
+ * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
1178
+ * A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
1179
+ * @returns {string} A string representing the collection.
1180
+ */
1181
+ matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName) {
1182
+ return this.pathTemplates.projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate.match(projectLocationCollectionDataStoreDocumentProcessingConfigName).collection;
1183
+ }
1184
+ /**
1185
+ * Parse the data_store from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
1186
+ *
1187
+ * @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
1188
+ * A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
1189
+ * @returns {string} A string representing the data_store.
1190
+ */
1191
+ matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName) {
1192
+ return this.pathTemplates.projectLocationCollectionDataStoreDocumentProcessingConfigPathTemplate.match(projectLocationCollectionDataStoreDocumentProcessingConfigName).data_store;
1193
+ }
1131
1194
  /**
1132
1195
  * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
1133
1196
  *
@@ -1758,6 +1821,51 @@ class SearchServiceClient {
1758
1821
  matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1759
1822
  return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
1760
1823
  }
1824
+ /**
1825
+ * Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
1826
+ *
1827
+ * @param {string} project
1828
+ * @param {string} location
1829
+ * @param {string} data_store
1830
+ * @returns {string} Resource name string.
1831
+ */
1832
+ projectLocationDataStoreDocumentProcessingConfigPath(project, location, dataStore) {
1833
+ return this.pathTemplates.projectLocationDataStoreDocumentProcessingConfigPathTemplate.render({
1834
+ project: project,
1835
+ location: location,
1836
+ data_store: dataStore,
1837
+ });
1838
+ }
1839
+ /**
1840
+ * Parse the project from ProjectLocationDataStoreDocumentProcessingConfig resource.
1841
+ *
1842
+ * @param {string} projectLocationDataStoreDocumentProcessingConfigName
1843
+ * A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
1844
+ * @returns {string} A string representing the project.
1845
+ */
1846
+ matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName) {
1847
+ return this.pathTemplates.projectLocationDataStoreDocumentProcessingConfigPathTemplate.match(projectLocationDataStoreDocumentProcessingConfigName).project;
1848
+ }
1849
+ /**
1850
+ * Parse the location from ProjectLocationDataStoreDocumentProcessingConfig resource.
1851
+ *
1852
+ * @param {string} projectLocationDataStoreDocumentProcessingConfigName
1853
+ * A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
1854
+ * @returns {string} A string representing the location.
1855
+ */
1856
+ matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName) {
1857
+ return this.pathTemplates.projectLocationDataStoreDocumentProcessingConfigPathTemplate.match(projectLocationDataStoreDocumentProcessingConfigName).location;
1858
+ }
1859
+ /**
1860
+ * Parse the data_store from ProjectLocationDataStoreDocumentProcessingConfig resource.
1861
+ *
1862
+ * @param {string} projectLocationDataStoreDocumentProcessingConfigName
1863
+ * A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
1864
+ * @returns {string} A string representing the data_store.
1865
+ */
1866
+ matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName) {
1867
+ return this.pathTemplates.projectLocationDataStoreDocumentProcessingConfigPathTemplate.match(projectLocationDataStoreDocumentProcessingConfigName).data_store;
1868
+ }
1761
1869
  /**
1762
1870
  * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1763
1871
  *