@google-cloud/discoveryengine 2.0.1 → 2.2.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 (167) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +7 -2
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +54 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +2 -1
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +35 -6
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +113 -2
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +168 -2
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +23 -4
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +7 -2
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +16 -3
  12. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +70 -9
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +20 -1
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +9 -5
  15. package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +3 -1
  16. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -2
  17. package/build/protos/google/cloud/discoveryengine/v1/safety.proto +107 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +96 -8
  19. package/build/protos/google/cloud/discoveryengine/v1/serving_config.proto +271 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/serving_config_service.proto +75 -0
  21. package/build/protos/google/cloud/discoveryengine/v1/session.proto +19 -0
  22. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +27 -3
  23. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +184 -5
  24. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +34 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +16 -4
  26. package/build/protos/protos.d.ts +4390 -300
  27. package/build/protos/protos.js +13785 -2922
  28. package/build/protos/protos.json +1355 -14
  29. package/build/src/index.d.ts +4 -1
  30. package/build/src/index.js +4 -21
  31. package/build/src/v1/completion_service_client.d.ts +313 -76
  32. package/build/src/v1/completion_service_client.js +451 -262
  33. package/build/src/v1/completion_service_proto_list.json +3 -0
  34. package/build/src/v1/control_service_client.d.ts +318 -81
  35. package/build/src/v1/control_service_client.js +422 -132
  36. package/build/src/v1/control_service_proto_list.json +3 -0
  37. package/build/src/v1/conversational_search_service_client.d.ts +341 -134
  38. package/build/src/v1/conversational_search_service_client.js +395 -223
  39. package/build/src/v1/conversational_search_service_client_config.json +5 -0
  40. package/build/src/v1/conversational_search_service_proto_list.json +3 -0
  41. package/build/src/v1/data_store_service_client.d.ts +359 -122
  42. package/build/src/v1/data_store_service_client.js +460 -280
  43. package/build/src/v1/data_store_service_proto_list.json +3 -0
  44. package/build/src/v1/document_service_client.d.ts +364 -121
  45. package/build/src/v1/document_service_client.js +469 -300
  46. package/build/src/v1/document_service_proto_list.json +3 -0
  47. package/build/src/v1/engine_service_client.d.ts +340 -103
  48. package/build/src/v1/engine_service_client.js +460 -279
  49. package/build/src/v1/engine_service_proto_list.json +3 -0
  50. package/build/src/v1/gapic_metadata.json +59 -0
  51. package/build/src/v1/grounded_generation_service_client.d.ts +286 -51
  52. package/build/src/v1/grounded_generation_service_client.js +405 -100
  53. package/build/src/v1/grounded_generation_service_proto_list.json +3 -0
  54. package/build/src/v1/index.d.ts +1 -0
  55. package/build/src/v1/index.js +3 -1
  56. package/build/src/v1/project_service_client.d.ts +313 -76
  57. package/build/src/v1/project_service_client.js +434 -222
  58. package/build/src/v1/project_service_proto_list.json +3 -0
  59. package/build/src/v1/rank_service_client.d.ts +285 -48
  60. package/build/src/v1/rank_service_client.js +398 -85
  61. package/build/src/v1/rank_service_proto_list.json +3 -0
  62. package/build/src/v1/recommendation_service_client.d.ts +142 -49
  63. package/build/src/v1/recommendation_service_client.js +198 -82
  64. package/build/src/v1/recommendation_service_proto_list.json +3 -0
  65. package/build/src/v1/schema_service_client.d.ts +348 -111
  66. package/build/src/v1/schema_service_client.js +457 -273
  67. package/build/src/v1/schema_service_proto_list.json +3 -0
  68. package/build/src/v1/search_service_client.d.ts +748 -559
  69. package/build/src/v1/search_service_client.js +302 -133
  70. package/build/src/v1/search_service_proto_list.json +3 -0
  71. package/build/src/v1/search_tuning_service_client.d.ts +314 -77
  72. package/build/src/v1/search_tuning_service_client.js +439 -235
  73. package/build/src/v1/search_tuning_service_proto_list.json +3 -0
  74. package/build/src/v1/serving_config_service_client.d.ts +1851 -0
  75. package/build/src/v1/serving_config_service_client.js +2642 -0
  76. package/build/src/v1/serving_config_service_client_config.json +30 -0
  77. package/build/src/v1/serving_config_service_proto_list.json +39 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +504 -151
  79. package/build/src/v1/site_search_engine_service_client.js +625 -351
  80. package/build/src/v1/site_search_engine_service_client_config.json +12 -0
  81. package/build/src/v1/site_search_engine_service_proto_list.json +3 -0
  82. package/build/src/v1/user_event_service_client.d.ts +335 -86
  83. package/build/src/v1/user_event_service_client.js +447 -253
  84. package/build/src/v1/user_event_service_proto_list.json +3 -0
  85. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  86. package/build/src/v1alpha/acl_config_service_client.js +82 -106
  87. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  88. package/build/src/v1alpha/chunk_service_client.js +92 -120
  89. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  90. package/build/src/v1alpha/completion_service_client.js +134 -280
  91. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  92. package/build/src/v1alpha/control_service_client.js +105 -151
  93. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  94. package/build/src/v1alpha/conversational_search_service_client.js +145 -237
  95. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  96. package/build/src/v1alpha/data_store_service_client.js +151 -316
  97. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  98. package/build/src/v1alpha/document_service_client.js +156 -328
  99. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  100. package/build/src/v1alpha/engine_service_client.js +155 -325
  101. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  102. package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
  103. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  104. package/build/src/v1alpha/evaluation_service_client.js +143 -295
  105. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  106. package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
  107. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  108. package/build/src/v1alpha/project_service_client.js +126 -262
  109. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  110. package/build/src/v1alpha/rank_service_client.js +81 -104
  111. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  112. package/build/src/v1alpha/recommendation_service_client.js +79 -100
  113. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  114. package/build/src/v1alpha/sample_query_service_client.js +144 -301
  115. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  116. package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
  117. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  118. package/build/src/v1alpha/schema_service_client.js +140 -292
  119. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  120. package/build/src/v1alpha/search_service_client.js +88 -112
  121. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  122. package/build/src/v1alpha/search_tuning_service_client.js +122 -253
  123. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  124. package/build/src/v1alpha/serving_config_service_client.js +97 -133
  125. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  126. package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
  127. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  128. package/build/src/v1alpha/user_event_service_client.js +130 -271
  129. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  130. package/build/src/v1beta/completion_service_client.js +136 -279
  131. package/build/src/v1beta/control_service_client.d.ts +84 -84
  132. package/build/src/v1beta/control_service_client.js +103 -147
  133. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  134. package/build/src/v1beta/conversational_search_service_client.js +143 -233
  135. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  136. package/build/src/v1beta/data_store_service_client.js +141 -288
  137. package/build/src/v1beta/document_service_client.d.ts +124 -124
  138. package/build/src/v1beta/document_service_client.js +150 -309
  139. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  140. package/build/src/v1beta/engine_service_client.js +153 -315
  141. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  142. package/build/src/v1beta/evaluation_service_client.js +141 -285
  143. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  144. package/build/src/v1beta/grounded_generation_service_client.js +86 -114
  145. package/build/src/v1beta/project_service_client.d.ts +76 -76
  146. package/build/src/v1beta/project_service_client.js +115 -231
  147. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  148. package/build/src/v1beta/rank_service_client.js +79 -99
  149. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  150. package/build/src/v1beta/recommendation_service_client.js +77 -96
  151. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  152. package/build/src/v1beta/sample_query_service_client.js +142 -291
  153. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  154. package/build/src/v1beta/sample_query_set_service_client.js +104 -149
  155. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  156. package/build/src/v1beta/schema_service_client.js +138 -282
  157. package/build/src/v1beta/search_service_client.d.ts +665 -665
  158. package/build/src/v1beta/search_service_client.js +97 -128
  159. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  160. package/build/src/v1beta/search_tuning_service_client.js +120 -243
  161. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  162. package/build/src/v1beta/serving_config_service_client.js +95 -129
  163. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  164. package/build/src/v1beta/site_search_engine_service_client.js +186 -386
  165. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  166. package/build/src/v1beta/user_event_service_client.js +128 -261
  167. package/package.json +4 -4
@@ -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,64 @@ 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];
354
342
  });
355
343
  }
356
344
  /**
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
- */
345
+ * Gets information about a location.
346
+ *
347
+ * @param {Object} request
348
+ * The request object that will be sent.
349
+ * @param {string} request.name
350
+ * Resource name for the location.
351
+ * @param {object} [options]
352
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
353
+ * @returns {Promise} - The promise which resolves to an array.
354
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
355
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
356
+ * for more details and examples.
357
+ * @example
358
+ * ```
359
+ * const [response] = await client.getLocation(request);
360
+ * ```
361
+ */
374
362
  getLocation(request, options, callback) {
375
363
  return this.locationsClient.getLocation(request, options, callback);
376
364
  }
377
365
  /**
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
- */
366
+ * Lists information about the supported locations for this service. Returns an iterable object.
367
+ *
368
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
369
+ * @param {Object} request
370
+ * The request object that will be sent.
371
+ * @param {string} request.name
372
+ * The resource that owns the locations collection, if applicable.
373
+ * @param {string} request.filter
374
+ * The standard list filter.
375
+ * @param {number} request.pageSize
376
+ * The standard list page size.
377
+ * @param {string} request.pageToken
378
+ * The standard list page token.
379
+ * @param {object} [options]
380
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
381
+ * @returns {Object}
382
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
383
+ * When you iterate the returned iterable, each element will be an object representing
384
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
385
+ * so you can stop the iteration when you don't need more results.
386
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
387
+ * for more details and examples.
388
+ * @example
389
+ * ```
390
+ * const iterable = client.listLocationsAsync(request);
391
+ * for await (const response of iterable) {
392
+ * // process response
393
+ * }
394
+ * ```
395
+ */
408
396
  listLocationsAsync(request, options) {
409
397
  return this.locationsClient.listLocationsAsync(request, options);
410
398
  }
@@ -432,8 +420,7 @@ class GroundedGenerationServiceClient {
432
420
  * @returns {string} A string representing the project.
433
421
  */
434
422
  matchProjectFromAclConfigName(aclConfigName) {
435
- return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
436
- .project;
423
+ return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).project;
437
424
  }
438
425
  /**
439
426
  * Parse the location from AclConfig resource.
@@ -443,8 +430,7 @@ class GroundedGenerationServiceClient {
443
430
  * @returns {string} A string representing the location.
444
431
  */
445
432
  matchLocationFromAclConfigName(aclConfigName) {
446
- return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
447
- .location;
433
+ return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).location;
448
434
  }
449
435
  /**
450
436
  * Return a fully-qualified engine resource name string.
@@ -526,8 +512,7 @@ class GroundedGenerationServiceClient {
526
512
  * @returns {string} A string representing the project.
527
513
  */
528
514
  matchProjectFromEvaluationName(evaluationName) {
529
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
530
- .project;
515
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).project;
531
516
  }
532
517
  /**
533
518
  * Parse the location from Evaluation resource.
@@ -537,8 +522,7 @@ class GroundedGenerationServiceClient {
537
522
  * @returns {string} A string representing the location.
538
523
  */
539
524
  matchLocationFromEvaluationName(evaluationName) {
540
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
541
- .location;
525
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).location;
542
526
  }
543
527
  /**
544
528
  * Parse the evaluation from Evaluation resource.
@@ -548,8 +532,7 @@ class GroundedGenerationServiceClient {
548
532
  * @returns {string} A string representing the evaluation.
549
533
  */
550
534
  matchEvaluationFromEvaluationName(evaluationName) {
551
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
552
- .evaluation;
535
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).evaluation;
553
536
  }
554
537
  /**
555
538
  * Return a fully-qualified groundingConfig resource name string.
@@ -2661,8 +2644,7 @@ class GroundedGenerationServiceClient {
2661
2644
  * @returns {string} A string representing the project.
2662
2645
  */
2663
2646
  matchProjectFromSampleQueryName(sampleQueryName) {
2664
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2665
- .project;
2647
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).project;
2666
2648
  }
2667
2649
  /**
2668
2650
  * Parse the location from SampleQuery resource.
@@ -2672,8 +2654,7 @@ class GroundedGenerationServiceClient {
2672
2654
  * @returns {string} A string representing the location.
2673
2655
  */
2674
2656
  matchLocationFromSampleQueryName(sampleQueryName) {
2675
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2676
- .location;
2657
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).location;
2677
2658
  }
2678
2659
  /**
2679
2660
  * Parse the sample_query_set from SampleQuery resource.
@@ -2683,8 +2664,7 @@ class GroundedGenerationServiceClient {
2683
2664
  * @returns {string} A string representing the sample_query_set.
2684
2665
  */
2685
2666
  matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2686
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2687
- .sample_query_set;
2667
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query_set;
2688
2668
  }
2689
2669
  /**
2690
2670
  * Parse the sample_query from SampleQuery resource.
@@ -2694,8 +2674,7 @@ class GroundedGenerationServiceClient {
2694
2674
  * @returns {string} A string representing the sample_query.
2695
2675
  */
2696
2676
  matchSampleQueryFromSampleQueryName(sampleQueryName) {
2697
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2698
- .sample_query;
2677
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query;
2699
2678
  }
2700
2679
  /**
2701
2680
  * Return a fully-qualified sampleQuerySet resource name string.
@@ -2754,7 +2733,7 @@ class GroundedGenerationServiceClient {
2754
2733
  this._log.info('ending gRPC channel');
2755
2734
  this._terminated = true;
2756
2735
  stub.close();
2757
- this.locationsClient.close();
2736
+ this.locationsClient.close().catch(err => { throw err; });
2758
2737
  });
2759
2738
  }
2760
2739
  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