@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.
Files changed (43) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +6 -0
  3. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +1 -2
  4. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +15 -2
  5. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +131 -0
  6. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +281 -0
  7. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +6 -5
  8. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
  9. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +26 -22
  10. package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +193 -47
  12. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +41 -36
  13. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
  14. package/build/protos/protos.d.ts +6529 -4472
  15. package/build/protos/protos.js +16561 -11622
  16. package/build/protos/protos.json +1842 -1317
  17. package/build/src/v1/completion_service_client.d.ts +6 -7
  18. package/build/src/v1/document_service_client.d.ts +83 -94
  19. package/build/src/v1/document_service_client.js +18 -22
  20. package/build/src/v1/schema_service_client.d.ts +39 -49
  21. package/build/src/v1/schema_service_client.js +17 -22
  22. package/build/src/v1/search_service_client.d.ts +31 -34
  23. package/build/src/v1/search_service_client.js +21 -23
  24. package/build/src/v1/user_event_service_client.d.ts +6 -10
  25. package/build/src/v1/user_event_service_client.js +1 -2
  26. package/build/src/v1beta/completion_service_client.d.ts +106 -8
  27. package/build/src/v1beta/completion_service_client.js +128 -0
  28. package/build/src/v1beta/conversational_search_service_client.d.ts +876 -0
  29. package/build/src/v1beta/conversational_search_service_client.js +1149 -0
  30. package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
  31. package/build/src/v1beta/document_service_client.d.ts +183 -98
  32. package/build/src/v1beta/document_service_client.js +166 -22
  33. package/build/src/v1beta/index.d.ts +1 -0
  34. package/build/src/v1beta/index.js +3 -1
  35. package/build/src/v1beta/recommendation_service_client.d.ts +103 -11
  36. package/build/src/v1beta/recommendation_service_client.js +128 -0
  37. package/build/src/v1beta/schema_service_client.d.ts +132 -49
  38. package/build/src/v1beta/schema_service_client.js +163 -22
  39. package/build/src/v1beta/search_service_client.d.ts +163 -67
  40. package/build/src/v1beta/search_service_client.js +175 -45
  41. package/build/src/v1beta/user_event_service_client.d.ts +104 -15
  42. package/build/src/v1beta/user_event_service_client.js +147 -2
  43. package/package.json +8 -11
@@ -123,7 +123,7 @@ export declare class CompletionServiceClient {
123
123
  *
124
124
  * * `document` - Using suggestions generated from user-imported documents.
125
125
  * * `search-history` - Using suggestions generated from the past history of
126
- * {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
126
+ * {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
127
127
  * API calls. Do not use it when there is no traffic for Search API.
128
128
  * * `user-event` - Using suggestions generated from user-imported search
129
129
  * events.
@@ -132,7 +132,7 @@ export declare class CompletionServiceClient {
132
132
  *
133
133
  * * `document` is the default model for regular dataStores.
134
134
  * * `search-history` is the default model for
135
- * {@link google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
135
+ * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
136
136
  * dataStores.
137
137
  * @param {string} request.userPseudoId
138
138
  * A unique identifier for tracking visitors. For example, this could be
@@ -143,18 +143,17 @@ export declare class CompletionServiceClient {
143
143
  * This field should NOT have a fixed value such as `unknown_visitor`.
144
144
  *
145
145
  * This should be the same identifier as
146
- * {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
146
+ * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
147
147
  * and
148
- * {@link google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
148
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
149
149
  *
150
150
  * The field must be a UTF-8 encoded string with a length limit of 128
151
151
  * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
152
152
  * @param {object} [options]
153
153
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
154
154
  * @returns {Promise} - The promise which resolves to an array.
155
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.CompleteQueryResponse | CompleteQueryResponse}.
156
- * Please see the
157
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
155
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.CompleteQueryResponse|CompleteQueryResponse}.
156
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
158
157
  * for more details and examples.
159
158
  * @example <caption>include:samples/generated/v1/completion_service.complete_query.js</caption>
160
159
  * region_tag:discoveryengine_v1_generated_CompletionService_CompleteQuery_async
@@ -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 ingesting {@link google.cloud.discoveryengine.v1.Document|Document}
7
+ * Service for ingesting {@link protos.google.cloud.discoveryengine.v1.Document|Document}
8
8
  * information of the customer's website.
9
9
  * @class
10
10
  * @memberof v1
@@ -110,27 +110,26 @@ export declare class DocumentServiceClient {
110
110
  getProjectId(): Promise<string>;
111
111
  getProjectId(callback: Callback<string, undefined, undefined>): void;
112
112
  /**
113
- * Gets a {@link google.cloud.discoveryengine.v1.Document|Document}.
113
+ * Gets a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
114
114
  *
115
115
  * @param {Object} request
116
116
  * The request object that will be sent.
117
117
  * @param {string} request.name
118
118
  * Required. Full resource name of
119
- * {@link google.cloud.discoveryengine.v1.Document|Document}, such as
119
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}, such as
120
120
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
121
121
  *
122
122
  * If the caller does not have permission to access the
123
- * {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
123
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
124
124
  * or not it exists, a `PERMISSION_DENIED` error is returned.
125
125
  *
126
- * If the requested {@link google.cloud.discoveryengine.v1.Document|Document} does
126
+ * If the requested {@link protos.google.cloud.discoveryengine.v1.Document|Document} does
127
127
  * not exist, a `NOT_FOUND` error is returned.
128
128
  * @param {object} [options]
129
129
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
130
130
  * @returns {Promise} - The promise which resolves to an array.
131
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document | Document}.
132
- * Please see the
133
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
131
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
132
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
134
133
  * for more details and examples.
135
134
  * @example <caption>include:samples/generated/v1/document_service.get_document.js</caption>
136
135
  * region_tag:discoveryengine_v1_generated_DocumentService_GetDocument_async
@@ -143,7 +142,7 @@ export declare class DocumentServiceClient {
143
142
  getDocument(request: protos.google.cloud.discoveryengine.v1.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
144
143
  getDocument(request: protos.google.cloud.discoveryengine.v1.IGetDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
145
144
  /**
146
- * Creates a {@link google.cloud.discoveryengine.v1.Document|Document}.
145
+ * Creates a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
147
146
  *
148
147
  * @param {Object} request
149
148
  * The request object that will be sent.
@@ -151,21 +150,21 @@ export declare class DocumentServiceClient {
151
150
  * Required. The parent resource name, such as
152
151
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
153
152
  * @param {google.cloud.discoveryengine.v1.Document} request.document
154
- * Required. The {@link google.cloud.discoveryengine.v1.Document|Document} to
153
+ * Required. The {@link protos.google.cloud.discoveryengine.v1.Document|Document} to
155
154
  * create.
156
155
  * @param {string} request.documentId
157
156
  * Required. The ID to use for the
158
- * {@link google.cloud.discoveryengine.v1.Document|Document}, which will become the
157
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}, which will become the
159
158
  * final component of the
160
- * {@link google.cloud.discoveryengine.v1.Document.name|Document.name}.
159
+ * {@link protos.google.cloud.discoveryengine.v1.Document.name|Document.name}.
161
160
  *
162
161
  * If the caller does not have permission to create the
163
- * {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
162
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
164
163
  * or not it exists, a `PERMISSION_DENIED` error is returned.
165
164
  *
166
165
  * This field must be unique among all
167
- * {@link google.cloud.discoveryengine.v1.Document|Document}s with the same
168
- * {@link google.cloud.discoveryengine.v1.CreateDocumentRequest.parent|parent}.
166
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s with the same
167
+ * {@link protos.google.cloud.discoveryengine.v1.CreateDocumentRequest.parent|parent}.
169
168
  * Otherwise, an `ALREADY_EXISTS` error is returned.
170
169
  *
171
170
  * This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
@@ -174,9 +173,8 @@ export declare class DocumentServiceClient {
174
173
  * @param {object} [options]
175
174
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
176
175
  * @returns {Promise} - The promise which resolves to an array.
177
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document | Document}.
178
- * Please see the
179
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
176
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
177
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
180
178
  * for more details and examples.
181
179
  * @example <caption>include:samples/generated/v1/document_service.create_document.js</caption>
182
180
  * region_tag:discoveryengine_v1_generated_DocumentService_CreateDocument_async
@@ -189,7 +187,7 @@ export declare class DocumentServiceClient {
189
187
  createDocument(request: protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
190
188
  createDocument(request: protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
191
189
  /**
192
- * Updates a {@link google.cloud.discoveryengine.v1.Document|Document}.
190
+ * Updates a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
193
191
  *
194
192
  * @param {Object} request
195
193
  * The request object that will be sent.
@@ -197,23 +195,22 @@ export declare class DocumentServiceClient {
197
195
  * Required. The document to update/create.
198
196
  *
199
197
  * If the caller does not have permission to update the
200
- * {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
198
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
201
199
  * or not it exists, a `PERMISSION_DENIED` error is returned.
202
200
  *
203
- * If the {@link google.cloud.discoveryengine.v1.Document|Document} to update does
201
+ * If the {@link protos.google.cloud.discoveryengine.v1.Document|Document} to update does
204
202
  * not exist and
205
- * {@link google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing|allow_missing}
203
+ * {@link protos.google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing|allow_missing}
206
204
  * is not set, a `NOT_FOUND` error is returned.
207
205
  * @param {boolean} request.allowMissing
208
206
  * If set to true, and the
209
- * {@link google.cloud.discoveryengine.v1.Document|Document} is not found, a new
210
- * {@link google.cloud.discoveryengine.v1.Document|Document} will be created.
207
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document} is not found, a new
208
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document} will be created.
211
209
  * @param {object} [options]
212
210
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
213
211
  * @returns {Promise} - The promise which resolves to an array.
214
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document | Document}.
215
- * Please see the
216
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
212
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
213
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
217
214
  * for more details and examples.
218
215
  * @example <caption>include:samples/generated/v1/document_service.update_document.js</caption>
219
216
  * region_tag:discoveryengine_v1_generated_DocumentService_UpdateDocument_async
@@ -226,27 +223,26 @@ export declare class DocumentServiceClient {
226
223
  updateDocument(request: protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
227
224
  updateDocument(request: protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
228
225
  /**
229
- * Deletes a {@link google.cloud.discoveryengine.v1.Document|Document}.
226
+ * Deletes a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
230
227
  *
231
228
  * @param {Object} request
232
229
  * The request object that will be sent.
233
230
  * @param {string} request.name
234
231
  * Required. Full resource name of
235
- * {@link google.cloud.discoveryengine.v1.Document|Document}, such as
232
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}, such as
236
233
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
237
234
  *
238
235
  * If the caller does not have permission to delete the
239
- * {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
236
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
240
237
  * or not it exists, a `PERMISSION_DENIED` error is returned.
241
238
  *
242
- * If the {@link google.cloud.discoveryengine.v1.Document|Document} to delete does
239
+ * If the {@link protos.google.cloud.discoveryengine.v1.Document|Document} to delete does
243
240
  * not exist, a `NOT_FOUND` error is returned.
244
241
  * @param {object} [options]
245
242
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
246
243
  * @returns {Promise} - The promise which resolves to an array.
247
- * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
248
- * Please see the
249
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
244
+ * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
245
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
250
246
  * for more details and examples.
251
247
  * @example <caption>include:samples/generated/v1/document_service.delete_document.js</caption>
252
248
  * region_tag:discoveryengine_v1_generated_DocumentService_DeleteDocument_async
@@ -260,11 +256,11 @@ export declare class DocumentServiceClient {
260
256
  deleteDocument(request: protos.google.cloud.discoveryengine.v1.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
261
257
  /**
262
258
  * Bulk import of multiple
263
- * {@link google.cloud.discoveryengine.v1.Document|Document}s. Request processing
259
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s. Request processing
264
260
  * may be synchronous. Non-existing items will be created.
265
261
  *
266
262
  * Note: It is possible for a subset of the
267
- * {@link google.cloud.discoveryengine.v1.Document|Document}s to be successfully
263
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to be successfully
268
264
  * updated.
269
265
  *
270
266
  * @param {Object} request
@@ -284,52 +280,52 @@ export declare class DocumentServiceClient {
284
280
  * @param {google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode} request.reconciliationMode
285
281
  * The mode of reconciliation between existing documents and the documents to
286
282
  * be imported. Defaults to
287
- * {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
283
+ * {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
288
284
  * @param {boolean} request.autoGenerateIds
289
285
  * Whether to automatically generate IDs for the documents if absent.
290
286
  *
291
287
  * If set to `true`,
292
- * {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s are
288
+ * {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s are
293
289
  * automatically generated based on the hash of the payload, where IDs may not
294
290
  * be consistent during multiple imports. In which case
295
- * {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
291
+ * {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
296
292
  * is highly recommended to avoid duplicate contents. If unset or set to
297
- * `false`, {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s have
293
+ * `false`, {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s have
298
294
  * to be specified using
299
- * {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field|id_field},
295
+ * {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field|id_field},
300
296
  * otherwises, documents without IDs will fail to be imported.
301
297
  *
302
298
  * Only set this field when using
303
- * {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
304
- * {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
305
- * {@link google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
299
+ * {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
300
+ * {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
301
+ * {@link protos.google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
306
302
  * or
307
- * {@link google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
303
+ * {@link protos.google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
308
304
  * is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
309
305
  * @param {string} request.idField
310
306
  * The field in the Cloud Storage and BigQuery sources that indicates the
311
307
  * unique IDs of the documents.
312
308
  *
313
- * For {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} it is the key of
309
+ * For {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} it is the key of
314
310
  * the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
315
- * For {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource} it is
311
+ * For {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource} it is
316
312
  * the column name of the BigQuery table where the unique ids are stored.
317
313
  *
318
314
  * The values of the JSON field or the BigQuery column will be used as the
319
- * {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s. The JSON field
315
+ * {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s. The JSON field
320
316
  * or the BigQuery column must be of string type, and the values must be set
321
317
  * as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
322
318
  * with 1-63 characters. Otherwise, documents without valid IDs will fail to
323
319
  * be imported.
324
320
  *
325
321
  * Only set this field when using
326
- * {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
327
- * {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
328
- * {@link google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
322
+ * {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
323
+ * {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
324
+ * {@link protos.google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
329
325
  * or
330
- * {@link google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
326
+ * {@link protos.google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
331
327
  * is `custom`. And only set this field when
332
- * {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
328
+ * {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
333
329
  * is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
334
330
  *
335
331
  * If it is unset, a default value `_id` is used when importing from the
@@ -340,8 +336,7 @@ export declare class DocumentServiceClient {
340
336
  * The first element of the array is an object representing
341
337
  * a long running operation. Its `promise()` method returns a promise
342
338
  * you can `await` for.
343
- * Please see the
344
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
339
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
345
340
  * for more details and examples.
346
341
  * @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
347
342
  * region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
@@ -359,8 +354,7 @@ export declare class DocumentServiceClient {
359
354
  * The operation name that will be passed.
360
355
  * @returns {Promise} - The promise which resolves to an object.
361
356
  * The decoded operation object has result and metadata field to get information from.
362
- * Please see the
363
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
357
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
364
358
  * for more details and examples.
365
359
  * @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
366
360
  * region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
@@ -368,20 +362,20 @@ export declare class DocumentServiceClient {
368
362
  checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1.ImportDocumentsMetadata>>;
369
363
  /**
370
364
  * Permanently deletes all selected
371
- * {@link google.cloud.discoveryengine.v1.Document|Document}s in a branch.
365
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s in a branch.
372
366
  *
373
367
  * This process is asynchronous. Depending on the number of
374
- * {@link google.cloud.discoveryengine.v1.Document|Document}s to be deleted, this
368
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to be deleted, this
375
369
  * operation can take hours to complete. Before the delete operation
376
- * completes, some {@link google.cloud.discoveryengine.v1.Document|Document}s might
370
+ * completes, some {@link protos.google.cloud.discoveryengine.v1.Document|Document}s might
377
371
  * still be returned by
378
- * {@link google.cloud.discoveryengine.v1.DocumentService.GetDocument|DocumentService.GetDocument}
372
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.GetDocument|DocumentService.GetDocument}
379
373
  * or
380
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}.
374
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}.
381
375
  *
382
- * To get a list of the {@link google.cloud.discoveryengine.v1.Document|Document}s
376
+ * To get a list of the {@link protos.google.cloud.discoveryengine.v1.Document|Document}s
383
377
  * to be deleted, set
384
- * {@link google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
378
+ * {@link protos.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
385
379
  * to false.
386
380
  *
387
381
  * @param {Object} request
@@ -402,8 +396,7 @@ export declare class DocumentServiceClient {
402
396
  * The first element of the array is an object representing
403
397
  * a long running operation. Its `promise()` method returns a promise
404
398
  * you can `await` for.
405
- * Please see the
406
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
399
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
407
400
  * for more details and examples.
408
401
  * @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
409
402
  * region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
@@ -421,15 +414,14 @@ export declare class DocumentServiceClient {
421
414
  * The operation name that will be passed.
422
415
  * @returns {Promise} - The promise which resolves to an object.
423
416
  * The decoded operation object has result and metadata field to get information from.
424
- * Please see the
425
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
417
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
426
418
  * for more details and examples.
427
419
  * @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
428
420
  * region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
429
421
  */
430
422
  checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1.PurgeDocumentsMetadata>>;
431
423
  /**
432
- * Gets a list of {@link google.cloud.discoveryengine.v1.Document|Document}s.
424
+ * Gets a list of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s.
433
425
  *
434
426
  * @param {Object} request
435
427
  * The request object that will be sent.
@@ -439,37 +431,36 @@ export declare class DocumentServiceClient {
439
431
  * Use `default_branch` as the branch ID, to list documents under the default
440
432
  * branch.
441
433
  *
442
- * If the caller does not have permission to list {@link |Documents}s under this
434
+ * If the caller does not have permission to list {@link protos.|Documents}s under this
443
435
  * branch, regardless of whether or not this branch exists, a
444
436
  * `PERMISSION_DENIED` error is returned.
445
437
  * @param {number} request.pageSize
446
- * Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
438
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
447
439
  * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
448
440
  * Values above 1000 will be coerced to 1000.
449
441
  *
450
442
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
451
443
  * @param {string} request.pageToken
452
444
  * A page token
453
- * {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
445
+ * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
454
446
  * received from a previous
455
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
447
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
456
448
  * call. Provide this to retrieve the subsequent page.
457
449
  *
458
450
  * When paginating, all other parameters provided to
459
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
451
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
460
452
  * must match the call that provided the page token. Otherwise, an
461
453
  * `INVALID_ARGUMENT` error is returned.
462
454
  * @param {object} [options]
463
455
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
464
456
  * @returns {Promise} - The promise which resolves to an array.
465
- * The first element of the array is Array of {@link google.cloud.discoveryengine.v1.Document | Document}.
457
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
466
458
  * The client library will perform auto-pagination by default: it will call the API as many
467
459
  * times as needed and will merge results from all the pages into this array.
468
460
  * Note that it can affect your quota.
469
461
  * We recommend using `listDocumentsAsync()`
470
462
  * method described below for async iteration which you can stop as needed.
471
- * Please see the
472
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
463
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
473
464
  * for more details and examples.
474
465
  */
475
466
  listDocuments(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Promise<[
@@ -489,36 +480,35 @@ export declare class DocumentServiceClient {
489
480
  * Use `default_branch` as the branch ID, to list documents under the default
490
481
  * branch.
491
482
  *
492
- * If the caller does not have permission to list {@link |Documents}s under this
483
+ * If the caller does not have permission to list {@link protos.|Documents}s under this
493
484
  * branch, regardless of whether or not this branch exists, a
494
485
  * `PERMISSION_DENIED` error is returned.
495
486
  * @param {number} request.pageSize
496
- * Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
487
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
497
488
  * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
498
489
  * Values above 1000 will be coerced to 1000.
499
490
  *
500
491
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
501
492
  * @param {string} request.pageToken
502
493
  * A page token
503
- * {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
494
+ * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
504
495
  * received from a previous
505
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
496
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
506
497
  * call. Provide this to retrieve the subsequent page.
507
498
  *
508
499
  * When paginating, all other parameters provided to
509
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
500
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
510
501
  * must match the call that provided the page token. Otherwise, an
511
502
  * `INVALID_ARGUMENT` error is returned.
512
503
  * @param {object} [options]
513
504
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
514
505
  * @returns {Stream}
515
- * An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Document | Document} on 'data' event.
506
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document} on 'data' event.
516
507
  * The client library will perform auto-pagination by default: it will call the API as many
517
508
  * times as needed. Note that it can affect your quota.
518
509
  * We recommend using `listDocumentsAsync()`
519
510
  * method described below for async iteration which you can stop as needed.
520
- * Please see the
521
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
511
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
522
512
  * for more details and examples.
523
513
  */
524
514
  listDocumentsStream(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Transform;
@@ -534,35 +524,34 @@ export declare class DocumentServiceClient {
534
524
  * Use `default_branch` as the branch ID, to list documents under the default
535
525
  * branch.
536
526
  *
537
- * If the caller does not have permission to list {@link |Documents}s under this
527
+ * If the caller does not have permission to list {@link protos.|Documents}s under this
538
528
  * branch, regardless of whether or not this branch exists, a
539
529
  * `PERMISSION_DENIED` error is returned.
540
530
  * @param {number} request.pageSize
541
- * Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
531
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
542
532
  * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
543
533
  * Values above 1000 will be coerced to 1000.
544
534
  *
545
535
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
546
536
  * @param {string} request.pageToken
547
537
  * A page token
548
- * {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
538
+ * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
549
539
  * received from a previous
550
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
540
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
551
541
  * call. Provide this to retrieve the subsequent page.
552
542
  *
553
543
  * When paginating, all other parameters provided to
554
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
544
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
555
545
  * must match the call that provided the page token. Otherwise, an
556
546
  * `INVALID_ARGUMENT` error is returned.
557
547
  * @param {object} [options]
558
548
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
559
549
  * @returns {Object}
560
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
550
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
561
551
  * When you iterate the returned iterable, each element will be an object representing
562
- * {@link google.cloud.discoveryengine.v1.Document | Document}. The API will be called under the hood as needed, once per the page,
552
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}. The API will be called under the hood as needed, once per the page,
563
553
  * so you can stop the iteration when you don't need more results.
564
- * Please see the
565
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
554
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
566
555
  * for more details and examples.
567
556
  * @example <caption>include:samples/generated/v1/document_service.list_documents.js</caption>
568
557
  * region_tag:discoveryengine_v1_generated_DocumentService_ListDocuments_async
@@ -27,7 +27,7 @@ const jsonProtos = require("../../protos/protos.json");
27
27
  const gapicConfig = require("./document_service_client_config.json");
28
28
  const version = require('../../../package.json').version;
29
29
  /**
30
- * Service for ingesting {@link google.cloud.discoveryengine.v1.Document|Document}
30
+ * Service for ingesting {@link protos.google.cloud.discoveryengine.v1.Document|Document}
31
31
  * information of the customer's website.
32
32
  * @class
33
33
  * @memberof v1
@@ -448,8 +448,7 @@ class DocumentServiceClient {
448
448
  * The operation name that will be passed.
449
449
  * @returns {Promise} - The promise which resolves to an object.
450
450
  * The decoded operation object has result and metadata field to get information from.
451
- * Please see the
452
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
451
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
453
452
  * for more details and examples.
454
453
  * @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
455
454
  * region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
@@ -487,8 +486,7 @@ class DocumentServiceClient {
487
486
  * The operation name that will be passed.
488
487
  * @returns {Promise} - The promise which resolves to an object.
489
488
  * The decoded operation object has result and metadata field to get information from.
490
- * Please see the
491
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
489
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
492
490
  * for more details and examples.
493
491
  * @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
494
492
  * region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
@@ -530,36 +528,35 @@ class DocumentServiceClient {
530
528
  * Use `default_branch` as the branch ID, to list documents under the default
531
529
  * branch.
532
530
  *
533
- * If the caller does not have permission to list {@link |Documents}s under this
531
+ * If the caller does not have permission to list {@link protos.|Documents}s under this
534
532
  * branch, regardless of whether or not this branch exists, a
535
533
  * `PERMISSION_DENIED` error is returned.
536
534
  * @param {number} request.pageSize
537
- * Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
535
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
538
536
  * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
539
537
  * Values above 1000 will be coerced to 1000.
540
538
  *
541
539
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
542
540
  * @param {string} request.pageToken
543
541
  * A page token
544
- * {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
542
+ * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
545
543
  * received from a previous
546
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
544
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
547
545
  * call. Provide this to retrieve the subsequent page.
548
546
  *
549
547
  * When paginating, all other parameters provided to
550
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
548
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
551
549
  * must match the call that provided the page token. Otherwise, an
552
550
  * `INVALID_ARGUMENT` error is returned.
553
551
  * @param {object} [options]
554
552
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
555
553
  * @returns {Stream}
556
- * An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Document | Document} on 'data' event.
554
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document} on 'data' event.
557
555
  * The client library will perform auto-pagination by default: it will call the API as many
558
556
  * times as needed. Note that it can affect your quota.
559
557
  * We recommend using `listDocumentsAsync()`
560
558
  * method described below for async iteration which you can stop as needed.
561
- * Please see the
562
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
559
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
563
560
  * for more details and examples.
564
561
  */
565
562
  listDocumentsStream(request, options) {
@@ -589,35 +586,34 @@ class DocumentServiceClient {
589
586
  * Use `default_branch` as the branch ID, to list documents under the default
590
587
  * branch.
591
588
  *
592
- * If the caller does not have permission to list {@link |Documents}s under this
589
+ * If the caller does not have permission to list {@link protos.|Documents}s under this
593
590
  * branch, regardless of whether or not this branch exists, a
594
591
  * `PERMISSION_DENIED` error is returned.
595
592
  * @param {number} request.pageSize
596
- * Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
593
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
597
594
  * return. If unspecified, defaults to 100. The maximum allowed value is 1000.
598
595
  * Values above 1000 will be coerced to 1000.
599
596
  *
600
597
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
601
598
  * @param {string} request.pageToken
602
599
  * A page token
603
- * {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
600
+ * {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
604
601
  * received from a previous
605
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
602
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
606
603
  * call. Provide this to retrieve the subsequent page.
607
604
  *
608
605
  * When paginating, all other parameters provided to
609
- * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
606
+ * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
610
607
  * must match the call that provided the page token. Otherwise, an
611
608
  * `INVALID_ARGUMENT` error is returned.
612
609
  * @param {object} [options]
613
610
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
614
611
  * @returns {Object}
615
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
612
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
616
613
  * When you iterate the returned iterable, each element will be an object representing
617
- * {@link google.cloud.discoveryengine.v1.Document | Document}. The API will be called under the hood as needed, once per the page,
614
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}. The API will be called under the hood as needed, once per the page,
618
615
  * so you can stop the iteration when you don't need more results.
619
- * Please see the
620
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
616
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
621
617
  * for more details and examples.
622
618
  * @example <caption>include:samples/generated/v1/document_service.list_documents.js</caption>
623
619
  * region_tag:discoveryengine_v1_generated_DocumentService_ListDocuments_async