@google-cloud/discoveryengine 2.1.0 → 2.3.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 (172) hide show
  1. package/README.md +13 -0
  2. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +17 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +52 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto +300 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +67 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +1 -3
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +3 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +54 -2
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +14 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +95 -4
  11. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +28 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +131 -6
  13. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +8 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +9 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto +84 -0
  16. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto +375 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +6 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +6 -0
  19. package/build/protos/google/cloud/discoveryengine/v1/user_license.proto +98 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto +191 -0
  21. package/build/protos/protos.d.ts +5415 -578
  22. package/build/protos/protos.js +77830 -63391
  23. package/build/protos/protos.json +1537 -92
  24. package/build/src/index.d.ts +10 -1
  25. package/build/src/index.js +8 -22
  26. package/build/src/v1/cmek_config_service_client.d.ts +2287 -0
  27. package/build/src/v1/cmek_config_service_client.js +3274 -0
  28. package/build/src/v1/cmek_config_service_client_config.json +42 -0
  29. package/build/src/v1/cmek_config_service_proto_list.json +44 -0
  30. package/build/src/v1/completion_service_client.d.ts +166 -76
  31. package/build/src/v1/completion_service_client.js +258 -263
  32. package/build/src/v1/completion_service_proto_list.json +6 -1
  33. package/build/src/v1/control_service_client.d.ts +171 -81
  34. package/build/src/v1/control_service_client.js +246 -132
  35. package/build/src/v1/control_service_proto_list.json +6 -1
  36. package/build/src/v1/conversational_search_service_client.d.ts +233 -143
  37. package/build/src/v1/conversational_search_service_client.js +330 -226
  38. package/build/src/v1/conversational_search_service_proto_list.json +6 -1
  39. package/build/src/v1/data_store_service_client.d.ts +218 -122
  40. package/build/src/v1/data_store_service_client.js +273 -281
  41. package/build/src/v1/data_store_service_proto_list.json +6 -1
  42. package/build/src/v1/document_service_client.d.ts +210 -120
  43. package/build/src/v1/document_service_client.js +300 -301
  44. package/build/src/v1/document_service_proto_list.json +6 -1
  45. package/build/src/v1/engine_service_client.d.ts +193 -103
  46. package/build/src/v1/engine_service_client.js +273 -280
  47. package/build/src/v1/engine_service_proto_list.json +6 -1
  48. package/build/src/v1/gapic_metadata.json +184 -0
  49. package/build/src/v1/grounded_generation_service_client.d.ts +138 -48
  50. package/build/src/v1/grounded_generation_service_client.js +217 -100
  51. package/build/src/v1/grounded_generation_service_proto_list.json +6 -1
  52. package/build/src/v1/identity_mapping_store_service_client.d.ts +2470 -0
  53. package/build/src/v1/identity_mapping_store_service_client.js +3449 -0
  54. package/build/src/v1/identity_mapping_store_service_client_config.json +54 -0
  55. package/build/src/v1/identity_mapping_store_service_proto_list.json +44 -0
  56. package/build/src/v1/index.d.ts +3 -0
  57. package/build/src/v1/index.js +7 -1
  58. package/build/src/v1/project_service_client.d.ts +166 -76
  59. package/build/src/v1/project_service_client.js +235 -223
  60. package/build/src/v1/project_service_proto_list.json +6 -1
  61. package/build/src/v1/rank_service_client.d.ts +137 -47
  62. package/build/src/v1/rank_service_client.js +204 -85
  63. package/build/src/v1/rank_service_proto_list.json +6 -1
  64. package/build/src/v1/recommendation_service_client.d.ts +137 -47
  65. package/build/src/v1/recommendation_service_client.js +202 -82
  66. package/build/src/v1/recommendation_service_proto_list.json +6 -1
  67. package/build/src/v1/schema_service_client.d.ts +201 -111
  68. package/build/src/v1/schema_service_client.js +264 -274
  69. package/build/src/v1/schema_service_proto_list.json +6 -1
  70. package/build/src/v1/search_service_client.d.ts +661 -571
  71. package/build/src/v1/search_service_client.js +216 -113
  72. package/build/src/v1/search_service_proto_list.json +6 -1
  73. package/build/src/v1/search_tuning_service_client.d.ts +167 -77
  74. package/build/src/v1/search_tuning_service_client.js +246 -236
  75. package/build/src/v1/search_tuning_service_proto_list.json +6 -1
  76. package/build/src/v1/serving_config_service_client.d.ts +138 -48
  77. package/build/src/v1/serving_config_service_client.js +201 -80
  78. package/build/src/v1/serving_config_service_proto_list.json +6 -1
  79. package/build/src/v1/site_search_engine_service_client.d.ts +238 -148
  80. package/build/src/v1/site_search_engine_service_client.js +324 -379
  81. package/build/src/v1/site_search_engine_service_proto_list.json +6 -1
  82. package/build/src/v1/user_event_service_client.d.ts +167 -77
  83. package/build/src/v1/user_event_service_client.js +260 -254
  84. package/build/src/v1/user_event_service_proto_list.json +6 -1
  85. package/build/src/v1/user_license_service_client.d.ts +2256 -0
  86. package/build/src/v1/user_license_service_client.js +3194 -0
  87. package/build/src/v1/user_license_service_client_config.json +34 -0
  88. package/build/src/v1/user_license_service_proto_list.json +44 -0
  89. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  90. package/build/src/v1alpha/acl_config_service_client.js +94 -106
  91. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  92. package/build/src/v1alpha/chunk_service_client.js +98 -120
  93. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  94. package/build/src/v1alpha/completion_service_client.js +141 -281
  95. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  96. package/build/src/v1alpha/control_service_client.js +129 -151
  97. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  98. package/build/src/v1alpha/conversational_search_service_client.js +211 -237
  99. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  100. package/build/src/v1alpha/data_store_service_client.js +176 -317
  101. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  102. package/build/src/v1alpha/document_service_client.js +193 -329
  103. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  104. package/build/src/v1alpha/engine_service_client.js +180 -326
  105. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  106. package/build/src/v1alpha/estimate_billing_service_client.js +119 -244
  107. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  108. package/build/src/v1alpha/evaluation_service_client.js +150 -296
  109. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  110. package/build/src/v1alpha/grounded_generation_service_client.js +85 -100
  111. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  112. package/build/src/v1alpha/project_service_client.js +139 -263
  113. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  114. package/build/src/v1alpha/rank_service_client.js +87 -104
  115. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  116. package/build/src/v1alpha/recommendation_service_client.js +85 -100
  117. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  118. package/build/src/v1alpha/sample_query_service_client.js +169 -302
  119. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  120. package/build/src/v1alpha/sample_query_set_service_client.js +130 -153
  121. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  122. package/build/src/v1alpha/schema_service_client.js +147 -293
  123. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  124. package/build/src/v1alpha/search_service_client.js +88 -112
  125. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  126. package/build/src/v1alpha/search_tuning_service_client.js +129 -254
  127. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  128. package/build/src/v1alpha/serving_config_service_client.js +109 -133
  129. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  130. package/build/src/v1alpha/site_search_engine_service_client.js +203 -388
  131. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  132. package/build/src/v1alpha/user_event_service_client.js +143 -272
  133. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  134. package/build/src/v1beta/completion_service_client.js +149 -280
  135. package/build/src/v1beta/control_service_client.d.ts +84 -84
  136. package/build/src/v1beta/control_service_client.js +127 -147
  137. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  138. package/build/src/v1beta/conversational_search_service_client.js +209 -233
  139. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  140. package/build/src/v1beta/data_store_service_client.js +154 -289
  141. package/build/src/v1beta/document_service_client.d.ts +124 -124
  142. package/build/src/v1beta/document_service_client.js +181 -310
  143. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  144. package/build/src/v1beta/engine_service_client.js +178 -316
  145. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  146. package/build/src/v1beta/evaluation_service_client.js +148 -286
  147. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  148. package/build/src/v1beta/grounded_generation_service_client.js +98 -114
  149. package/build/src/v1beta/project_service_client.d.ts +76 -76
  150. package/build/src/v1beta/project_service_client.js +116 -232
  151. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  152. package/build/src/v1beta/rank_service_client.js +85 -99
  153. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  154. package/build/src/v1beta/recommendation_service_client.js +83 -96
  155. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  156. package/build/src/v1beta/sample_query_service_client.js +167 -292
  157. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  158. package/build/src/v1beta/sample_query_set_service_client.js +128 -149
  159. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  160. package/build/src/v1beta/schema_service_client.js +145 -283
  161. package/build/src/v1beta/search_service_client.d.ts +665 -665
  162. package/build/src/v1beta/search_service_client.js +97 -128
  163. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  164. package/build/src/v1beta/search_tuning_service_client.js +127 -244
  165. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  166. package/build/src/v1beta/serving_config_service_client.js +107 -129
  167. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  168. package/build/src/v1beta/site_search_engine_service_client.js +205 -387
  169. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  170. package/build/src/v1beta/user_event_service_client.js +141 -262
  171. package/package.json +7 -7
  172. package/CHANGELOG.md +0 -267
@@ -159,61 +159,61 @@ export declare class GroundedGenerationServiceClient {
159
159
  */
160
160
  checkGrounding(request?: protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingRequest, options?: CallOptions): Promise<[
161
161
  protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingResponse,
162
- (protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingRequest | undefined),
162
+ protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingRequest | undefined,
163
163
  {} | undefined
164
164
  ]>;
165
165
  checkGrounding(request: protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingResponse, protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingRequest | null | undefined, {} | null | undefined>): void;
166
166
  checkGrounding(request: protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingResponse, protos.google.cloud.discoveryengine.v1alpha.ICheckGroundingRequest | null | undefined, {} | null | undefined>): void;
167
167
  /**
168
- * Gets information about a location.
169
- *
170
- * @param {Object} request
171
- * The request object that will be sent.
172
- * @param {string} request.name
173
- * Resource name for the location.
174
- * @param {object} [options]
175
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
176
- * @returns {Promise} - The promise which resolves to an array.
177
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
178
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
179
- * for more details and examples.
180
- * @example
181
- * ```
182
- * const [response] = await client.getLocation(request);
183
- * ```
184
- */
168
+ * Gets information about a location.
169
+ *
170
+ * @param {Object} request
171
+ * The request object that will be sent.
172
+ * @param {string} request.name
173
+ * Resource name for the location.
174
+ * @param {object} [options]
175
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
176
+ * @returns {Promise} - The promise which resolves to an array.
177
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
178
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
179
+ * for more details and examples.
180
+ * @example
181
+ * ```
182
+ * const [response] = await client.getLocation(request);
183
+ * ```
184
+ */
185
185
  getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
186
186
  /**
187
- * Lists information about the supported locations for this service. Returns an iterable object.
188
- *
189
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
190
- * @param {Object} request
191
- * The request object that will be sent.
192
- * @param {string} request.name
193
- * The resource that owns the locations collection, if applicable.
194
- * @param {string} request.filter
195
- * The standard list filter.
196
- * @param {number} request.pageSize
197
- * The standard list page size.
198
- * @param {string} request.pageToken
199
- * The standard list page token.
200
- * @param {object} [options]
201
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
202
- * @returns {Object}
203
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
204
- * When you iterate the returned iterable, each element will be an object representing
205
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
206
- * so you can stop the iteration when you don't need more results.
207
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
208
- * for more details and examples.
209
- * @example
210
- * ```
211
- * const iterable = client.listLocationsAsync(request);
212
- * for await (const response of iterable) {
213
- * // process response
214
- * }
215
- * ```
216
- */
187
+ * Lists information about the supported locations for this service. Returns an iterable object.
188
+ *
189
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
190
+ * @param {Object} request
191
+ * The request object that will be sent.
192
+ * @param {string} request.name
193
+ * The resource that owns the locations collection, if applicable.
194
+ * @param {string} request.filter
195
+ * The standard list filter.
196
+ * @param {number} request.pageSize
197
+ * The standard list page size.
198
+ * @param {string} request.pageToken
199
+ * The standard list page token.
200
+ * @param {object} [options]
201
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
202
+ * @returns {Object}
203
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
204
+ * When you iterate the returned iterable, each element will be an object representing
205
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
206
+ * so you can stop the iteration when you don't need more results.
207
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
208
+ * for more details and examples.
209
+ * @example
210
+ * ```
211
+ * const iterable = client.listLocationsAsync(request);
212
+ * for await (const response of iterable) {
213
+ * // process response
214
+ * }
215
+ * ```
216
+ */
217
217
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
218
218
  /**
219
219
  * Return a fully-qualified aclConfig resource name string.
@@ -96,28 +96,18 @@ class GroundedGenerationServiceClient {
96
96
  */
97
97
  constructor(opts, gaxInstance) {
98
98
  // Ensure that options include all the required fields.
99
- const staticMembers = this
100
- .constructor;
101
- if (opts?.universe_domain &&
102
- opts?.universeDomain &&
103
- opts?.universe_domain !== opts?.universeDomain) {
99
+ const staticMembers = this.constructor;
100
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
104
101
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
105
102
  }
106
- const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
107
- ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
108
- : undefined;
109
- this._universeDomain =
110
- opts?.universeDomain ??
111
- opts?.universe_domain ??
112
- universeDomainEnvVar ??
113
- 'googleapis.com';
103
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
104
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
114
105
  this._servicePath = 'discoveryengine.' + this._universeDomain;
115
106
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
116
107
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
117
108
  const port = opts?.port || staticMembers.port;
118
109
  const clientConfig = opts?.clientConfig ?? {};
119
- const fallback = opts?.fallback ??
120
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
110
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
121
111
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
122
112
  // Request numeric enum values if REST transport is used.
123
113
  opts.numericEnums = true;
@@ -147,7 +137,10 @@ class GroundedGenerationServiceClient {
147
137
  }
148
138
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
149
139
  // Determine the client header string.
150
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
140
+ const clientHeader = [
141
+ `gax/${this._gaxModule.version}`,
142
+ `gapic/${version}`,
143
+ ];
151
144
  if (typeof process === 'object' && 'versions' in process) {
152
145
  clientHeader.push(`gl-node/${process.versions.node}`);
153
146
  }
@@ -235,11 +228,10 @@ class GroundedGenerationServiceClient {
235
228
  }
236
229
  // Put together the "service stub" for
237
230
  // google.cloud.discoveryengine.v1alpha.GroundedGenerationService.
238
- this.groundedGenerationServiceStub = this._gaxGrpc.createStub(this._opts.fallback
239
- ? this._protos.lookupService('google.cloud.discoveryengine.v1alpha.GroundedGenerationService')
240
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
241
- this._protos.google.cloud.discoveryengine.v1alpha
242
- .GroundedGenerationService, this._opts, this._providedCustomServicePath);
231
+ this.groundedGenerationServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
232
+ this._protos.lookupService('google.cloud.discoveryengine.v1alpha.GroundedGenerationService') :
233
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
234
+ this._protos.google.cloud.discoveryengine.v1alpha.GroundedGenerationService, this._opts, this._providedCustomServicePath);
243
235
  // Iterate over each of the methods that the service provides
244
236
  // and create an API call method for each.
245
237
  const groundedGenerationServiceStubMethods = ['checkGrounding'];
@@ -265,8 +257,7 @@ class GroundedGenerationServiceClient {
265
257
  * @returns {string} The DNS address for this service.
266
258
  */
267
259
  static get servicePath() {
268
- if (typeof process === 'object' &&
269
- typeof process.emitWarning === 'function') {
260
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
270
261
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
271
262
  }
272
263
  return 'discoveryengine.googleapis.com';
@@ -277,8 +268,7 @@ class GroundedGenerationServiceClient {
277
268
  * @returns {string} The DNS address for this service.
278
269
  */
279
270
  static get apiEndpoint() {
280
- if (typeof process === 'object' &&
281
- typeof process.emitWarning === 'function') {
271
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
282
272
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
283
273
  }
284
274
  return 'discoveryengine.googleapis.com';
@@ -306,7 +296,9 @@ class GroundedGenerationServiceClient {
306
296
  * @returns {string[]} List of default scopes.
307
297
  */
308
298
  static get scopes() {
309
- return ['https://www.googleapis.com/auth/cloud-platform'];
299
+ return [
300
+ 'https://www.googleapis.com/auth/cloud-platform'
301
+ ];
310
302
  }
311
303
  /**
312
304
  * Return the project ID used by this class.
@@ -332,13 +324,10 @@ class GroundedGenerationServiceClient {
332
324
  options = options || {};
333
325
  options.otherArgs = options.otherArgs || {};
334
326
  options.otherArgs.headers = options.otherArgs.headers || {};
335
- options.otherArgs.headers['x-goog-request-params'] =
336
- this._gaxModule.routingHeader.fromParams({
337
- grounding_config: request.groundingConfig ?? '',
338
- });
339
- this.initialize().catch(err => {
340
- throw err;
327
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
328
+ 'grounding_config': request.groundingConfig ?? '',
341
329
  });
330
+ this.initialize().catch(err => { throw err; });
342
331
  this._log.info('checkGrounding request %j', request);
343
332
  const wrappedCallback = callback
344
333
  ? (error, response, options, rawResponse) => {
@@ -346,65 +335,70 @@ class GroundedGenerationServiceClient {
346
335
  callback(error, response, options, rawResponse); // We verified callback above.
347
336
  }
348
337
  : undefined;
349
- return this.innerApiCalls
350
- .checkGrounding(request, options, wrappedCallback)
338
+ return this.innerApiCalls.checkGrounding(request, options, wrappedCallback)
351
339
  ?.then(([response, options, rawResponse]) => {
352
340
  this._log.info('checkGrounding response %j', response);
353
341
  return [response, options, rawResponse];
342
+ }).catch((error) => {
343
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
344
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
345
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
346
+ }
347
+ throw error;
354
348
  });
355
349
  }
356
350
  /**
357
- * Gets information about a location.
358
- *
359
- * @param {Object} request
360
- * The request object that will be sent.
361
- * @param {string} request.name
362
- * Resource name for the location.
363
- * @param {object} [options]
364
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
365
- * @returns {Promise} - The promise which resolves to an array.
366
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
367
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
368
- * for more details and examples.
369
- * @example
370
- * ```
371
- * const [response] = await client.getLocation(request);
372
- * ```
373
- */
351
+ * Gets information about a location.
352
+ *
353
+ * @param {Object} request
354
+ * The request object that will be sent.
355
+ * @param {string} request.name
356
+ * Resource name for the location.
357
+ * @param {object} [options]
358
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
359
+ * @returns {Promise} - The promise which resolves to an array.
360
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
361
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
362
+ * for more details and examples.
363
+ * @example
364
+ * ```
365
+ * const [response] = await client.getLocation(request);
366
+ * ```
367
+ */
374
368
  getLocation(request, options, callback) {
375
369
  return this.locationsClient.getLocation(request, options, callback);
376
370
  }
377
371
  /**
378
- * Lists information about the supported locations for this service. Returns an iterable object.
379
- *
380
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
381
- * @param {Object} request
382
- * The request object that will be sent.
383
- * @param {string} request.name
384
- * The resource that owns the locations collection, if applicable.
385
- * @param {string} request.filter
386
- * The standard list filter.
387
- * @param {number} request.pageSize
388
- * The standard list page size.
389
- * @param {string} request.pageToken
390
- * The standard list page token.
391
- * @param {object} [options]
392
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
393
- * @returns {Object}
394
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
395
- * When you iterate the returned iterable, each element will be an object representing
396
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
397
- * so you can stop the iteration when you don't need more results.
398
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
399
- * for more details and examples.
400
- * @example
401
- * ```
402
- * const iterable = client.listLocationsAsync(request);
403
- * for await (const response of iterable) {
404
- * // process response
405
- * }
406
- * ```
407
- */
372
+ * Lists information about the supported locations for this service. Returns an iterable object.
373
+ *
374
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
375
+ * @param {Object} request
376
+ * The request object that will be sent.
377
+ * @param {string} request.name
378
+ * The resource that owns the locations collection, if applicable.
379
+ * @param {string} request.filter
380
+ * The standard list filter.
381
+ * @param {number} request.pageSize
382
+ * The standard list page size.
383
+ * @param {string} request.pageToken
384
+ * The standard list page token.
385
+ * @param {object} [options]
386
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
387
+ * @returns {Object}
388
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
389
+ * When you iterate the returned iterable, each element will be an object representing
390
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
391
+ * so you can stop the iteration when you don't need more results.
392
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
393
+ * for more details and examples.
394
+ * @example
395
+ * ```
396
+ * const iterable = client.listLocationsAsync(request);
397
+ * for await (const response of iterable) {
398
+ * // process response
399
+ * }
400
+ * ```
401
+ */
408
402
  listLocationsAsync(request, options) {
409
403
  return this.locationsClient.listLocationsAsync(request, options);
410
404
  }
@@ -432,8 +426,7 @@ class GroundedGenerationServiceClient {
432
426
  * @returns {string} A string representing the project.
433
427
  */
434
428
  matchProjectFromAclConfigName(aclConfigName) {
435
- return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
436
- .project;
429
+ return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).project;
437
430
  }
438
431
  /**
439
432
  * Parse the location from AclConfig resource.
@@ -443,8 +436,7 @@ class GroundedGenerationServiceClient {
443
436
  * @returns {string} A string representing the location.
444
437
  */
445
438
  matchLocationFromAclConfigName(aclConfigName) {
446
- return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
447
- .location;
439
+ return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).location;
448
440
  }
449
441
  /**
450
442
  * Return a fully-qualified engine resource name string.
@@ -526,8 +518,7 @@ class GroundedGenerationServiceClient {
526
518
  * @returns {string} A string representing the project.
527
519
  */
528
520
  matchProjectFromEvaluationName(evaluationName) {
529
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
530
- .project;
521
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).project;
531
522
  }
532
523
  /**
533
524
  * Parse the location from Evaluation resource.
@@ -537,8 +528,7 @@ class GroundedGenerationServiceClient {
537
528
  * @returns {string} A string representing the location.
538
529
  */
539
530
  matchLocationFromEvaluationName(evaluationName) {
540
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
541
- .location;
531
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).location;
542
532
  }
543
533
  /**
544
534
  * Parse the evaluation from Evaluation resource.
@@ -548,8 +538,7 @@ class GroundedGenerationServiceClient {
548
538
  * @returns {string} A string representing the evaluation.
549
539
  */
550
540
  matchEvaluationFromEvaluationName(evaluationName) {
551
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
552
- .evaluation;
541
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).evaluation;
553
542
  }
554
543
  /**
555
544
  * Return a fully-qualified groundingConfig resource name string.
@@ -2661,8 +2650,7 @@ class GroundedGenerationServiceClient {
2661
2650
  * @returns {string} A string representing the project.
2662
2651
  */
2663
2652
  matchProjectFromSampleQueryName(sampleQueryName) {
2664
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2665
- .project;
2653
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).project;
2666
2654
  }
2667
2655
  /**
2668
2656
  * Parse the location from SampleQuery resource.
@@ -2672,8 +2660,7 @@ class GroundedGenerationServiceClient {
2672
2660
  * @returns {string} A string representing the location.
2673
2661
  */
2674
2662
  matchLocationFromSampleQueryName(sampleQueryName) {
2675
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2676
- .location;
2663
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).location;
2677
2664
  }
2678
2665
  /**
2679
2666
  * Parse the sample_query_set from SampleQuery resource.
@@ -2683,8 +2670,7 @@ class GroundedGenerationServiceClient {
2683
2670
  * @returns {string} A string representing the sample_query_set.
2684
2671
  */
2685
2672
  matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2686
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2687
- .sample_query_set;
2673
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query_set;
2688
2674
  }
2689
2675
  /**
2690
2676
  * Parse the sample_query from SampleQuery resource.
@@ -2694,8 +2680,7 @@ class GroundedGenerationServiceClient {
2694
2680
  * @returns {string} A string representing the sample_query.
2695
2681
  */
2696
2682
  matchSampleQueryFromSampleQueryName(sampleQueryName) {
2697
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2698
- .sample_query;
2683
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query;
2699
2684
  }
2700
2685
  /**
2701
2686
  * Return a fully-qualified sampleQuerySet resource name string.
@@ -2754,7 +2739,7 @@ class GroundedGenerationServiceClient {
2754
2739
  this._log.info('ending gRPC channel');
2755
2740
  this._terminated = true;
2756
2741
  stub.close();
2757
- this.locationsClient.close();
2742
+ this.locationsClient.close().catch(err => { throw err; });
2758
2743
  });
2759
2744
  }
2760
2745
  return Promise.resolve();
@@ -138,7 +138,7 @@ export declare class ProjectServiceClient {
138
138
  */
139
139
  getProject(request?: protos.google.cloud.discoveryengine.v1alpha.IGetProjectRequest, options?: CallOptions): Promise<[
140
140
  protos.google.cloud.discoveryengine.v1alpha.IProject,
141
- (protos.google.cloud.discoveryengine.v1alpha.IGetProjectRequest | undefined),
141
+ protos.google.cloud.discoveryengine.v1alpha.IGetProjectRequest | undefined,
142
142
  {} | undefined
143
143
  ]>;
144
144
  getProject(request: protos.google.cloud.discoveryengine.v1alpha.IGetProjectRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProject, protos.google.cloud.discoveryengine.v1alpha.IGetProjectRequest | null | undefined, {} | null | undefined>): void;
@@ -184,7 +184,7 @@ export declare class ProjectServiceClient {
184
184
  */
185
185
  reportConsentChange(request?: protos.google.cloud.discoveryengine.v1alpha.IReportConsentChangeRequest, options?: CallOptions): Promise<[
186
186
  protos.google.cloud.discoveryengine.v1alpha.IProject,
187
- (protos.google.cloud.discoveryengine.v1alpha.IReportConsentChangeRequest | undefined),
187
+ protos.google.cloud.discoveryengine.v1alpha.IReportConsentChangeRequest | undefined,
188
188
  {} | undefined
189
189
  ]>;
190
190
  reportConsentChange(request: protos.google.cloud.discoveryengine.v1alpha.IReportConsentChangeRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProject, protos.google.cloud.discoveryengine.v1alpha.IReportConsentChangeRequest | null | undefined, {} | null | undefined>): void;
@@ -244,86 +244,86 @@ export declare class ProjectServiceClient {
244
244
  */
245
245
  checkProvisionProjectProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Project, protos.google.cloud.discoveryengine.v1alpha.ProvisionProjectMetadata>>;
246
246
  /**
247
- * Gets information about a location.
248
- *
249
- * @param {Object} request
250
- * The request object that will be sent.
251
- * @param {string} request.name
252
- * Resource name for the location.
253
- * @param {object} [options]
254
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
255
- * @returns {Promise} - The promise which resolves to an array.
256
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
257
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
258
- * for more details and examples.
259
- * @example
260
- * ```
261
- * const [response] = await client.getLocation(request);
262
- * ```
263
- */
247
+ * Gets information about a location.
248
+ *
249
+ * @param {Object} request
250
+ * The request object that will be sent.
251
+ * @param {string} request.name
252
+ * Resource name for the location.
253
+ * @param {object} [options]
254
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
255
+ * @returns {Promise} - The promise which resolves to an array.
256
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
257
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
258
+ * for more details and examples.
259
+ * @example
260
+ * ```
261
+ * const [response] = await client.getLocation(request);
262
+ * ```
263
+ */
264
264
  getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
265
265
  /**
266
- * Lists information about the supported locations for this service. Returns an iterable object.
267
- *
268
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
269
- * @param {Object} request
270
- * The request object that will be sent.
271
- * @param {string} request.name
272
- * The resource that owns the locations collection, if applicable.
273
- * @param {string} request.filter
274
- * The standard list filter.
275
- * @param {number} request.pageSize
276
- * The standard list page size.
277
- * @param {string} request.pageToken
278
- * The standard list page token.
279
- * @param {object} [options]
280
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
281
- * @returns {Object}
282
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
283
- * When you iterate the returned iterable, each element will be an object representing
284
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
285
- * so you can stop the iteration when you don't need more results.
286
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
287
- * for more details and examples.
288
- * @example
289
- * ```
290
- * const iterable = client.listLocationsAsync(request);
291
- * for await (const response of iterable) {
292
- * // process response
293
- * }
294
- * ```
295
- */
266
+ * Lists information about the supported locations for this service. Returns an iterable object.
267
+ *
268
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
269
+ * @param {Object} request
270
+ * The request object that will be sent.
271
+ * @param {string} request.name
272
+ * The resource that owns the locations collection, if applicable.
273
+ * @param {string} request.filter
274
+ * The standard list filter.
275
+ * @param {number} request.pageSize
276
+ * The standard list page size.
277
+ * @param {string} request.pageToken
278
+ * The standard list page token.
279
+ * @param {object} [options]
280
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
281
+ * @returns {Object}
282
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
283
+ * When you iterate the returned iterable, each element will be an object representing
284
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
285
+ * so you can stop the iteration when you don't need more results.
286
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
287
+ * for more details and examples.
288
+ * @example
289
+ * ```
290
+ * const iterable = client.listLocationsAsync(request);
291
+ * for await (const response of iterable) {
292
+ * // process response
293
+ * }
294
+ * ```
295
+ */
296
296
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
297
297
  /**
298
- * Gets the latest state of a long-running operation. Clients can use this
299
- * method to poll the operation result at intervals as recommended by the API
300
- * service.
301
- *
302
- * @param {Object} request - The request object that will be sent.
303
- * @param {string} request.name - The name of the operation resource.
304
- * @param {Object=} options
305
- * Optional parameters. You can override the default settings for this call,
306
- * e.g, timeout, retries, paginations, etc. See {@link
307
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
308
- * for the details.
309
- * @param {function(?Error, ?Object)=} callback
310
- * The function which will be called with the result of the API call.
311
- *
312
- * The second parameter to the callback is an object representing
313
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
314
- * @return {Promise} - The promise which resolves to an array.
315
- * The first element of the array is an object representing
316
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
317
- * The promise has a method named "cancel" which cancels the ongoing API call.
318
- *
319
- * @example
320
- * ```
321
- * const client = longrunning.operationsClient();
322
- * const name = '';
323
- * const [response] = await client.getOperation({name});
324
- * // doThingsWith(response)
325
- * ```
326
- */
298
+ * Gets the latest state of a long-running operation. Clients can use this
299
+ * method to poll the operation result at intervals as recommended by the API
300
+ * service.
301
+ *
302
+ * @param {Object} request - The request object that will be sent.
303
+ * @param {string} request.name - The name of the operation resource.
304
+ * @param {Object=} options
305
+ * Optional parameters. You can override the default settings for this call,
306
+ * e.g, timeout, retries, paginations, etc. See {@link
307
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
308
+ * for the details.
309
+ * @param {function(?Error, ?Object)=} callback
310
+ * The function which will be called with the result of the API call.
311
+ *
312
+ * The second parameter to the callback is an object representing
313
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
314
+ * @return {Promise} - The promise which resolves to an array.
315
+ * The first element of the array is an object representing
316
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
317
+ * The promise has a method named "cancel" which cancels the ongoing API call.
318
+ *
319
+ * @example
320
+ * ```
321
+ * const client = longrunning.operationsClient();
322
+ * const name = '';
323
+ * const [response] = await client.getOperation({name});
324
+ * // doThingsWith(response)
325
+ * ```
326
+ */
327
327
  getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
328
328
  /**
329
329
  * Lists operations that match the specified filter in the request. If the