UNPKG

@google-cloud/dialogflow

Version:
721 lines 120 kB
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'; /** * Manages a collection of models for human agent assistant. * @class * @memberof v2 */ export declare class ConversationModelsClient { 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; conversationModelsStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ConversationModelsClient. * * @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 ConversationModelsClient({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; /** * Gets conversation model. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The conversation model to retrieve. Format: * `projects/<Project ID>/conversationModels/<Conversation Model 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.ConversationModel|ConversationModel}. * 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/conversation_models.get_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_GetConversationModel_async */ getConversationModel(request?: protos.google.cloud.dialogflow.v2.IGetConversationModelRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | undefined, {} | undefined ]>; getConversationModel(request: protos.google.cloud.dialogflow.v2.IGetConversationModelRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | null | undefined, {} | null | undefined>): void; getConversationModel(request: protos.google.cloud.dialogflow.v2.IGetConversationModelRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | null | undefined, {} | null | undefined>): void; /** * Gets an evaluation of conversation model. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The conversation model evaluation resource name. Format: * `projects/<Project ID>/conversationModels/<Conversation Model * ID>/evaluations/<Evaluation 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.ConversationModelEvaluation|ConversationModelEvaluation}. * 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/conversation_models.get_conversation_model_evaluation.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_GetConversationModelEvaluation_async */ getConversationModelEvaluation(request?: protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | undefined, {} | undefined ]>; getConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | null | undefined, {} | null | undefined>): void; getConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | null | undefined, {} | null | undefined>): void; /** * Creates a model. * * This method is a [long-running * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). * The returned `Operation` type has the following method-specific fields: * * - `metadata`: * {@link protos.google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata|CreateConversationModelOperationMetadata} * - `response`: * {@link protos.google.cloud.dialogflow.v2.ConversationModel|ConversationModel} * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * The project to create conversation model for. Format: * `projects/<Project ID>` * @param {google.cloud.dialogflow.v2.ConversationModel} request.conversationModel * Required. The conversation model 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/conversation_models.create_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_CreateConversationModel_async */ createConversationModel(request?: protos.google.cloud.dialogflow.v2.ICreateConversationModelRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createConversationModel(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createConversationModel(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createConversationModel()`. * @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/conversation_models.create_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_CreateConversationModel_async */ checkCreateConversationModelProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.ConversationModel, protos.google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata>>; /** * Deletes a model. * * This method is a [long-running * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). * The returned `Operation` type has the following method-specific fields: * * - `metadata`: * {@link protos.google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata|DeleteConversationModelOperationMetadata} * - `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 conversation model to delete. Format: * `projects/<Project ID>/conversationModels/<Conversation Model 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/conversation_models.delete_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_DeleteConversationModel_async */ deleteConversationModel(request?: protos.google.cloud.dialogflow.v2.IDeleteConversationModelRequest, options?: CallOptions): Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteConversationModel(request: protos.google.cloud.dialogflow.v2.IDeleteConversationModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteConversationModel(request: protos.google.cloud.dialogflow.v2.IDeleteConversationModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteConversationModel()`. * @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/conversation_models.delete_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_DeleteConversationModel_async */ checkDeleteConversationModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata>>; /** * Deploys a model. If a model is already deployed, deploying it * has no effect. A model can only serve prediction requests after it gets * deployed. For article suggestion, custom model will not be used unless * it is deployed. * * This method is a [long-running * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). * The returned `Operation` type has the following method-specific fields: * * - `metadata`: * {@link protos.google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata|DeployConversationModelOperationMetadata} * - `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 conversation model to deploy. Format: * `projects/<Project ID>/conversationModels/<Conversation Model 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/conversation_models.deploy_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_DeployConversationModel_async */ deployConversationModel(request?: protos.google.cloud.dialogflow.v2.IDeployConversationModelRequest, options?: CallOptions): Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deployConversationModel(request: protos.google.cloud.dialogflow.v2.IDeployConversationModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deployConversationModel(request: protos.google.cloud.dialogflow.v2.IDeployConversationModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deployConversationModel()`. * @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/conversation_models.deploy_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_DeployConversationModel_async */ checkDeployConversationModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata>>; /** * Undeploys a model. If the model is not deployed this method has no effect. * If the model is currently being used: * - For article suggestion, article suggestion will fallback to the default * model if model is undeployed. * * This method is a [long-running * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). * The returned `Operation` type has the following method-specific fields: * * - `metadata`: * {@link protos.google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata|UndeployConversationModelOperationMetadata} * - `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 conversation model to undeploy. Format: * `projects/<Project ID>/conversationModels/<Conversation Model 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/conversation_models.undeploy_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_UndeployConversationModel_async */ undeployConversationModel(request?: protos.google.cloud.dialogflow.v2.IUndeployConversationModelRequest, options?: CallOptions): Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IUndeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; undeployConversationModel(request: protos.google.cloud.dialogflow.v2.IUndeployConversationModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IUndeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; undeployConversationModel(request: protos.google.cloud.dialogflow.v2.IUndeployConversationModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IUndeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `undeployConversationModel()`. * @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/conversation_models.undeploy_conversation_model.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_UndeployConversationModel_async */ checkUndeployConversationModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata>>; /** * Creates evaluation of a conversation model. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The conversation model resource name. Format: * `projects/<Project ID>/locations/<Location * ID>/conversationModels/<Conversation Model ID>` * @param {google.cloud.dialogflow.v2.ConversationModelEvaluation} request.conversationModelEvaluation * Required. The conversation model evaluation to 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 * 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/conversation_models.create_conversation_model_evaluation.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_CreateConversationModelEvaluation_async */ createConversationModelEvaluation(request?: protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationRequest, options?: CallOptions): Promise<[ LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createConversationModelEvaluation()`. * @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/conversation_models.create_conversation_model_evaluation.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_CreateConversationModelEvaluation_async */ checkCreateConversationModelEvaluationProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.ConversationModelEvaluation, protos.google.cloud.dialogflow.v2.CreateConversationModelEvaluationOperationMetadata>>; /** * Lists conversation models. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project to list all conversation models for. * Format: `projects/<Project ID>` * @param {number} [request.pageSize] * Optional. Maximum number of conversation models to return in a single * page. By default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @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.ConversationModel|ConversationModel}. * 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 `listConversationModelsAsync()` * 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. */ listConversationModels(request?: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IConversationModel[], protos.google.cloud.dialogflow.v2.IListConversationModelsRequest | null, protos.google.cloud.dialogflow.v2.IListConversationModelsResponse ]>; listConversationModels(request: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModel>): void; listConversationModels(request: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModel>): void; /** * Equivalent to `listConversationModels`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project to list all conversation models for. * Format: `projects/<Project ID>` * @param {number} [request.pageSize] * Optional. Maximum number of conversation models to return in a single * page. By default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @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.ConversationModel|ConversationModel} 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 `listConversationModelsAsync()` * 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. */ listConversationModelsStream(request?: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options?: CallOptions): Transform; /** * Equivalent to `listConversationModels`, 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 project to list all conversation models for. * Format: `projects/<Project ID>` * @param {number} [request.pageSize] * Optional. Maximum number of conversation models to return in a single * page. By default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @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.ConversationModel|ConversationModel}. 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/conversation_models.list_conversation_models.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_ListConversationModels_async */ listConversationModelsAsync(request?: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IConversationModel>; /** * Lists evaluations of a conversation model. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The conversation model resource name. Format: * `projects/<Project ID>/conversationModels/<Conversation Model ID>` * @param {number} [request.pageSize] * Optional. Maximum number of evaluations to return in a * single page. By default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @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.ConversationModelEvaluation|ConversationModelEvaluation}. * 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 `listConversationModelEvaluationsAsync()` * 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. */ listConversationModelEvaluations(request?: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options?: CallOptions): Promise<[ protos.google.cloud.dialogflow.v2.IConversationModelEvaluation[], protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest | null, protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse ]>; listConversationModelEvaluations(request: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>): void; listConversationModelEvaluations(request: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>): void; /** * Equivalent to `listConversationModelEvaluations`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The conversation model resource name. Format: * `projects/<Project ID>/conversationModels/<Conversation Model ID>` * @param {number} [request.pageSize] * Optional. Maximum number of evaluations to return in a * single page. By default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @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.ConversationModelEvaluation|ConversationModelEvaluation} 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 `listConversationModelEvaluationsAsync()` * 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. */ listConversationModelEvaluationsStream(request?: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options?: CallOptions): Transform; /** * Equivalent to `listConversationModelEvaluations`, 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 conversation model resource name. Format: * `projects/<Project ID>/conversationModels/<Conversation Model ID>` * @param {number} [request.pageSize] * Optional. Maximum number of evaluations to return in a * single page. By default 100 and at most 1000. * @param {string} [request.pageToken] * Optional. The next_page_token value returned from a previous list request. * @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.ConversationModelEvaluation|ConversationModelEvaluation}. 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/conversation_models.list_conversation_model_evaluations.js</caption> * region_tag:dialogflow_v2_generated_ConversationModels_ListConversationModelEvaluations_async */ listConversationModelEvaluationsAsync(request?: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>; /** * 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.UNIMPLEMENTE