@google-cloud/dialogflow/build/src/v2/documents_client.d.ts

Dialogflow API client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Service for managing knowledge
 *  {@link protos.google.cloud.dialogflow.v2.Document|Documents}.
 * @class
 * @memberof v2
 */
export declare class DocumentsClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    documentsStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of DocumentsClient.
     *
     * @param {object} [options] - The configuration object.
     * The options accepted by the constructor are described in detail
     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
     * The common options are:
     * @param {object} [options.credentials] - Credentials object.
     * @param {string} [options.credentials.client_email]
     * @param {string} [options.credentials.private_key]
     * @param {string} [options.email] - Account email address. Required when
     *     using a .pem or .p12 keyFilename.
     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
     *     .p12 key downloaded from the Google Developers Console. If you provide
     *     a path to a JSON file, the projectId option below is not necessary.
     *     NOTE: .pem and .p12 require you to specify options.email as well.
     * @param {number} [options.port] - The port on which to connect to
     *     the remote host.
     * @param {string} [options.projectId] - The project ID from the Google
     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
     *     the environment variable GCLOUD_PROJECT for your project ID. If your
     *     app is running in an environment which supports
     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
     *     your project ID will be detected automatically.
     * @param {string} [options.apiEndpoint] - The domain name of the
     *     API remote host.
     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
     *     Follows the structure of {@link gapicConfig}.
     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
     *     For more information, please check the
     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
     *     need to avoid loading the default gRPC version and want to use the fallback
     *     HTTP implementation. Load only fallback version and pass it to the constructor:
     *     ```
     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
     *     const client = new DocumentsClient({fallback: true}, gax);
     *     ```
     */
    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * Initialize the client.
     * Performs asynchronous operations (such as authentication) and prepares the client.
     * This function will be called automatically when any class method is called for the
     * first time, but if you need to initialize it before calling an actual method,
     * feel free to call initialize() directly.
     *
     * You can await on this method if you want to make sure the client is initialized.
     *
     * @returns {Promise} A promise that resolves to an authenticated service stub.
     */
    initialize(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * The DNS address for this API service.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get servicePath(): string;
    /**
     * The DNS address for this API service - same as servicePath.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get apiEndpoint(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Retrieves the specified document.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the document to retrieve.
     *   Format `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
     * @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 protos.google.cloud.dialogflow.v2.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/v2/documents.get_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_GetDocument_async
     */
    getDocument(request?: protos.google.cloud.dialogflow.v2.IGetDocumentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2.IDocument,
        protos.google.cloud.dialogflow.v2.IGetDocumentRequest | undefined,
        {} | undefined
    ]>;
    getDocument(request: protos.google.cloud.dialogflow.v2.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
    getDocument(request: protos.google.cloud.dialogflow.v2.IGetDocumentRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Creates a new document.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata|KnowledgeOperationMetadata}
     * - `response`: {@link protos.google.cloud.dialogflow.v2.Document|Document}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The knowledge base to create a document for.
     *   Format: `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>`.
     * @param {google.cloud.dialogflow.v2.Document} request.document
     *   Required. The document to create.
     * @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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   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/v2/documents.create_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_CreateDocument_async
     */
    createDocument(request?: protos.google.cloud.dialogflow.v2.ICreateDocumentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createDocument(request: protos.google.cloud.dialogflow.v2.ICreateDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createDocument(request: protos.google.cloud.dialogflow.v2.ICreateDocumentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `createDocument()`.
     * @param {String} name
     *   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 {@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/v2/documents.create_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_CreateDocument_async
     */
    checkCreateDocumentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.Document, protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata>>;
    /**
     * Creates documents by importing data from external sources.
     * Dialogflow supports up to 350 documents in each request. If you try to
     * import more, Dialogflow will return an error.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata|KnowledgeOperationMetadata}
     * - `response`:
     * {@link protos.google.cloud.dialogflow.v2.ImportDocumentsResponse|ImportDocumentsResponse}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The knowledge base to import documents into.
     *   Format: `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>`.
     * @param {google.cloud.dialogflow.v2.GcsSources} [request.gcsSource]
     *   Optional. The Google Cloud Storage location for the documents.
     *   The path can include a wildcard.
     *
     *   These URIs may have the forms
     *   `gs://<bucket-name>/<object-name>`.
     *   `gs://<bucket-name>/<object-path>/*.<extension>`.
     * @param {google.cloud.dialogflow.v2.ImportDocumentTemplate} request.documentTemplate
     *   Required. Document template used for importing all the documents.
     * @param {boolean} request.importGcsCustomMetadata
     *   Whether to import custom metadata from Google Cloud Storage.
     *   Only valid when the document source is Google Cloud Storage URI.
     * @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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   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/v2/documents.import_documents.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_ImportDocuments_async
     */
    importDocuments(request?: protos.google.cloud.dialogflow.v2.IImportDocumentsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.v2.IImportDocumentsResponse, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    importDocuments(request: protos.google.cloud.dialogflow.v2.IImportDocumentsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IImportDocumentsResponse, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    importDocuments(request: protos.google.cloud.dialogflow.v2.IImportDocumentsRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IImportDocumentsResponse, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `importDocuments()`.
     * @param {String} name
     *   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 {@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/v2/documents.import_documents.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_ImportDocuments_async
     */
    checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.ImportDocumentsResponse, protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata>>;
    /**
     * Deletes the specified document.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata|KnowledgeOperationMetadata}
     * - `response`: An [Empty
     *   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the document to delete.
     *   Format: `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
     * @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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   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/v2/documents.delete_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_DeleteDocument_async
     */
    deleteDocument(request?: protos.google.cloud.dialogflow.v2.IDeleteDocumentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteDocument(request: protos.google.cloud.dialogflow.v2.IDeleteDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteDocument(request: protos.google.cloud.dialogflow.v2.IDeleteDocumentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteDocument()`.
     * @param {String} name
     *   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 {@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/v2/documents.delete_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_DeleteDocument_async
     */
    checkDeleteDocumentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata>>;
    /**
     * Updates the specified document.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata|KnowledgeOperationMetadata}
     * - `response`: {@link protos.google.cloud.dialogflow.v2.Document|Document}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.dialogflow.v2.Document} request.document
     *   Required. The document to update.
     * @param {google.protobuf.FieldMask} [request.updateMask]
     *   Optional. Not specified means `update all`.
     *   Currently, only `display_name` can be updated, an InvalidArgument will be
     *   returned for attempting to update other fields.
     * @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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   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/v2/documents.update_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_UpdateDocument_async
     */
    updateDocument(request?: protos.google.cloud.dialogflow.v2.IUpdateDocumentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateDocument(request: protos.google.cloud.dialogflow.v2.IUpdateDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateDocument(request: protos.google.cloud.dialogflow.v2.IUpdateDocumentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `updateDocument()`.
     * @param {String} name
     *   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 {@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/v2/documents.update_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_UpdateDocument_async
     */
    checkUpdateDocumentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.Document, protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata>>;
    /**
     * Reloads the specified document from its specified source, content_uri or
     * content. The previously loaded content of the document will be deleted.
     * Note: Even when the content of the document has not changed, there still
     * may be side effects because of internal implementation changes.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata|KnowledgeOperationMetadata}
     * - `response`: {@link protos.google.cloud.dialogflow.v2.Document|Document}
     *
     * Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
     * only use `projects.knowledgeBases.documents`.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the document to reload.
     *   Format: `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
     * @param {string} [request.contentUri]
     *   Optional. The path of gcs source file for reloading document content. For
     *   now, only gcs uri is supported.
     *
     *   For documents stored in Google Cloud Storage, these URIs must have
     *   the form `gs://<bucket-name>/<object-name>`.
     * @param {boolean} [request.importGcsCustomMetadata]
     *   Optional. Whether to import custom metadata from Google Cloud Storage.
     *   Only valid when the document source is Google Cloud Storage URI.
     * @param {boolean} [request.smartMessagingPartialUpdate]
     *   Optional. When enabled, the reload request is to apply partial update to
     *   the smart messaging allowlist.
     * @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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   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/v2/documents.reload_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_ReloadDocument_async
     */
    reloadDocument(request?: protos.google.cloud.dialogflow.v2.IReloadDocumentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    reloadDocument(request: protos.google.cloud.dialogflow.v2.IReloadDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    reloadDocument(request: protos.google.cloud.dialogflow.v2.IReloadDocumentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `reloadDocument()`.
     * @param {String} name
     *   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 {@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/v2/documents.reload_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_ReloadDocument_async
     */
    checkReloadDocumentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.Document, protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata>>;
    /**
     * Exports a smart messaging candidate document into the specified
     * destination.
     *
     * This method is a [long-running
     * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
     * The returned `Operation` type has the following method-specific fields:
     *
     * - `metadata`:
     * {@link protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata|KnowledgeOperationMetadata}
     * - `response`: {@link protos.google.cloud.dialogflow.v2.Document|Document}
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. The name of the document to export.
     *   Format: `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
     * @param {google.cloud.dialogflow.v2.GcsDestination} request.gcsDestination
     *   Cloud Storage file path to export the document.
     * @param {boolean} request.exportFullContent
     *   When enabled, export the full content of the document including empirical
     *   probability.
     * @param {boolean} request.smartMessagingPartialUpdate
     *   When enabled, export the smart messaging allowlist document for partial
     *   update.
     * @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
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   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/v2/documents.export_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_ExportDocument_async
     */
    exportDocument(request?: protos.google.cloud.dialogflow.v2.IExportDocumentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    exportDocument(request: protos.google.cloud.dialogflow.v2.IExportDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    exportDocument(request: protos.google.cloud.dialogflow.v2.IExportDocumentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IDocument, protos.google.cloud.dialogflow.v2.IKnowledgeOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `exportDocument()`.
     * @param {String} name
     *   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 {@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/v2/documents.export_document.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_ExportDocument_async
     */
    checkExportDocumentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.Document, protos.google.cloud.dialogflow.v2.KnowledgeOperationMetadata>>;
    /**
    * Returns the list of all documents of the knowledge base.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The knowledge base to list all documents for.
    *   Format: `projects/<Project ID>/locations/<Location
    *   ID>/knowledgeBases/<Knowledge Base ID>`.
    * @param {number} request.pageSize
    *   The maximum number of items to return in a single page. By
    *   default 10 and at most 100.
    * @param {string} request.pageToken
    *   The next_page_token value returned from a previous list request.
    * @param {string} request.filter
    *   The filter expression used to filter documents returned by the list method.
    *   The expression has the following syntax:
    *
    *     <field> <operator> <value> [AND <field> <operator> <value>] ...
    *
    *   The following fields and operators are supported:
    *
    *   * knowledge_types with has(:) operator
    *   * display_name with has(:) operator
    *   * state with equals(=) operator
    *
    *   Examples:
    *
    *   * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
    *   * "display_name:customer" matches documents whose display name contains
    *     "customer".
    *   * "state=ACTIVE" matches documents with ACTIVE state.
    *   * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
    *
    *   For more information about filtering, see
    *   [API Filtering](https://aip.dev/160).
    * @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 protos.google.cloud.dialogflow.v2.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 {@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.dialogflow.v2.IListDocumentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2.IDocument[],
        protos.google.cloud.dialogflow.v2.IListDocumentsRequest | null,
        protos.google.cloud.dialogflow.v2.IListDocumentsResponse
    ]>;
    listDocuments(request: protos.google.cloud.dialogflow.v2.IListDocumentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListDocumentsRequest, protos.google.cloud.dialogflow.v2.IListDocumentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IDocument>): void;
    listDocuments(request: protos.google.cloud.dialogflow.v2.IListDocumentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListDocumentsRequest, protos.google.cloud.dialogflow.v2.IListDocumentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IDocument>): void;
    /**
     * Equivalent to `listDocuments`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The knowledge base to list all documents for.
     *   Format: `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By
     *   default 10 and at most 100.
     * @param {string} request.pageToken
     *   The next_page_token value returned from a previous list request.
     * @param {string} request.filter
     *   The filter expression used to filter documents returned by the list method.
     *   The expression has the following syntax:
     *
     *     <field> <operator> <value> [AND <field> <operator> <value>] ...
     *
     *   The following fields and operators are supported:
     *
     *   * knowledge_types with has(:) operator
     *   * display_name with has(:) operator
     *   * state with equals(=) operator
     *
     *   Examples:
     *
     *   * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
     *   * "display_name:customer" matches documents whose display name contains
     *     "customer".
     *   * "state=ACTIVE" matches documents with ACTIVE state.
     *   * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
     *
     *   For more information about filtering, see
     *   [API Filtering](https://aip.dev/160).
     * @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 protos.google.cloud.dialogflow.v2.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 {@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.dialogflow.v2.IListDocumentsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listDocuments`, but returns an iterable object.
     *
     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The knowledge base to list all documents for.
     *   Format: `projects/<Project ID>/locations/<Location
     *   ID>/knowledgeBases/<Knowledge Base ID>`.
     * @param {number} request.pageSize
     *   The maximum number of items to return in a single page. By
     *   default 10 and at most 100.
     * @param {string} request.pageToken
     *   The next_page_token value returned from a previous list request.
     * @param {string} request.filter
     *   The filter expression used to filter documents returned by the list method.
     *   The expression has the following syntax:
     *
     *     <field> <operator> <value> [AND <field> <operator> <value>] ...
     *
     *   The following fields and operators are supported:
     *
     *   * knowledge_types with has(:) operator
     *   * display_name with has(:) operator
     *   * state with equals(=) operator
     *
     *   Examples:
     *
     *   * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
     *   * "display_name:customer" matches documents whose display name contains
     *     "customer".
     *   * "state=ACTIVE" matches documents with ACTIVE state.
     *   * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
     *
     *   For more information about filtering, see
     *   [API Filtering](https://aip.dev/160).
     * @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 {@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 protos.google.cloud.dialogflow.v2.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 {@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/v2/documents.list_documents.js</caption>
     * region_tag:dialogflow_v2_generated_Documents_ListDocuments_async
     */
    listDocumentsAsync(request?: protos.google.cloud.dialogflow.v2.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IDocument>;
    /**
       * Gets information about a location.
       *
       * @param {Object} request
       *   The request object that will be sent.
       * @param {string} request.name
       *   Resource name for the location.
       * @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.location.Location | Location}.
       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
       *   for more details and examples.
       * @example
       * ```
       * const [response] = await client.getLocation(request);
       * ```
       */
    getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
    /**
       * Lists information about the supported locations for this service. Returns an iterable object.
       *
       * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
       * @param {Object} request
       *   The request object that will be sent.
       * @param {string} request.name
       *   The resource that owns the locations collection, if applicable.
       * @param {string} request.filter
       *   The standard list filter.
       * @param {number} request.pageSize
       *   The standard list page size.
       * @param {string} request.pageToken
       *   The standard list page token.
       * @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 {@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.location.Location | Location}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
       *   for more details and examples.
       * @example
       * ```
       * const iterable = client.listLocationsAsync(request);
       * for await (const response of iterable) {
       *   // process response
       * }
       * ```
       */
    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
    /**
       * Gets the latest state of a long-running operation.  Clients can use this
       * method to poll the operation result at intervals as recommended by the API
       * service.
       *
       * @param {Object} request - The request object that will be sent.
       * @param {string} request.name - The name of the operation resource.
       * @param {Object=} options
       *   Optional parameters. You can override the default settings for this call,
       *   e.g, timeout, retries, paginations, etc. See {@link
       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
       *   for the details.
       * @param {function(?Error, ?Object)=} callback
       *   The function which will be called with the result of the API call.
       *
       *   The second parameter to the callback is an object representing
       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
       * @return {Promise} - The promise which resolves to an array.
       *   The first element of the array is an object representing
       * {@link google.longrunning.Operation | google.longrunning.Operation}.
       * The promise has a method named "cancel" which cancels the ongoing API call.
       *
       * @example
       * ```
       * const client = longrunning.operationsClient();
       * const name = '';
       * const [response] = await client.getOperation({name});
       * // doThingsWith(response)
       * ```
       */
    getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
    /**
     * Lists operations that match the specified filter in the request. If the
     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
     *
     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation collection.
     * @param {string} request.filter - The standard list filter.
     * @param {number=} request.pageSize -
     *   The maximum number of resources contained in the underlying API
     *   response. If page streaming is performed per-resource, this
     *   parameter does not affect the return value. If page streaming is
     *   performed per-page, this determines the maximum number of
     *   resources in a page.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     *   e.g, timeout, retries, paginations, etc. See {@link
     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     *   details.
     * @returns {Object}
     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * for await (const response of client.listOperationsAsync(request));
     * // doThingsWith(response)
     * ```
     */
    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
    /**
     * Starts asynchronous cancellation on a long-running operation.  The server
     * makes a best effort to cancel the operation, but success is not
     * guaranteed.  If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
     * {@link Operations.GetOperation} or
     * other methods to check whether the cancellation succeeded or whether the
     * operation completed despite cancellation. On successful cancellation,
     * the operation is not deleted; instead, it becomes an operation with
     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
     * 1, corresponding to `Code.CANCELLED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be cancelled.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     * e.g, timeout, retries, paginations, etc. See {@link
     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
     * details.
     * @param {function(?Error)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.cancelOperation({name: ''});
     * ```
     */
    cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
    /**
     * Deletes a long-running operation. This method indicates that the client is
     * no longer interested in the operation result. It does not cancel the
     * operation. If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be deleted.
     * @param {Object=} options
     *   Optional parameters. You can override the default settings for this call,
     * e.g, timeout, retries, paginations, etc. See {@link
     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
     * for the details.
     * @param {function(?Error)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.deleteOperation({name: ''});
     * ```
     */
    deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
    /**
     * Return a fully-qualified conversationDataset resource name string.
     *
     * @param {string} project
     * @param {string} location
     * @param {string} conversation_dataset
     * @returns {string} Resource name string.