@google-cloud/discoveryengine 0.7.0 → 1.0.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.
- package/CHANGELOG.md +24 -0
- package/README.md +6 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +1 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +131 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +281 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +6 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +26 -22
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +193 -47
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +41 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +6529 -4472
- package/build/protos/protos.js +16561 -11622
- package/build/protos/protos.json +1842 -1317
- package/build/src/v1/completion_service_client.d.ts +6 -7
- package/build/src/v1/document_service_client.d.ts +83 -94
- package/build/src/v1/document_service_client.js +18 -22
- package/build/src/v1/schema_service_client.d.ts +39 -49
- package/build/src/v1/schema_service_client.js +17 -22
- package/build/src/v1/search_service_client.d.ts +31 -34
- package/build/src/v1/search_service_client.js +21 -23
- package/build/src/v1/user_event_service_client.d.ts +6 -10
- package/build/src/v1/user_event_service_client.js +1 -2
- package/build/src/v1beta/completion_service_client.d.ts +106 -8
- package/build/src/v1beta/completion_service_client.js +128 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +876 -0
- package/build/src/v1beta/conversational_search_service_client.js +1149 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +183 -98
- package/build/src/v1beta/document_service_client.js +166 -22
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +103 -11
- package/build/src/v1beta/recommendation_service_client.js +128 -0
- package/build/src/v1beta/schema_service_client.d.ts +132 -49
- package/build/src/v1beta/schema_service_client.js +163 -22
- package/build/src/v1beta/search_service_client.d.ts +163 -67
- package/build/src/v1beta/search_service_client.js +175 -45
- package/build/src/v1beta/user_event_service_client.d.ts +104 -15
- package/build/src/v1beta/user_event_service_client.js +147 -2
- package/package.json +8 -11
@@ -4,7 +4,7 @@ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, Pa
|
|
4
4
|
import { Transform } from 'stream';
|
5
5
|
import * as protos from '../../protos/protos';
|
6
6
|
/**
|
7
|
-
* Service for managing {@link google.cloud.discoveryengine.v1.Schema|Schema}s.
|
7
|
+
* Service for managing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s.
|
8
8
|
* @class
|
9
9
|
* @memberof v1
|
10
10
|
*/
|
@@ -109,7 +109,7 @@ export declare class SchemaServiceClient {
|
|
109
109
|
getProjectId(): Promise<string>;
|
110
110
|
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
111
111
|
/**
|
112
|
-
* Gets a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
112
|
+
* Gets a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
113
113
|
*
|
114
114
|
* @param {Object} request
|
115
115
|
* The request object that will be sent.
|
@@ -119,9 +119,8 @@ export declare class SchemaServiceClient {
|
|
119
119
|
* @param {object} [options]
|
120
120
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
121
121
|
* @returns {Promise} - The promise which resolves to an array.
|
122
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Schema
|
123
|
-
* Please see the
|
124
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
122
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
123
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
125
124
|
* for more details and examples.
|
126
125
|
* @example <caption>include:samples/generated/v1/schema_service.get_schema.js</caption>
|
127
126
|
* region_tag:discoveryengine_v1_generated_SchemaService_GetSchema_async
|
@@ -134,7 +133,7 @@ export declare class SchemaServiceClient {
|
|
134
133
|
getSchema(request: protos.google.cloud.discoveryengine.v1.IGetSchemaRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.ISchema, protos.google.cloud.discoveryengine.v1.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
135
134
|
getSchema(request: protos.google.cloud.discoveryengine.v1.IGetSchemaRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.ISchema, protos.google.cloud.discoveryengine.v1.IGetSchemaRequest | null | undefined, {} | null | undefined>): void;
|
136
135
|
/**
|
137
|
-
* Creates a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
136
|
+
* Creates a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
138
137
|
*
|
139
138
|
* @param {Object} request
|
140
139
|
* The request object that will be sent.
|
@@ -142,12 +141,12 @@ export declare class SchemaServiceClient {
|
|
142
141
|
* Required. The parent data store resource name, in the format of
|
143
142
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
144
143
|
* @param {google.cloud.discoveryengine.v1.Schema} request.schema
|
145
|
-
* Required. The {@link google.cloud.discoveryengine.v1.Schema|Schema} to create.
|
144
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} to create.
|
146
145
|
* @param {string} request.schemaId
|
147
146
|
* Required. The ID to use for the
|
148
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}, which will become the
|
147
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}, which will become the
|
149
148
|
* final component of the
|
150
|
-
* {@link google.cloud.discoveryengine.v1.Schema.name|Schema.name}.
|
149
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema.name|Schema.name}.
|
151
150
|
*
|
152
151
|
* This field should conform to
|
153
152
|
* [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
|
@@ -158,8 +157,7 @@ export declare class SchemaServiceClient {
|
|
158
157
|
* The first element of the array is an object representing
|
159
158
|
* a long running operation. Its `promise()` method returns a promise
|
160
159
|
* you can `await` for.
|
161
|
-
* Please see the
|
162
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
160
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
163
161
|
* for more details and examples.
|
164
162
|
* @example <caption>include:samples/generated/v1/schema_service.create_schema.js</caption>
|
165
163
|
* region_tag:discoveryengine_v1_generated_SchemaService_CreateSchema_async
|
@@ -177,23 +175,22 @@ export declare class SchemaServiceClient {
|
|
177
175
|
* The operation name that will be passed.
|
178
176
|
* @returns {Promise} - The promise which resolves to an object.
|
179
177
|
* The decoded operation object has result and metadata field to get information from.
|
180
|
-
* Please see the
|
181
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
178
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
182
179
|
* for more details and examples.
|
183
180
|
* @example <caption>include:samples/generated/v1/schema_service.create_schema.js</caption>
|
184
181
|
* region_tag:discoveryengine_v1_generated_SchemaService_CreateSchema_async
|
185
182
|
*/
|
186
183
|
checkCreateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.Schema, protos.google.cloud.discoveryengine.v1.CreateSchemaMetadata>>;
|
187
184
|
/**
|
188
|
-
* Updates a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
185
|
+
* Updates a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
189
186
|
*
|
190
187
|
* @param {Object} request
|
191
188
|
* The request object that will be sent.
|
192
189
|
* @param {google.cloud.discoveryengine.v1.Schema} request.schema
|
193
|
-
* Required. The {@link google.cloud.discoveryengine.v1.Schema|Schema} to update.
|
190
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} to update.
|
194
191
|
* @param {boolean} request.allowMissing
|
195
|
-
* If set to true, and the {@link google.cloud.discoveryengine.v1.Schema|Schema} is
|
196
|
-
* not found, a new {@link google.cloud.discoveryengine.v1.Schema|Schema} will be
|
192
|
+
* If set to true, and the {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} is
|
193
|
+
* not found, a new {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} will be
|
197
194
|
* created. In this situation, `update_mask` is ignored.
|
198
195
|
* @param {object} [options]
|
199
196
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
@@ -201,8 +198,7 @@ export declare class SchemaServiceClient {
|
|
201
198
|
* The first element of the array is an object representing
|
202
199
|
* a long running operation. Its `promise()` method returns a promise
|
203
200
|
* you can `await` for.
|
204
|
-
* Please see the
|
205
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
201
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
206
202
|
* for more details and examples.
|
207
203
|
* @example <caption>include:samples/generated/v1/schema_service.update_schema.js</caption>
|
208
204
|
* region_tag:discoveryengine_v1_generated_SchemaService_UpdateSchema_async
|
@@ -220,15 +216,14 @@ export declare class SchemaServiceClient {
|
|
220
216
|
* The operation name that will be passed.
|
221
217
|
* @returns {Promise} - The promise which resolves to an object.
|
222
218
|
* The decoded operation object has result and metadata field to get information from.
|
223
|
-
* Please see the
|
224
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
219
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
225
220
|
* for more details and examples.
|
226
221
|
* @example <caption>include:samples/generated/v1/schema_service.update_schema.js</caption>
|
227
222
|
* region_tag:discoveryengine_v1_generated_SchemaService_UpdateSchema_async
|
228
223
|
*/
|
229
224
|
checkUpdateSchemaProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.Schema, protos.google.cloud.discoveryengine.v1.UpdateSchemaMetadata>>;
|
230
225
|
/**
|
231
|
-
* Deletes a {@link google.cloud.discoveryengine.v1.Schema|Schema}.
|
226
|
+
* Deletes a {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
232
227
|
*
|
233
228
|
* @param {Object} request
|
234
229
|
* The request object that will be sent.
|
@@ -241,8 +236,7 @@ export declare class SchemaServiceClient {
|
|
241
236
|
* The first element of the array is an object representing
|
242
237
|
* a long running operation. Its `promise()` method returns a promise
|
243
238
|
* you can `await` for.
|
244
|
-
* Please see the
|
245
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
239
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
246
240
|
* for more details and examples.
|
247
241
|
* @example <caption>include:samples/generated/v1/schema_service.delete_schema.js</caption>
|
248
242
|
* region_tag:discoveryengine_v1_generated_SchemaService_DeleteSchema_async
|
@@ -260,15 +254,14 @@ export declare class SchemaServiceClient {
|
|
260
254
|
* The operation name that will be passed.
|
261
255
|
* @returns {Promise} - The promise which resolves to an object.
|
262
256
|
* The decoded operation object has result and metadata field to get information from.
|
263
|
-
* Please see the
|
264
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
257
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
265
258
|
* for more details and examples.
|
266
259
|
* @example <caption>include:samples/generated/v1/schema_service.delete_schema.js</caption>
|
267
260
|
* region_tag:discoveryengine_v1_generated_SchemaService_DeleteSchema_async
|
268
261
|
*/
|
269
262
|
checkDeleteSchemaProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1.DeleteSchemaMetadata>>;
|
270
263
|
/**
|
271
|
-
* Gets a list of {@link google.cloud.discoveryengine.v1.Schema|Schema}s.
|
264
|
+
* Gets a list of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s.
|
272
265
|
*
|
273
266
|
* @param {Object} request
|
274
267
|
* The request object that will be sent.
|
@@ -276,32 +269,31 @@ export declare class SchemaServiceClient {
|
|
276
269
|
* Required. The parent data store resource name, in the format of
|
277
270
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
278
271
|
* @param {number} request.pageSize
|
279
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
272
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
280
273
|
* return. The service may return fewer than this value.
|
281
274
|
*
|
282
275
|
* If unspecified, at most 100
|
283
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
276
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
284
277
|
*
|
285
278
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
286
279
|
* @param {string} request.pageToken
|
287
280
|
* A page token, received from a previous
|
288
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
281
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
289
282
|
* call. Provide this to retrieve the subsequent page.
|
290
283
|
*
|
291
284
|
* When paginating, all other parameters provided to
|
292
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
285
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
293
286
|
* must match the call that provided the page token.
|
294
287
|
* @param {object} [options]
|
295
288
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
296
289
|
* @returns {Promise} - The promise which resolves to an array.
|
297
|
-
* The first element of the array is Array of {@link google.cloud.discoveryengine.v1.Schema
|
290
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}.
|
298
291
|
* The client library will perform auto-pagination by default: it will call the API as many
|
299
292
|
* times as needed and will merge results from all the pages into this array.
|
300
293
|
* Note that it can affect your quota.
|
301
294
|
* We recommend using `listSchemasAsync()`
|
302
295
|
* method described below for async iteration which you can stop as needed.
|
303
|
-
* Please see the
|
304
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
296
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
305
297
|
* for more details and examples.
|
306
298
|
*/
|
307
299
|
listSchemas(request?: protos.google.cloud.discoveryengine.v1.IListSchemasRequest, options?: CallOptions): Promise<[
|
@@ -319,31 +311,30 @@ export declare class SchemaServiceClient {
|
|
319
311
|
* Required. The parent data store resource name, in the format of
|
320
312
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
321
313
|
* @param {number} request.pageSize
|
322
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
314
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
323
315
|
* return. The service may return fewer than this value.
|
324
316
|
*
|
325
317
|
* If unspecified, at most 100
|
326
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
318
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
327
319
|
*
|
328
320
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
329
321
|
* @param {string} request.pageToken
|
330
322
|
* A page token, received from a previous
|
331
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
323
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
332
324
|
* call. Provide this to retrieve the subsequent page.
|
333
325
|
*
|
334
326
|
* When paginating, all other parameters provided to
|
335
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
327
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
336
328
|
* must match the call that provided the page token.
|
337
329
|
* @param {object} [options]
|
338
330
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
339
331
|
* @returns {Stream}
|
340
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Schema
|
332
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} on 'data' event.
|
341
333
|
* The client library will perform auto-pagination by default: it will call the API as many
|
342
334
|
* times as needed. Note that it can affect your quota.
|
343
335
|
* We recommend using `listSchemasAsync()`
|
344
336
|
* method described below for async iteration which you can stop as needed.
|
345
|
-
* Please see the
|
346
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
337
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
347
338
|
* for more details and examples.
|
348
339
|
*/
|
349
340
|
listSchemasStream(request?: protos.google.cloud.discoveryengine.v1.IListSchemasRequest, options?: CallOptions): Transform;
|
@@ -357,30 +348,29 @@ export declare class SchemaServiceClient {
|
|
357
348
|
* Required. The parent data store resource name, in the format of
|
358
349
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
359
350
|
* @param {number} request.pageSize
|
360
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
351
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
361
352
|
* return. The service may return fewer than this value.
|
362
353
|
*
|
363
354
|
* If unspecified, at most 100
|
364
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
355
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
365
356
|
*
|
366
357
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
367
358
|
* @param {string} request.pageToken
|
368
359
|
* A page token, received from a previous
|
369
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
360
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
370
361
|
* call. Provide this to retrieve the subsequent page.
|
371
362
|
*
|
372
363
|
* When paginating, all other parameters provided to
|
373
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
364
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
374
365
|
* must match the call that provided the page token.
|
375
366
|
* @param {object} [options]
|
376
367
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
377
368
|
* @returns {Object}
|
378
|
-
* An iterable Object that allows
|
369
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
379
370
|
* When you iterate the returned iterable, each element will be an object representing
|
380
|
-
* {@link google.cloud.discoveryengine.v1.Schema
|
371
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}. The API will be called under the hood as needed, once per the page,
|
381
372
|
* so you can stop the iteration when you don't need more results.
|
382
|
-
* Please see the
|
383
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
373
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
384
374
|
* for more details and examples.
|
385
375
|
* @example <caption>include:samples/generated/v1/schema_service.list_schemas.js</caption>
|
386
376
|
* region_tag:discoveryengine_v1_generated_SchemaService_ListSchemas_async
|
@@ -27,7 +27,7 @@ const jsonProtos = require("../../protos/protos.json");
|
|
27
27
|
const gapicConfig = require("./schema_service_client_config.json");
|
28
28
|
const version = require('../../../package.json').version;
|
29
29
|
/**
|
30
|
-
* Service for managing {@link google.cloud.discoveryengine.v1.Schema|Schema}s.
|
30
|
+
* Service for managing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s.
|
31
31
|
* @class
|
32
32
|
* @memberof v1
|
33
33
|
*/
|
@@ -385,8 +385,7 @@ class SchemaServiceClient {
|
|
385
385
|
* The operation name that will be passed.
|
386
386
|
* @returns {Promise} - The promise which resolves to an object.
|
387
387
|
* The decoded operation object has result and metadata field to get information from.
|
388
|
-
* Please see the
|
389
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
388
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
390
389
|
* for more details and examples.
|
391
390
|
* @example <caption>include:samples/generated/v1/schema_service.create_schema.js</caption>
|
392
391
|
* region_tag:discoveryengine_v1_generated_SchemaService_CreateSchema_async
|
@@ -424,8 +423,7 @@ class SchemaServiceClient {
|
|
424
423
|
* The operation name that will be passed.
|
425
424
|
* @returns {Promise} - The promise which resolves to an object.
|
426
425
|
* The decoded operation object has result and metadata field to get information from.
|
427
|
-
* Please see the
|
428
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
426
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
429
427
|
* for more details and examples.
|
430
428
|
* @example <caption>include:samples/generated/v1/schema_service.update_schema.js</caption>
|
431
429
|
* region_tag:discoveryengine_v1_generated_SchemaService_UpdateSchema_async
|
@@ -463,8 +461,7 @@ class SchemaServiceClient {
|
|
463
461
|
* The operation name that will be passed.
|
464
462
|
* @returns {Promise} - The promise which resolves to an object.
|
465
463
|
* The decoded operation object has result and metadata field to get information from.
|
466
|
-
* Please see the
|
467
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
464
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
468
465
|
* for more details and examples.
|
469
466
|
* @example <caption>include:samples/generated/v1/schema_service.delete_schema.js</caption>
|
470
467
|
* region_tag:discoveryengine_v1_generated_SchemaService_DeleteSchema_async
|
@@ -504,31 +501,30 @@ class SchemaServiceClient {
|
|
504
501
|
* Required. The parent data store resource name, in the format of
|
505
502
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
506
503
|
* @param {number} request.pageSize
|
507
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
504
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
508
505
|
* return. The service may return fewer than this value.
|
509
506
|
*
|
510
507
|
* If unspecified, at most 100
|
511
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
508
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
512
509
|
*
|
513
510
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
514
511
|
* @param {string} request.pageToken
|
515
512
|
* A page token, received from a previous
|
516
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
513
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
517
514
|
* call. Provide this to retrieve the subsequent page.
|
518
515
|
*
|
519
516
|
* When paginating, all other parameters provided to
|
520
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
517
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
521
518
|
* must match the call that provided the page token.
|
522
519
|
* @param {object} [options]
|
523
520
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
524
521
|
* @returns {Stream}
|
525
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Schema
|
522
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} on 'data' event.
|
526
523
|
* The client library will perform auto-pagination by default: it will call the API as many
|
527
524
|
* times as needed. Note that it can affect your quota.
|
528
525
|
* We recommend using `listSchemasAsync()`
|
529
526
|
* method described below for async iteration which you can stop as needed.
|
530
|
-
* Please see the
|
531
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
527
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
532
528
|
* for more details and examples.
|
533
529
|
*/
|
534
530
|
listSchemasStream(request, options) {
|
@@ -556,30 +552,29 @@ class SchemaServiceClient {
|
|
556
552
|
* Required. The parent data store resource name, in the format of
|
557
553
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
558
554
|
* @param {number} request.pageSize
|
559
|
-
* The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
|
555
|
+
* The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
|
560
556
|
* return. The service may return fewer than this value.
|
561
557
|
*
|
562
558
|
* If unspecified, at most 100
|
563
|
-
* {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
559
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
|
564
560
|
*
|
565
561
|
* The maximum value is 1000; values above 1000 will be coerced to 1000.
|
566
562
|
* @param {string} request.pageToken
|
567
563
|
* A page token, received from a previous
|
568
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
564
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
569
565
|
* call. Provide this to retrieve the subsequent page.
|
570
566
|
*
|
571
567
|
* When paginating, all other parameters provided to
|
572
|
-
* {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
568
|
+
* {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
|
573
569
|
* must match the call that provided the page token.
|
574
570
|
* @param {object} [options]
|
575
571
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
576
572
|
* @returns {Object}
|
577
|
-
* An iterable Object that allows
|
573
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
578
574
|
* When you iterate the returned iterable, each element will be an object representing
|
579
|
-
* {@link google.cloud.discoveryengine.v1.Schema
|
575
|
+
* {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}. The API will be called under the hood as needed, once per the page,
|
580
576
|
* so you can stop the iteration when you don't need more results.
|
581
|
-
* Please see the
|
582
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
577
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
583
578
|
* for more details and examples.
|
584
579
|
* @example <caption>include:samples/generated/v1/schema_service.list_schemas.js</caption>
|
585
580
|
* region_tag:discoveryengine_v1_generated_SchemaService_ListSchemas_async
|
@@ -126,26 +126,26 @@ export declare class SearchServiceClient {
|
|
126
126
|
* @param {string} request.query
|
127
127
|
* Raw search query.
|
128
128
|
* @param {number} request.pageSize
|
129
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
129
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
130
130
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
131
131
|
* value is 100. Values above 100 will be coerced to 100.
|
132
132
|
*
|
133
133
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
134
134
|
* @param {string} request.pageToken
|
135
135
|
* A page token received from a previous
|
136
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
136
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
137
137
|
* call. Provide this to retrieve the subsequent page.
|
138
138
|
*
|
139
139
|
* When paginating, all other parameters provided to
|
140
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
140
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
141
141
|
* must match the call that provided the page token. Otherwise, an
|
142
142
|
* `INVALID_ARGUMENT` error is returned.
|
143
143
|
* @param {number} request.offset
|
144
144
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
145
145
|
* result location, amongst the
|
146
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
146
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
147
147
|
* relevant) in search results. This field is only considered if
|
148
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
148
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
149
149
|
* unset.
|
150
150
|
*
|
151
151
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -178,9 +178,9 @@ export declare class SearchServiceClient {
|
|
178
178
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
179
179
|
*
|
180
180
|
* This should be the same identifier as
|
181
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
181
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
182
182
|
* and
|
183
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
183
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
184
184
|
*
|
185
185
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
186
186
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
@@ -189,7 +189,7 @@ export declare class SearchServiceClient {
|
|
189
189
|
* search.
|
190
190
|
* @param {boolean} request.safeSearch
|
191
191
|
* Whether to turn on safe search. This is only supported for
|
192
|
-
* {@link
|
192
|
+
* {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
|
193
193
|
* @param {number[]} request.userLabels
|
194
194
|
* The user labels applied to a resource must meet the following requirements:
|
195
195
|
*
|
@@ -211,14 +211,13 @@ export declare class SearchServiceClient {
|
|
211
211
|
* @param {object} [options]
|
212
212
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
213
213
|
* @returns {Promise} - The promise which resolves to an array.
|
214
|
-
* The first element of the array is Array of {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
214
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}.
|
215
215
|
* The client library will perform auto-pagination by default: it will call the API as many
|
216
216
|
* times as needed and will merge results from all the pages into this array.
|
217
217
|
* Note that it can affect your quota.
|
218
218
|
* We recommend using `searchAsync()`
|
219
219
|
* method described below for async iteration which you can stop as needed.
|
220
|
-
* Please see the
|
221
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
220
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
222
221
|
* for more details and examples.
|
223
222
|
*/
|
224
223
|
search(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Promise<[
|
@@ -246,26 +245,26 @@ export declare class SearchServiceClient {
|
|
246
245
|
* @param {string} request.query
|
247
246
|
* Raw search query.
|
248
247
|
* @param {number} request.pageSize
|
249
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
248
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
250
249
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
251
250
|
* value is 100. Values above 100 will be coerced to 100.
|
252
251
|
*
|
253
252
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
254
253
|
* @param {string} request.pageToken
|
255
254
|
* A page token received from a previous
|
256
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
255
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
257
256
|
* call. Provide this to retrieve the subsequent page.
|
258
257
|
*
|
259
258
|
* When paginating, all other parameters provided to
|
260
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
259
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
261
260
|
* must match the call that provided the page token. Otherwise, an
|
262
261
|
* `INVALID_ARGUMENT` error is returned.
|
263
262
|
* @param {number} request.offset
|
264
263
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
265
264
|
* result location, amongst the
|
266
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
265
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
267
266
|
* relevant) in search results. This field is only considered if
|
268
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
267
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
269
268
|
* unset.
|
270
269
|
*
|
271
270
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -298,9 +297,9 @@ export declare class SearchServiceClient {
|
|
298
297
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
299
298
|
*
|
300
299
|
* This should be the same identifier as
|
301
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
300
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
302
301
|
* and
|
303
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
302
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
304
303
|
*
|
305
304
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
306
305
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
@@ -309,7 +308,7 @@ export declare class SearchServiceClient {
|
|
309
308
|
* search.
|
310
309
|
* @param {boolean} request.safeSearch
|
311
310
|
* Whether to turn on safe search. This is only supported for
|
312
|
-
* {@link
|
311
|
+
* {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
|
313
312
|
* @param {number[]} request.userLabels
|
314
313
|
* The user labels applied to a resource must meet the following requirements:
|
315
314
|
*
|
@@ -331,13 +330,12 @@ export declare class SearchServiceClient {
|
|
331
330
|
* @param {object} [options]
|
332
331
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
333
332
|
* @returns {Stream}
|
334
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
333
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult} on 'data' event.
|
335
334
|
* The client library will perform auto-pagination by default: it will call the API as many
|
336
335
|
* times as needed. Note that it can affect your quota.
|
337
336
|
* We recommend using `searchAsync()`
|
338
337
|
* method described below for async iteration which you can stop as needed.
|
339
|
-
* Please see the
|
340
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
338
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
341
339
|
* for more details and examples.
|
342
340
|
*/
|
343
341
|
searchStream(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Transform;
|
@@ -361,26 +359,26 @@ export declare class SearchServiceClient {
|
|
361
359
|
* @param {string} request.query
|
362
360
|
* Raw search query.
|
363
361
|
* @param {number} request.pageSize
|
364
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
362
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
365
363
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
366
364
|
* value is 100. Values above 100 will be coerced to 100.
|
367
365
|
*
|
368
366
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
369
367
|
* @param {string} request.pageToken
|
370
368
|
* A page token received from a previous
|
371
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
369
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
372
370
|
* call. Provide this to retrieve the subsequent page.
|
373
371
|
*
|
374
372
|
* When paginating, all other parameters provided to
|
375
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
373
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
376
374
|
* must match the call that provided the page token. Otherwise, an
|
377
375
|
* `INVALID_ARGUMENT` error is returned.
|
378
376
|
* @param {number} request.offset
|
379
377
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
380
378
|
* result location, amongst the
|
381
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
379
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
382
380
|
* relevant) in search results. This field is only considered if
|
383
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
381
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
384
382
|
* unset.
|
385
383
|
*
|
386
384
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -413,9 +411,9 @@ export declare class SearchServiceClient {
|
|
413
411
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
414
412
|
*
|
415
413
|
* This should be the same identifier as
|
416
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
414
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
417
415
|
* and
|
418
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
416
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
419
417
|
*
|
420
418
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
421
419
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
@@ -424,7 +422,7 @@ export declare class SearchServiceClient {
|
|
424
422
|
* search.
|
425
423
|
* @param {boolean} request.safeSearch
|
426
424
|
* Whether to turn on safe search. This is only supported for
|
427
|
-
* {@link
|
425
|
+
* {@link protos.|ContentConfig.PUBLIC_WEBSITE}.
|
428
426
|
* @param {number[]} request.userLabels
|
429
427
|
* The user labels applied to a resource must meet the following requirements:
|
430
428
|
*
|
@@ -446,12 +444,11 @@ export declare class SearchServiceClient {
|
|
446
444
|
* @param {object} [options]
|
447
445
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
448
446
|
* @returns {Object}
|
449
|
-
* An iterable Object that allows
|
447
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
450
448
|
* When you iterate the returned iterable, each element will be an object representing
|
451
|
-
* {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
449
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
|
452
450
|
* so you can stop the iteration when you don't need more results.
|
453
|
-
* Please see the
|
454
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
451
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
455
452
|
* for more details and examples.
|
456
453
|
* @example <caption>include:samples/generated/v1/search_service.search.js</caption>
|
457
454
|
* region_tag:discoveryengine_v1_generated_SearchService_Search_async
|