Class v3beta1.AgentsClient (2.15.0)

Service for managing . v3beta1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AgentsClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

agentsStub

agentsStub?: Promise<{
        [name: string]: Function;
    }>;

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

agentPath(project, location, agent)

agentPath(project: string, location: string, agent: string): string;

Return a fully-qualified agent resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`

Returns

Type	Description
string	{string} Resource name string.

agentValidationResultPath(project, location, agent)

agentValidationResultPath(project: string, location: string, agent: string): string;

Return a fully-qualified agentValidationResult resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`

Returns

Type	Description
string	{string} Resource name string.

changelogPath(project, location, agent, changelog)

changelogPath(project: string, location: string, agent: string, changelog: string): string;

Return a fully-qualified changelog resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
changelog	`string`

Returns

Type	Description
string	{string} Resource name string.

checkExportAgentProgress(name)

checkExportAgentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse, protos.google.protobuf.Struct>>;

Check the status of the long running operation returned by exportAgent().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse, protos.google.protobuf.Struct>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to export.
   *  Format: `projects/

checkRestoreAgentProgress(name)

checkRestoreAgentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;

Check the status of the long running operation returned by restoreAgent().

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to restore into.
   *  Format: `projects/

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

continuousTestResultPath(project, location, agent, environment, continuousTestResult)

continuousTestResultPath(project: string, location: string, agent: string, environment: string, continuousTestResult: string): string;

Return a fully-qualified continuousTestResult resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
continuousTestResult	`string`

Returns

Type	Description
string	{string} Resource name string.

createAgent(request, options)

createAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | undefined, {} | undefined]>;

Creates an agent in the specified location.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Agent]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to create a agent for.
   *  Format: `projects/

createAgent(request, options, callback)

createAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createAgent(request, callback)

createAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAgent(request, options)

deleteAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | undefined, {} | undefined]>;

Deletes the specified agent.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to delete.
   *  Format: `projects/

deleteAgent(request, options, callback)

deleteAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteAgent(request, callback)

deleteAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deploymentPath(project, location, agent, environment, deployment)

deploymentPath(project: string, location: string, agent: string, environment: string, deployment: string): string;

Return a fully-qualified deployment resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
deployment	`string`

Returns

Type	Description
string	{string} Resource name string.

entityTypePath(project, location, agent, entityType)

entityTypePath(project: string, location: string, agent: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

environmentPath(project, location, agent, environment)

environmentPath(project: string, location: string, agent: string, environment: string): string;

Return a fully-qualified environment resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`

Returns

Type	Description
string	{string} Resource name string.

experimentPath(project, location, agent, environment, experiment)

experimentPath(project: string, location: string, agent: string, environment: string, experiment: string): string;

Return a fully-qualified experiment resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
experiment	`string`

Returns

Type	Description
string	{string} Resource name string.

exportAgent(request, options)

exportAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Exports the specified agent to a binary file.

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: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - response:

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>	{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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to export.
   *  Format: `projects/

exportAgent(request, options, callback)

exportAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

exportAgent(request, callback)

exportAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest`
callback	`Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

flowPath(project, location, agent, flow)

flowPath(project: string, location: string, agent: string, flow: string): string;

Return a fully-qualified flow resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`

Returns

Type	Description
string	{string} Resource name string.

flowValidationResultPath(project, location, agent, flow)

flowValidationResultPath(project: string, location: string, agent: string, flow: string): string;

Return a fully-qualified flowValidationResult resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`

Returns

Type	Description
string	{string} Resource name string.

getAgent(request, options)

getAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | undefined, {} | undefined]>;

Retrieves the specified agent.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Agent]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent.
   *  Format: `projects/

getAgent(request, options, callback)

getAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAgent(request, callback)

getAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAgentValidationResult(request, options)

getAgentValidationResult(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, (protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | undefined), {} | undefined]>;

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, (protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AgentValidationResult]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent name.
   *  Format: `projects/

getAgentValidationResult(request, options, callback)

getAgentValidationResult(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getAgentValidationResult(request, callback)

getAgentValidationResult(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

intentPath(project, location, agent, intent)

intentPath(project: string, location: string, agent: string, intent: string): string;

Return a fully-qualified intent resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
intent	`string`

Returns

Type	Description
string	{string} Resource name string.

listAgents(request, options)

listAgents(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent[], protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse]>;

Returns the list of all agents in the specified location.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent[], protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Agent]. 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 listAgentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAgents(request, options, callback)

listAgents(request: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>`

Returns

Type	Description
void

listAgents(request, callback)

listAgents(request: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest`
callback	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>`

Returns

Type	Description
void

listAgentsAsync(request, options)

listAgentsAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IAgent>;

Equivalent to listAgents, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IAgent>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Agent]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to list all agents for.
   *  Format: `projects/

listAgentsStream(request, options)

listAgentsStream(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Agent] 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 listAgentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchAgentFromAgentName(agentName)

matchAgentFromAgentName(agentName: string): string | number;

Parse the agent from Agent resource.

Parameter

Name	Description
agentName	`string` A fully-qualified path representing Agent resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromAgentValidationResultName(agentValidationResultName)

matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the agent from AgentValidationResult resource.

Parameter

Name	Description
agentValidationResultName	`string` A fully-qualified path representing AgentValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromChangelogName(changelogName)

matchAgentFromChangelogName(changelogName: string): string | number;

Parse the agent from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromContinuousTestResultName(continuousTestResultName)

matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the agent from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromDeploymentName(deploymentName)

matchAgentFromDeploymentName(deploymentName: string): string | number;

Parse the agent from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromEntityTypeName(entityTypeName)

matchAgentFromEntityTypeName(entityTypeName: string): string | number;

Parse the agent from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromEnvironmentName(environmentName)

matchAgentFromEnvironmentName(environmentName: string): string | number;

Parse the agent from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromExperimentName(experimentName)

matchAgentFromExperimentName(experimentName: string): string | number;

Parse the agent from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromFlowName(flowName)

matchAgentFromFlowName(flowName: string): string | number;

Parse the agent from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromFlowValidationResultName(flowValidationResultName)

matchAgentFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the agent from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromIntentName(intentName)

matchAgentFromIntentName(intentName: string): string | number;

Parse the agent from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromPageName(pageName)

matchAgentFromPageName(pageName: string): string | number;

Parse the agent from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromTestCaseName(testCaseName)

matchAgentFromTestCaseName(testCaseName: string): string | number;

Parse the agent from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromTestCaseResultName(testCaseResultName)

matchAgentFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the agent from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName)

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the agent from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromVersionName(versionName)

matchAgentFromVersionName(versionName: string): string | number;

Parse the agent from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromWebhookName(webhookName)

matchAgentFromWebhookName(webhookName: string): string | number;

Parse the agent from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchChangelogFromChangelogName(changelogName)

matchChangelogFromChangelogName(changelogName: string): string | number;

Parse the changelog from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

Type	Description
string \| number	{string} A string representing the changelog.

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName)

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the continuous_test_result from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the continuous_test_result.

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the deployment.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEnvironmentFromContinuousTestResultName(continuousTestResultName)

matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the environment from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromDeploymentName(deploymentName)

matchEnvironmentFromDeploymentName(deploymentName: string): string | number;

Parse the environment from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromExperimentName(experimentName)

matchEnvironmentFromExperimentName(experimentName: string): string | number;

Parse the environment from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchExperimentFromExperimentName(experimentName)

matchExperimentFromExperimentName(experimentName: string): string | number;

Parse the experiment from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the experiment.

matchFlowFromFlowName(flowName)

matchFlowFromFlowName(flowName: string): string | number;

Parse the flow from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromFlowValidationResultName(flowValidationResultName)

matchFlowFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the flow from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromPageName(pageName)

matchFlowFromPageName(pageName: string): string | number;

Parse the flow from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName)

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the flow from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromVersionName(versionName)

matchFlowFromVersionName(versionName: string): string | number;

Parse the flow from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchIntentFromIntentName(intentName)

matchIntentFromIntentName(intentName: string): string | number;

Parse the intent from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the intent.

matchLocationFromAgentName(agentName)

matchLocationFromAgentName(agentName: string): string | number;

Parse the location from Agent resource.

Parameter

Name	Description
agentName	`string` A fully-qualified path representing Agent resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAgentValidationResultName(agentValidationResultName)

matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the location from AgentValidationResult resource.

Parameter

Name	Description
agentValidationResultName	`string` A fully-qualified path representing AgentValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromChangelogName(changelogName)

matchLocationFromChangelogName(changelogName: string): string | number;

Parse the location from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromContinuousTestResultName(continuousTestResultName)

matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the location from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromExperimentName(experimentName)

matchLocationFromExperimentName(experimentName: string): string | number;

Parse the location from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFlowName(flowName)

matchLocationFromFlowName(flowName: string): string | number;

Parse the location from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFlowValidationResultName(flowValidationResultName)

matchLocationFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the location from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromIntentName(intentName)

matchLocationFromIntentName(intentName: string): string | number;

Parse the location from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromPageName(pageName)

matchLocationFromPageName(pageName: string): string | number;

Parse the location from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromSecuritySettingsName(securitySettingsName)

matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the location from SecuritySettings resource.

Parameter

Name	Description
securitySettingsName	`string` A fully-qualified path representing SecuritySettings resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTestCaseName(testCaseName)

matchLocationFromTestCaseName(testCaseName: string): string | number;

Parse the location from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTestCaseResultName(testCaseResultName)

matchLocationFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the location from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName)

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the location from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromVersionName(versionName)

matchLocationFromVersionName(versionName: string): string | number;

Parse the location from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromWebhookName(webhookName)

matchLocationFromWebhookName(webhookName: string): string | number;

Parse the location from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchPageFromPageName(pageName)

matchPageFromPageName(pageName: string): string | number;

Parse the page from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the page.

matchProjectFromAgentName(agentName)

matchProjectFromAgentName(agentName: string): string | number;

Parse the project from Agent resource.

Parameter

Name	Description
agentName	`string` A fully-qualified path representing Agent resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAgentValidationResultName(agentValidationResultName)

matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the project from AgentValidationResult resource.

Parameter

Name	Description
agentValidationResultName	`string` A fully-qualified path representing AgentValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromChangelogName(changelogName)

matchProjectFromChangelogName(changelogName: string): string | number;

Parse the project from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromContinuousTestResultName(continuousTestResultName)

matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the project from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromDeploymentName(deploymentName)

matchProjectFromDeploymentName(deploymentName: string): string | number;

Parse the project from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromExperimentName(experimentName)

matchProjectFromExperimentName(experimentName: string): string | number;

Parse the project from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromFlowName(flowName)

matchProjectFromFlowName(flowName: string): string | number;

Parse the project from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromFlowValidationResultName(flowValidationResultName)

matchProjectFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the project from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromIntentName(intentName)

matchProjectFromIntentName(intentName: string): string | number;

Parse the project from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromPageName(pageName)

matchProjectFromPageName(pageName: string): string | number;

Parse the project from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromSecuritySettingsName(securitySettingsName)

matchProjectFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the project from SecuritySettings resource.

Parameter

Name	Description
securitySettingsName	`string` A fully-qualified path representing SecuritySettings resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTestCaseName(testCaseName)

matchProjectFromTestCaseName(testCaseName: string): string | number;

Parse the project from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTestCaseResultName(testCaseResultName)

matchProjectFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the project from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTransitionRouteGroupName(transitionRouteGroupName)

matchProjectFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the project from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromVersionName(versionName)

matchProjectFromVersionName(versionName: string): string | number;

Parse the project from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromWebhookName(webhookName)

matchProjectFromWebhookName(webhookName: string): string | number;

Parse the project from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchResultFromTestCaseResultName(testCaseResultName)

matchResultFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the result from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the result.

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName)

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the security_settings from SecuritySettings resource.

Parameter

Name	Description
securitySettingsName	`string` A fully-qualified path representing SecuritySettings resource.

Returns

Type	Description
string \| number	{string} A string representing the security_settings.

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchTestCaseFromTestCaseName(testCaseName)

matchTestCaseFromTestCaseName(testCaseName: string): string | number;

Parse the test_case from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

Type	Description
string \| number	{string} A string representing the test_case.

matchTestCaseFromTestCaseResultName(testCaseResultName)

matchTestCaseFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the test_case from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the test_case.

matchTransitionRouteGroupFromTransitionRouteGroupName(transitionRouteGroupName)

matchTransitionRouteGroupFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the transition_route_group from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the transition_route_group.

matchVersionFromVersionName(versionName)

matchVersionFromVersionName(versionName: string): string | number;

Parse the version from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the version.

matchWebhookFromWebhookName(webhookName)

matchWebhookFromWebhookName(webhookName: string): string | number;

Parse the webhook from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the webhook.

pagePath(project, location, agent, flow, page)

pagePath(project: string, location: string, agent: string, flow: string, page: string): string;

Return a fully-qualified page resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`
page	`string`

Returns

Type	Description
string	{string} Resource name string.

projectLocationAgentEnvironmentSessionEntityTypePath(project, location, agent, environment, session, entityType)

projectLocationAgentEnvironmentSessionEntityTypePath(project: string, location: string, agent: string, environment: string, session: string, entityType: string): string;

Return a fully-qualified projectLocationAgentEnvironmentSessionEntityType resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
session	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

projectLocationAgentSessionEntityTypePath(project, location, agent, session, entityType)

projectLocationAgentSessionEntityTypePath(project: string, location: string, agent: string, session: string, entityType: string): string;

Return a fully-qualified projectLocationAgentSessionEntityType resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
session	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

restoreAgent(request, options)

restoreAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IRestoreAgentRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Restores the specified agent from a binary file.

Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.

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: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - response: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IRestoreAgentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation \| undefined, {} \| undefined]>	{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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to restore into.
   *  Format: `projects/

restoreAgent(request, options, callback)

restoreAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IRestoreAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IRestoreAgentRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

restoreAgent(request, callback)

restoreAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IRestoreAgentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IRestoreAgentRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

securitySettingsPath(project, location, securitySettings)

securitySettingsPath(project: string, location: string, securitySettings: string): string;

Return a fully-qualified securitySettings resource name string.

Parameters

Name	Description
project	`string`
location	`string`
securitySettings	`string`

Returns

Type	Description
string	{string} Resource name string.

testCasePath(project, location, agent, testCase)

testCasePath(project: string, location: string, agent: string, testCase: string): string;

Return a fully-qualified testCase resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
testCase	`string`

Returns

Type	Description
string	{string} Resource name string.

testCaseResultPath(project, location, agent, testCase, result)

testCaseResultPath(project: string, location: string, agent: string, testCase: string, result: string): string;

Return a fully-qualified testCaseResult resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
testCase	`string`
result	`string`

Returns

Type	Description
string	{string} Resource name string.

transitionRouteGroupPath(project, location, agent, flow, transitionRouteGroup)

transitionRouteGroupPath(project: string, location: string, agent: string, flow: string, transitionRouteGroup: string): string;

Return a fully-qualified transitionRouteGroup resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`
transitionRouteGroup	`string`

Returns

Type	Description
string	{string} Resource name string.

updateAgent(request, options)

updateAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest | undefined, {} | undefined]>;

Updates the specified agent.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Agent]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to update.
   */
  // const agent = {}
  /**
   *  The mask to control which fields get updated. If the mask is not present,
   *  all fields will be updated.
   */
  // const updateMask = {}

  // Imports the Cx library
  const {AgentsClient} = require('@google-cloud/dialogflow-cx').v3beta1;

  // Instantiates a client
  const cxClient = new AgentsClient();

  async function callUpdateAgent() {
    // Construct request
    const request = {
      agent,
    };

    // Run request
    const response = await cxClient.updateAgent(request);
    console.log(response);
  }

  callUpdateAgent();

updateAgent(request, options, callback)

updateAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateAgent(request, callback)

updateAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

validateAgent(request, options)

validateAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, (protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest | undefined), {} | undefined]>;

Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, (protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AgentValidationResult]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent to validate.
   *  Format: `projects/

validateAgent(request, options, callback)

validateAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

validateAgent(request, callback)

validateAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IValidateAgentRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

versionPath(project, location, agent, flow, version)

versionPath(project: string, location: string, agent: string, flow: string, version: string): string;

Return a fully-qualified version resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`
version	`string`

Returns

Type	Description
string	{string} Resource name string.

webhookPath(project, location, agent, webhook)

webhookPath(project: string, location: string, agent: string, webhook: string): string;

Return a fully-qualified webhook resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
webhook	`string`

Returns

Type	Description
string	{string} Resource name string.