@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
@@ -5,7 +5,7 @@ import { Transform } from 'stream';
5
5
  import * as protos from '../../protos/protos';
6
6
  /**
7
7
  * Service for ingesting
8
- * {@link google.cloud.discoveryengine.v1beta.Document|Document} information of the
8
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} information of the
9
9
  * customer's website.
10
10
  * @class
11
11
  * @memberof v1beta
@@ -111,27 +111,26 @@ export declare class DocumentServiceClient {
111
111
  getProjectId(): Promise<string>;
112
112
  getProjectId(callback: Callback<string, undefined, undefined>): void;
113
113
  /**
114
- * Gets a {@link google.cloud.discoveryengine.v1beta.Document|Document}.
114
+ * Gets a {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
115
115
  *
116
116
  * @param {Object} request
117
117
  * The request object that will be sent.
118
118
  * @param {string} request.name
119
119
  * Required. Full resource name of
120
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}, such as
120
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}, such as
121
121
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
122
122
  *
123
123
  * If the caller does not have permission to access the
124
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
124
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
125
125
  * whether or not it exists, a `PERMISSION_DENIED` error is returned.
126
126
  *
127
- * If the requested {@link google.cloud.discoveryengine.v1beta.Document|Document}
127
+ * If the requested {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
128
128
  * does not exist, a `NOT_FOUND` error is returned.
129
129
  * @param {object} [options]
130
130
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
131
131
  * @returns {Promise} - The promise which resolves to an array.
132
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1beta.Document | Document}.
133
- * Please see the
134
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
132
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
133
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
135
134
  * for more details and examples.
136
135
  * @example <caption>include:samples/generated/v1beta/document_service.get_document.js</caption>
137
136
  * region_tag:discoveryengine_v1beta_generated_DocumentService_GetDocument_async
@@ -144,7 +143,7 @@ export declare class DocumentServiceClient {
144
143
  getDocument(request: protos.google.cloud.discoveryengine.v1beta.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDocument, protos.google.cloud.discoveryengine.v1beta.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
145
144
  getDocument(request: protos.google.cloud.discoveryengine.v1beta.IGetDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDocument, protos.google.cloud.discoveryengine.v1beta.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
146
145
  /**
147
- * Creates a {@link google.cloud.discoveryengine.v1beta.Document|Document}.
146
+ * Creates a {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
148
147
  *
149
148
  * @param {Object} request
150
149
  * The request object that will be sent.
@@ -152,21 +151,21 @@ export declare class DocumentServiceClient {
152
151
  * Required. The parent resource name, such as
153
152
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
154
153
  * @param {google.cloud.discoveryengine.v1beta.Document} request.document
155
- * Required. The {@link google.cloud.discoveryengine.v1beta.Document|Document} to
154
+ * Required. The {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} to
156
155
  * create.
157
156
  * @param {string} request.documentId
158
157
  * Required. The ID to use for the
159
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}, which will become
158
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}, which will become
160
159
  * the final component of the
161
- * {@link google.cloud.discoveryengine.v1beta.Document.name|Document.name}.
160
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document.name|Document.name}.
162
161
  *
163
162
  * If the caller does not have permission to create the
164
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
163
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
165
164
  * whether or not it exists, a `PERMISSION_DENIED` error is returned.
166
165
  *
167
166
  * This field must be unique among all
168
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}s with the same
169
- * {@link google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent|parent}.
167
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s with the same
168
+ * {@link protos.google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent|parent}.
170
169
  * Otherwise, an `ALREADY_EXISTS` error is returned.
171
170
  *
172
171
  * This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
@@ -175,9 +174,8 @@ export declare class DocumentServiceClient {
175
174
  * @param {object} [options]
176
175
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
177
176
  * @returns {Promise} - The promise which resolves to an array.
178
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1beta.Document | Document}.
179
- * Please see the
180
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
177
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
178
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
181
179
  * for more details and examples.
182
180
  * @example <caption>include:samples/generated/v1beta/document_service.create_document.js</caption>
183
181
  * region_tag:discoveryengine_v1beta_generated_DocumentService_CreateDocument_async
@@ -190,7 +188,7 @@ export declare class DocumentServiceClient {
190
188
  createDocument(request: protos.google.cloud.discoveryengine.v1beta.ICreateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDocument, protos.google.cloud.discoveryengine.v1beta.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
191
189
  createDocument(request: protos.google.cloud.discoveryengine.v1beta.ICreateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDocument, protos.google.cloud.discoveryengine.v1beta.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
192
190
  /**
193
- * Updates a {@link google.cloud.discoveryengine.v1beta.Document|Document}.
191
+ * Updates a {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
194
192
  *
195
193
  * @param {Object} request
196
194
  * The request object that will be sent.
@@ -198,24 +196,23 @@ export declare class DocumentServiceClient {
198
196
  * Required. The document to update/create.
199
197
  *
200
198
  * If the caller does not have permission to update the
201
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
199
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
202
200
  * whether or not it exists, a `PERMISSION_DENIED` error is returned.
203
201
  *
204
- * If the {@link google.cloud.discoveryengine.v1beta.Document|Document} to update
202
+ * If the {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} to update
205
203
  * does not exist and
206
- * {@link google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing|allow_missing}
204
+ * {@link protos.google.cloud.discoveryengine.v1beta.UpdateDocumentRequest.allow_missing|allow_missing}
207
205
  * is not set, a `NOT_FOUND` error is returned.
208
206
  * @param {boolean} request.allowMissing
209
207
  * If set to true, and the
210
- * {@link google.cloud.discoveryengine.v1beta.Document|Document} is not found, a
211
- * new {@link google.cloud.discoveryengine.v1beta.Document|Document} will be
208
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} is not found, a
209
+ * new {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} will be
212
210
  * created.
213
211
  * @param {object} [options]
214
212
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
215
213
  * @returns {Promise} - The promise which resolves to an array.
216
- * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1beta.Document | Document}.
217
- * Please see the
218
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
214
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
215
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
219
216
  * for more details and examples.
220
217
  * @example <caption>include:samples/generated/v1beta/document_service.update_document.js</caption>
221
218
  * region_tag:discoveryengine_v1beta_generated_DocumentService_UpdateDocument_async
@@ -228,27 +225,26 @@ export declare class DocumentServiceClient {
228
225
  updateDocument(request: protos.google.cloud.discoveryengine.v1beta.IUpdateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDocument, protos.google.cloud.discoveryengine.v1beta.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
229
226
  updateDocument(request: protos.google.cloud.discoveryengine.v1beta.IUpdateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDocument, protos.google.cloud.discoveryengine.v1beta.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
230
227
  /**
231
- * Deletes a {@link google.cloud.discoveryengine.v1beta.Document|Document}.
228
+ * Deletes a {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
232
229
  *
233
230
  * @param {Object} request
234
231
  * The request object that will be sent.
235
232
  * @param {string} request.name
236
233
  * Required. Full resource name of
237
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}, such as
234
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}, such as
238
235
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
239
236
  *
240
237
  * If the caller does not have permission to delete the
241
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
238
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}, regardless of
242
239
  * whether or not it exists, a `PERMISSION_DENIED` error is returned.
243
240
  *
244
- * If the {@link google.cloud.discoveryengine.v1beta.Document|Document} to delete
241
+ * If the {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} to delete
245
242
  * does not exist, a `NOT_FOUND` error is returned.
246
243
  * @param {object} [options]
247
244
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
248
245
  * @returns {Promise} - The promise which resolves to an array.
249
- * The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
250
- * Please see the
251
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
246
+ * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
247
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
252
248
  * for more details and examples.
253
249
  * @example <caption>include:samples/generated/v1beta/document_service.delete_document.js</caption>
254
250
  * region_tag:discoveryengine_v1beta_generated_DocumentService_DeleteDocument_async
@@ -262,11 +258,11 @@ export declare class DocumentServiceClient {
262
258
  deleteDocument(request: protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1beta.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
263
259
  /**
264
260
  * Bulk import of multiple
265
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}s. Request
261
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s. Request
266
262
  * processing may be synchronous. Non-existing items will be created.
267
263
  *
268
264
  * Note: It is possible for a subset of the
269
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}s to be
265
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s to be
270
266
  * successfully updated.
271
267
  *
272
268
  * @param {Object} request
@@ -286,55 +282,55 @@ export declare class DocumentServiceClient {
286
282
  * @param {google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode} request.reconciliationMode
287
283
  * The mode of reconciliation between existing documents and the documents to
288
284
  * be imported. Defaults to
289
- * {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
285
+ * {@link protos.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
290
286
  * @param {boolean} request.autoGenerateIds
291
287
  * Whether to automatically generate IDs for the documents if absent.
292
288
  *
293
289
  * If set to `true`,
294
- * {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s are
290
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document.id|Document.id}s are
295
291
  * automatically generated based on the hash of the payload, where IDs may not
296
292
  * be consistent during multiple imports. In which case
297
- * {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
293
+ * {@link protos.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
298
294
  * is highly recommended to avoid duplicate contents. If unset or set to
299
- * `false`, {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s
295
+ * `false`, {@link protos.google.cloud.discoveryengine.v1beta.Document.id|Document.id}s
300
296
  * have to be specified using
301
- * {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field|id_field},
302
- * otherwises, documents without IDs will fail to be imported.
297
+ * {@link protos.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field|id_field},
298
+ * otherwise, documents without IDs fail to be imported.
303
299
  *
304
300
  * Only set this field when using
305
- * {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
306
- * {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
301
+ * {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
302
+ * {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
307
303
  * when
308
- * {@link google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
304
+ * {@link protos.google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
309
305
  * or
310
- * {@link google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
311
- * is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
306
+ * {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
307
+ * is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
312
308
  * @param {string} request.idField
313
309
  * The field in the Cloud Storage and BigQuery sources that indicates the
314
310
  * unique IDs of the documents.
315
311
  *
316
- * For {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} it is the
312
+ * For {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} it is the
317
313
  * key of the JSON field. For instance, `my_id` for JSON `{"my_id":
318
314
  * "some_uuid"}`. For
319
- * {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource} it is
315
+ * {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource} it is
320
316
  * the column name of the BigQuery table where the unique ids are stored.
321
317
  *
322
- * The values of the JSON field or the BigQuery column will be used as the
323
- * {@link google.cloud.discoveryengine.v1beta.Document.id|Document.id}s. The JSON
318
+ * The values of the JSON field or the BigQuery column are used as the
319
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document.id|Document.id}s. The JSON
324
320
  * field or the BigQuery column must be of string type, and the values must be
325
321
  * set as valid strings conform to
326
322
  * [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
327
- * Otherwise, documents without valid IDs will fail to be imported.
323
+ * Otherwise, documents without valid IDs fail to be imported.
328
324
  *
329
325
  * Only set this field when using
330
- * {@link google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
331
- * {@link google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
326
+ * {@link protos.google.cloud.discoveryengine.v1beta.GcsSource|GcsSource} or
327
+ * {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource|BigQuerySource}, and
332
328
  * when
333
- * {@link google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
329
+ * {@link protos.google.cloud.discoveryengine.v1beta.GcsSource.data_schema|GcsSource.data_schema}
334
330
  * or
335
- * {@link google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
331
+ * {@link protos.google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema|BigQuerySource.data_schema}
336
332
  * is `custom`. And only set this field when
337
- * {@link google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
333
+ * {@link protos.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
338
334
  * is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
339
335
  *
340
336
  * If it is unset, a default value `_id` is used when importing from the
@@ -345,8 +341,7 @@ export declare class DocumentServiceClient {
345
341
  * The first element of the array is an object representing
346
342
  * a long running operation. Its `promise()` method returns a promise
347
343
  * you can `await` for.
348
- * Please see the
349
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
344
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
350
345
  * for more details and examples.
351
346
  * @example <caption>include:samples/generated/v1beta/document_service.import_documents.js</caption>
352
347
  * region_tag:discoveryengine_v1beta_generated_DocumentService_ImportDocuments_async
@@ -364,8 +359,7 @@ export declare class DocumentServiceClient {
364
359
  * The operation name that will be passed.
365
360
  * @returns {Promise} - The promise which resolves to an object.
366
361
  * The decoded operation object has result and metadata field to get information from.
367
- * Please see the
368
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
362
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
369
363
  * for more details and examples.
370
364
  * @example <caption>include:samples/generated/v1beta/document_service.import_documents.js</caption>
371
365
  * region_tag:discoveryengine_v1beta_generated_DocumentService_ImportDocuments_async
@@ -373,21 +367,21 @@ export declare class DocumentServiceClient {
373
367
  checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata>>;
374
368
  /**
375
369
  * Permanently deletes all selected
376
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}s in a branch.
370
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s in a branch.
377
371
  *
378
372
  * This process is asynchronous. Depending on the number of
379
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
373
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
380
374
  * this operation can take hours to complete. Before the delete operation
381
- * completes, some {@link google.cloud.discoveryengine.v1beta.Document|Document}s
375
+ * completes, some {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
382
376
  * might still be returned by
383
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.GetDocument|DocumentService.GetDocument}
377
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.GetDocument|DocumentService.GetDocument}
384
378
  * or
385
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}.
379
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}.
386
380
  *
387
381
  * To get a list of the
388
- * {@link google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
382
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
389
383
  * set
390
- * {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
384
+ * {@link protos.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
391
385
  * to false.
392
386
  *
393
387
  * @param {Object} request
@@ -408,8 +402,7 @@ export declare class DocumentServiceClient {
408
402
  * The first element of the array is an object representing
409
403
  * a long running operation. Its `promise()` method returns a promise
410
404
  * you can `await` for.
411
- * Please see the
412
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
405
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
413
406
  * for more details and examples.
414
407
  * @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
415
408
  * region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
@@ -427,15 +420,14 @@ export declare class DocumentServiceClient {
427
420
  * The operation name that will be passed.
428
421
  * @returns {Promise} - The promise which resolves to an object.
429
422
  * The decoded operation object has result and metadata field to get information from.
430
- * Please see the
431
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
423
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
432
424
  * for more details and examples.
433
425
  * @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
434
426
  * region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
435
427
  */
436
428
  checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata>>;
437
429
  /**
438
- * Gets a list of {@link google.cloud.discoveryengine.v1beta.Document|Document}s.
430
+ * Gets a list of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s.
439
431
  *
440
432
  * @param {Object} request
441
433
  * The request object that will be sent.
@@ -445,37 +437,37 @@ export declare class DocumentServiceClient {
445
437
  * Use `default_branch` as the branch ID, to list documents under the default
446
438
  * branch.
447
439
  *
448
- * If the caller does not have permission to list {@link |Documents}s under this
440
+ * If the caller does not have permission to list
441
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s under this
449
442
  * branch, regardless of whether or not this branch exists, a
450
443
  * `PERMISSION_DENIED` error is returned.
451
444
  * @param {number} request.pageSize
452
- * Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
445
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
453
446
  * to return. If unspecified, defaults to 100. The maximum allowed value is
454
447
  * 1000. Values above 1000 will be coerced to 1000.
455
448
  *
456
449
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
457
450
  * @param {string} request.pageToken
458
451
  * A page token
459
- * {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
452
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
460
453
  * received from a previous
461
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
454
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
462
455
  * call. Provide this to retrieve the subsequent page.
463
456
  *
464
457
  * When paginating, all other parameters provided to
465
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
458
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
466
459
  * must match the call that provided the page token. Otherwise, an
467
460
  * `INVALID_ARGUMENT` error is returned.
468
461
  * @param {object} [options]
469
462
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
470
463
  * @returns {Promise} - The promise which resolves to an array.
471
- * The first element of the array is Array of {@link google.cloud.discoveryengine.v1beta.Document | Document}.
464
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}.
472
465
  * The client library will perform auto-pagination by default: it will call the API as many
473
466
  * times as needed and will merge results from all the pages into this array.
474
467
  * Note that it can affect your quota.
475
468
  * We recommend using `listDocumentsAsync()`
476
469
  * method described below for async iteration which you can stop as needed.
477
- * Please see the
478
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
470
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
479
471
  * for more details and examples.
480
472
  */
481
473
  listDocuments(request?: protos.google.cloud.discoveryengine.v1beta.IListDocumentsRequest, options?: CallOptions): Promise<[
@@ -495,36 +487,36 @@ export declare class DocumentServiceClient {
495
487
  * Use `default_branch` as the branch ID, to list documents under the default
496
488
  * branch.
497
489
  *
498
- * If the caller does not have permission to list {@link |Documents}s under this
490
+ * If the caller does not have permission to list
491
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s under this
499
492
  * branch, regardless of whether or not this branch exists, a
500
493
  * `PERMISSION_DENIED` error is returned.
501
494
  * @param {number} request.pageSize
502
- * Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
495
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
503
496
  * to return. If unspecified, defaults to 100. The maximum allowed value is
504
497
  * 1000. Values above 1000 will be coerced to 1000.
505
498
  *
506
499
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
507
500
  * @param {string} request.pageToken
508
501
  * A page token
509
- * {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
502
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
510
503
  * received from a previous
511
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
504
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
512
505
  * call. Provide this to retrieve the subsequent page.
513
506
  *
514
507
  * When paginating, all other parameters provided to
515
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
508
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
516
509
  * must match the call that provided the page token. Otherwise, an
517
510
  * `INVALID_ARGUMENT` error is returned.
518
511
  * @param {object} [options]
519
512
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
520
513
  * @returns {Stream}
521
- * An object stream which emits an object representing {@link google.cloud.discoveryengine.v1beta.Document | Document} on 'data' event.
514
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.Document|Document} on 'data' event.
522
515
  * The client library will perform auto-pagination by default: it will call the API as many
523
516
  * times as needed. Note that it can affect your quota.
524
517
  * We recommend using `listDocumentsAsync()`
525
518
  * method described below for async iteration which you can stop as needed.
526
- * Please see the
527
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
519
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
528
520
  * for more details and examples.
529
521
  */
530
522
  listDocumentsStream(request?: protos.google.cloud.discoveryengine.v1beta.IListDocumentsRequest, options?: CallOptions): Transform;
@@ -540,35 +532,35 @@ export declare class DocumentServiceClient {
540
532
  * Use `default_branch` as the branch ID, to list documents under the default
541
533
  * branch.
542
534
  *
543
- * If the caller does not have permission to list {@link |Documents}s under this
535
+ * If the caller does not have permission to list
536
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s under this
544
537
  * branch, regardless of whether or not this branch exists, a
545
538
  * `PERMISSION_DENIED` error is returned.
546
539
  * @param {number} request.pageSize
547
- * Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
540
+ * Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
548
541
  * to return. If unspecified, defaults to 100. The maximum allowed value is
549
542
  * 1000. Values above 1000 will be coerced to 1000.
550
543
  *
551
544
  * If this field is negative, an `INVALID_ARGUMENT` error is returned.
552
545
  * @param {string} request.pageToken
553
546
  * A page token
554
- * {@link google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
547
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
555
548
  * received from a previous
556
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
549
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
557
550
  * call. Provide this to retrieve the subsequent page.
558
551
  *
559
552
  * When paginating, all other parameters provided to
560
- * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
553
+ * {@link protos.google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}
561
554
  * must match the call that provided the page token. Otherwise, an
562
555
  * `INVALID_ARGUMENT` error is returned.
563
556
  * @param {object} [options]
564
557
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
565
558
  * @returns {Object}
566
- * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
559
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
567
560
  * When you iterate the returned iterable, each element will be an object representing
568
- * {@link google.cloud.discoveryengine.v1beta.Document | Document}. The API will be called under the hood as needed, once per the page,
561
+ * {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}. The API will be called under the hood as needed, once per the page,
569
562
  * so you can stop the iteration when you don't need more results.
570
- * Please see the
571
- * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
563
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
572
564
  * for more details and examples.
573
565
  * @example <caption>include:samples/generated/v1beta/document_service.list_documents.js</caption>
574
566
  * region_tag:discoveryengine_v1beta_generated_DocumentService_ListDocuments_async
@@ -805,6 +797,57 @@ export declare class DocumentServiceClient {
805
797
  * @returns {string} A string representing the document.
806
798
  */
807
799
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
800
+ /**
801
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
802
+ *
803
+ * @param {string} project
804
+ * @param {string} location
805
+ * @param {string} collection
806
+ * @param {string} data_store
807
+ * @param {string} conversation
808
+ * @returns {string} Resource name string.
809
+ */
810
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
811
+ /**
812
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
813
+ *
814
+ * @param {string} projectLocationCollectionDataStoreConversationName
815
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
816
+ * @returns {string} A string representing the project.
817
+ */
818
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
819
+ /**
820
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
821
+ *
822
+ * @param {string} projectLocationCollectionDataStoreConversationName
823
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
824
+ * @returns {string} A string representing the location.
825
+ */
826
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
827
+ /**
828
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
829
+ *
830
+ * @param {string} projectLocationCollectionDataStoreConversationName
831
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
832
+ * @returns {string} A string representing the collection.
833
+ */
834
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
835
+ /**
836
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
837
+ *
838
+ * @param {string} projectLocationCollectionDataStoreConversationName
839
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
840
+ * @returns {string} A string representing the data_store.
841
+ */
842
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
843
+ /**
844
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
845
+ *
846
+ * @param {string} projectLocationCollectionDataStoreConversationName
847
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
848
+ * @returns {string} A string representing the conversation.
849
+ */
850
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
808
851
  /**
809
852
  * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
810
853
  *
@@ -949,6 +992,48 @@ export declare class DocumentServiceClient {
949
992
  * @returns {string} A string representing the document.
950
993
  */
951
994
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
995
+ /**
996
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
997
+ *
998
+ * @param {string} project
999
+ * @param {string} location
1000
+ * @param {string} data_store
1001
+ * @param {string} conversation
1002
+ * @returns {string} Resource name string.
1003
+ */
1004
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
1005
+ /**
1006
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1007
+ *
1008
+ * @param {string} projectLocationDataStoreConversationName
1009
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1010
+ * @returns {string} A string representing the project.
1011
+ */
1012
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1013
+ /**
1014
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1015
+ *
1016
+ * @param {string} projectLocationDataStoreConversationName
1017
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1018
+ * @returns {string} A string representing the location.
1019
+ */
1020
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1021
+ /**
1022
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1023
+ *
1024
+ * @param {string} projectLocationDataStoreConversationName
1025
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1026
+ * @returns {string} A string representing the data_store.
1027
+ */
1028
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1029
+ /**
1030
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1031
+ *
1032
+ * @param {string} projectLocationDataStoreConversationName
1033
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1034
+ * @returns {string} A string representing the conversation.
1035
+ */
1036
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
952
1037
  /**
953
1038
  * Return a fully-qualified projectLocationDataStoreSchema resource name string.
954
1039
  *