@google-cloud/discoveryengine 0.7.0 → 1.0.0

package/build/src/v1/completion_service_client.d.ts

@@ -123,7 +123,7 @@ export declare class CompletionServiceClient {
      *
      *   * `document` - Using suggestions generated from user-imported documents.
      *   * `search-history` - Using suggestions generated from the past history of
-     *   {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
      *   API calls. Do not use it when there is no traffic for Search API.
      *   * `user-event` - Using suggestions generated from user-imported search
      *   events.
@@ -132,7 +132,7 @@ export declare class CompletionServiceClient {
      *
      *   * `document` is the default model for regular dataStores.
      *   * `search-history` is the default model for
-     *   {@link google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
+     *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
      *   dataStores.
      * @param {string} request.userPseudoId
      *   A unique identifier for tracking visitors. For example, this could be
@@ -143,18 +143,17 @@ export declare class CompletionServiceClient {
      *   This field should NOT have a fixed value such as `unknown_visitor`.
      *
      *   This should be the same identifier as
-     *   {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
+     *   {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
      *   and
-     *   {@link google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
      *
      *   The field must be a UTF-8 encoded string with a length limit of 128
      *   characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.CompleteQueryResponse | CompleteQueryResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.CompleteQueryResponse|CompleteQueryResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/completion_service.complete_query.js</caption>
      * region_tag:discoveryengine_v1_generated_CompletionService_CompleteQuery_async

package/build/src/v1/document_service_client.d.ts

@@ -4,7 +4,7 @@ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, Pa
 import { Transform } from 'stream';
 import * as protos from '../../protos/protos';
 /**
- *  Service for ingesting {@link google.cloud.discoveryengine.v1.Document|Document}
+ *  Service for ingesting {@link protos.google.cloud.discoveryengine.v1.Document|Document}
  *  information of the customer's website.
  * @class
  * @memberof v1
@@ -110,27 +110,26 @@ export declare class DocumentServiceClient {
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
     /**
-     * Gets a {@link google.cloud.discoveryengine.v1.Document|Document}.
+     * Gets a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
      *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.name
      *   Required. Full resource name of
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}, such as
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}, such as
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
      *
      *   If the caller does not have permission to access the
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
      *   or not it exists, a `PERMISSION_DENIED` error is returned.
      *
-     *   If the requested {@link google.cloud.discoveryengine.v1.Document|Document} does
+     *   If the requested {@link protos.google.cloud.discoveryengine.v1.Document|Document} does
      *   not exist, a `NOT_FOUND` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document | Document}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.get_document.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_GetDocument_async
@@ -143,7 +142,7 @@ export declare class DocumentServiceClient {
     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;
     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;
     /**
-     * Creates a {@link google.cloud.discoveryengine.v1.Document|Document}.
+     * Creates a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -151,21 +150,21 @@ export declare class DocumentServiceClient {
      *   Required. The parent resource name, such as
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
      * @param {google.cloud.discoveryengine.v1.Document} request.document
-     *   Required. The {@link google.cloud.discoveryengine.v1.Document|Document} to
+     *   Required. The {@link protos.google.cloud.discoveryengine.v1.Document|Document} to
      *   create.
      * @param {string} request.documentId
      *   Required. The ID to use for the
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}, which will become the
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}, which will become the
      *   final component of the
-     *   {@link google.cloud.discoveryengine.v1.Document.name|Document.name}.
+     *   {@link protos.google.cloud.discoveryengine.v1.Document.name|Document.name}.
      *
      *   If the caller does not have permission to create the
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
      *   or not it exists, a `PERMISSION_DENIED` error is returned.
      *
      *   This field must be unique among all
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}s with the same
-     *   {@link google.cloud.discoveryengine.v1.CreateDocumentRequest.parent|parent}.
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}s with the same
+     *   {@link protos.google.cloud.discoveryengine.v1.CreateDocumentRequest.parent|parent}.
      *   Otherwise, an `ALREADY_EXISTS` error is returned.
      *
      *   This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
@@ -174,9 +173,8 @@ export declare class DocumentServiceClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document | Document}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.create_document.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_CreateDocument_async
@@ -189,7 +187,7 @@ export declare class DocumentServiceClient {
     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;
     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;
     /**
-     * Updates a {@link google.cloud.discoveryengine.v1.Document|Document}.
+     * Updates a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -197,23 +195,22 @@ export declare class DocumentServiceClient {
      *   Required. The document to update/create.
      *
      *   If the caller does not have permission to update the
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
      *   or not it exists, a `PERMISSION_DENIED` error is returned.
      *
-     *   If the {@link google.cloud.discoveryengine.v1.Document|Document} to update does
+     *   If the {@link protos.google.cloud.discoveryengine.v1.Document|Document} to update does
      *   not exist and
-     *   {@link google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing|allow_missing}
+     *   {@link protos.google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing|allow_missing}
      *   is not set, a `NOT_FOUND` error is returned.
      * @param {boolean} request.allowMissing
      *   If set to true, and the
-     *   {@link google.cloud.discoveryengine.v1.Document|Document} is not found, a new
-     *   {@link google.cloud.discoveryengine.v1.Document|Document} will be created.
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document} is not found, a new
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document} will be created.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document | Document}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.update_document.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_UpdateDocument_async
@@ -226,27 +223,26 @@ export declare class DocumentServiceClient {
     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;
     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;
     /**
-     * Deletes a {@link google.cloud.discoveryengine.v1.Document|Document}.
+     * Deletes a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
      *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.name
      *   Required. Full resource name of
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}, such as
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}, such as
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
      *
      *   If the caller does not have permission to delete the
-     *   {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
      *   or not it exists, a `PERMISSION_DENIED` error is returned.
      *
-     *   If the {@link google.cloud.discoveryengine.v1.Document|Document} to delete does
+     *   If the {@link protos.google.cloud.discoveryengine.v1.Document|Document} to delete does
      *   not exist, a `NOT_FOUND` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.protobuf.Empty | Empty}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.delete_document.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_DeleteDocument_async
@@ -260,11 +256,11 @@ export declare class DocumentServiceClient {
     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;
     /**
      * Bulk import of multiple
-     * {@link google.cloud.discoveryengine.v1.Document|Document}s. Request processing
+     * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s. Request processing
      * may be synchronous. Non-existing items will be created.
      *
      * Note: It is possible for a subset of the
-     * {@link google.cloud.discoveryengine.v1.Document|Document}s to be successfully
+     * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to be successfully
      * updated.
      *
      * @param {Object} request
@@ -284,52 +280,52 @@ export declare class DocumentServiceClient {
      * @param {google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode} request.reconciliationMode
      *   The mode of reconciliation between existing documents and the documents to
      *   be imported. Defaults to
-     *   {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
+     *   {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
      * @param {boolean} request.autoGenerateIds
      *   Whether to automatically generate IDs for the documents if absent.
      *
      *   If set to `true`,
-     *   {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s are
+     *   {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s are
      *   automatically generated based on the hash of the payload, where IDs may not
      *   be consistent during multiple imports. In which case
-     *   {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
+     *   {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
      *   is highly recommended to avoid duplicate contents. If unset or set to
-     *   `false`, {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s have
+     *   `false`, {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s have
      *   to be specified using
-     *   {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field|id_field},
+     *   {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field|id_field},
      *   otherwises, documents without IDs will fail to be imported.
      *
      *   Only set this field when using
-     *   {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
-     *   {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
-     *   {@link google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
+     *   {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
+     *   {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
+     *   {@link protos.google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
      *   or
-     *   {@link google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
+     *   {@link protos.google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
      *   is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
      * @param {string} request.idField
      *   The field in the Cloud Storage and BigQuery sources that indicates the
      *   unique IDs of the documents.
      *
-     *   For {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} it is the key of
+     *   For {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} it is the key of
      *   the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
-     *   For {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource} it is
+     *   For {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource} it is
      *   the column name of the BigQuery table where the unique ids are stored.
      *
      *   The values of the JSON field or the BigQuery column will be used as the
-     *   {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s. The JSON field
+     *   {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s. The JSON field
      *   or the BigQuery column must be of string type, and the values must be set
      *   as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
      *   with 1-63 characters. Otherwise, documents without valid IDs will fail to
      *   be imported.
      *
      *   Only set this field when using
-     *   {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
-     *   {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
-     *   {@link google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
+     *   {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
+     *   {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
+     *   {@link protos.google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
      *   or
-     *   {@link google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
+     *   {@link protos.google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
      *   is `custom`. And only set this field when
-     *   {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
+     *   {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
      *   is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
      *
      *   If it is unset, a default value `_id` is used when importing from the
@@ -340,8 +336,7 @@ export declare class DocumentServiceClient {
      *   The first element of the array is an object representing
      *   a long running operation. Its `promise()` method returns a promise
      *   you can `await` for.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
@@ -359,8 +354,7 @@ export declare class DocumentServiceClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
@@ -368,20 +362,20 @@ export declare class DocumentServiceClient {
     checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1.ImportDocumentsMetadata>>;
     /**
      * Permanently deletes all selected
-     * {@link google.cloud.discoveryengine.v1.Document|Document}s in a branch.
+     * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s in a branch.
      *
      * This process is asynchronous. Depending on the number of
-     * {@link google.cloud.discoveryengine.v1.Document|Document}s to be deleted, this
+     * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to be deleted, this
      * operation can take hours to complete. Before the delete operation
-     * completes, some {@link google.cloud.discoveryengine.v1.Document|Document}s might
+     * completes, some {@link protos.google.cloud.discoveryengine.v1.Document|Document}s might
      * still be returned by
-     * {@link google.cloud.discoveryengine.v1.DocumentService.GetDocument|DocumentService.GetDocument}
+     * {@link protos.google.cloud.discoveryengine.v1.DocumentService.GetDocument|DocumentService.GetDocument}
      * or
-     * {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}.
+     * {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}.
      *
-     * To get a list of the {@link google.cloud.discoveryengine.v1.Document|Document}s
+     * To get a list of the {@link protos.google.cloud.discoveryengine.v1.Document|Document}s
      * to be deleted, set
-     * {@link google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
+     * {@link protos.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
      * to false.
      *
      * @param {Object} request
@@ -402,8 +396,7 @@ export declare class DocumentServiceClient {
      *   The first element of the array is an object representing
      *   a long running operation. Its `promise()` method returns a promise
      *   you can `await` for.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
@@ -421,15 +414,14 @@ export declare class DocumentServiceClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
      */
     checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1.PurgeDocumentsMetadata>>;
     /**
-     * Gets a list of {@link google.cloud.discoveryengine.v1.Document|Document}s.
+     * Gets a list of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -439,37 +431,36 @@ export declare class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link |Documents}s under this
+     *   If the caller does not have permission to list {@link protos.|Documents}s under this
      *   branch, regardless of whether or not this branch exists, a
      *   `PERMISSION_DENIED` error is returned.
      * @param {number} request.pageSize
-     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
      *   Values above 1000 will be coerced to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
      *   A page token
-     *   {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
+     *   {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
      *   received from a previous
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   must match the call that provided the page token. Otherwise, an
      *   `INVALID_ARGUMENT` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is Array of {@link google.cloud.discoveryengine.v1.Document | Document}.
+     *   The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed and will merge results from all the pages into this array.
      *   Note that it can affect your quota.
      *   We recommend using `listDocumentsAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listDocuments(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Promise<[
@@ -489,36 +480,35 @@ export declare class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link |Documents}s under this
+     *   If the caller does not have permission to list {@link protos.|Documents}s under this
      *   branch, regardless of whether or not this branch exists, a
      *   `PERMISSION_DENIED` error is returned.
      * @param {number} request.pageSize
-     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
      *   Values above 1000 will be coerced to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
      *   A page token
-     *   {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
+     *   {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
      *   received from a previous
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   must match the call that provided the page token. Otherwise, an
      *   `INVALID_ARGUMENT` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
-     *   An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Document | Document} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document} on 'data' event.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed. Note that it can affect your quota.
      *   We recommend using `listDocumentsAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listDocumentsStream(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Transform;
@@ -534,35 +524,34 @@ export declare class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link |Documents}s under this
+     *   If the caller does not have permission to list {@link protos.|Documents}s under this
      *   branch, regardless of whether or not this branch exists, a
      *   `PERMISSION_DENIED` error is returned.
      * @param {number} request.pageSize
-     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
      *   Values above 1000 will be coerced to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
      *   A page token
-     *   {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
+     *   {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
      *   received from a previous
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   must match the call that provided the page token. Otherwise, an
      *   `INVALID_ARGUMENT` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
-     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
      *   When you iterate the returned iterable, each element will be an object representing
-     *   {@link google.cloud.discoveryengine.v1.Document | Document}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}. The API will be called under the hood as needed, once per the page,
      *   so you can stop the iteration when you don't need more results.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.list_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_ListDocuments_async

package/build/src/v1/document_service_client.js

@@ -27,7 +27,7 @@ const jsonProtos = require("../../protos/protos.json");
 const gapicConfig = require("./document_service_client_config.json");
 const version = require('../../../package.json').version;
 /**
- *  Service for ingesting {@link google.cloud.discoveryengine.v1.Document|Document}
+ *  Service for ingesting {@link protos.google.cloud.discoveryengine.v1.Document|Document}
  *  information of the customer's website.
  * @class
  * @memberof v1
@@ -448,8 +448,7 @@ class DocumentServiceClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
@@ -487,8 +486,7 @@ class DocumentServiceClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
@@ -530,36 +528,35 @@ class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link |Documents}s under this
+     *   If the caller does not have permission to list {@link protos.|Documents}s under this
      *   branch, regardless of whether or not this branch exists, a
      *   `PERMISSION_DENIED` error is returned.
      * @param {number} request.pageSize
-     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
      *   Values above 1000 will be coerced to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
      *   A page token
-     *   {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
+     *   {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
      *   received from a previous
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   must match the call that provided the page token. Otherwise, an
      *   `INVALID_ARGUMENT` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
-     *   An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Document | Document} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document} on 'data' event.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed. Note that it can affect your quota.
      *   We recommend using `listDocumentsAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listDocumentsStream(request, options) {
@@ -589,35 +586,34 @@ class DocumentServiceClient {
      *   Use `default_branch` as the branch ID, to list documents under the default
      *   branch.
      *
-     *   If the caller does not have permission to list {@link |Documents}s under this
+     *   If the caller does not have permission to list {@link protos.|Documents}s under this
      *   branch, regardless of whether or not this branch exists, a
      *   `PERMISSION_DENIED` error is returned.
      * @param {number} request.pageSize
-     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
      *   return. If unspecified, defaults to 100. The maximum allowed value is 1000.
      *   Values above 1000 will be coerced to 1000.
      *
      *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
      * @param {string} request.pageToken
      *   A page token
-     *   {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
+     *   {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
      *   received from a previous
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
+     *   {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
      *   must match the call that provided the page token. Otherwise, an
      *   `INVALID_ARGUMENT` error is returned.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
-     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
      *   When you iterate the returned iterable, each element will be an object representing
-     *   {@link google.cloud.discoveryengine.v1.Document | Document}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document}. The API will be called under the hood as needed, once per the page,
      *   so you can stop the iteration when you don't need more results.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/document_service.list_documents.js</caption>
      * region_tag:discoveryengine_v1_generated_DocumentService_ListDocuments_async