Class protos.google.cloud.dialogflow.cx.v3.Agents (5.1.0)

Version latest

• 5.1.0 (latest)
• 5.0.1
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.3.1
• 4.2.0
• 4.0.0
• 3.4.2
• 3.2.1
• 3.1.2
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.1

Represents an Agents

Inheritance

$protobuf.rpc.Service > protos.google.cloud.dialogflow.cx.v3.Agents

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Agents service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Agents;

Creates new Agents service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
Agents	RPC service. Useful where requests and/or responses are streamed.

createAgent(request, callback)

public createAgent(request: google.cloud.dialogflow.cx.v3.ICreateAgentRequest, callback: google.cloud.dialogflow.cx.v3.Agents.CreateAgentCallback): void;

Calls CreateAgent.

Parameters
Name	Description
request	ICreateAgentRequest CreateAgentRequest message or plain object
callback	CreateAgentCallback Node-style callback called with the error, if any, and Agent

Returns
Type	Description
void

createAgent(request)

public createAgent(request: google.cloud.dialogflow.cx.v3.ICreateAgentRequest): Promise<google.cloud.dialogflow.cx.v3.Agent>;

Calls CreateAgent.

Parameter
Name	Description
request	ICreateAgentRequest CreateAgentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.Agent>	Promise

deleteAgent(request, callback)

public deleteAgent(request: google.cloud.dialogflow.cx.v3.IDeleteAgentRequest, callback: google.cloud.dialogflow.cx.v3.Agents.DeleteAgentCallback): void;

Calls DeleteAgent.

Parameters
Name	Description
request	IDeleteAgentRequest DeleteAgentRequest message or plain object
callback	DeleteAgentCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteAgent(request)

public deleteAgent(request: google.cloud.dialogflow.cx.v3.IDeleteAgentRequest): Promise<google.protobuf.Empty>;

Calls DeleteAgent.

Parameter
Name	Description
request	IDeleteAgentRequest DeleteAgentRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

exportAgent(request, callback)

public exportAgent(request: google.cloud.dialogflow.cx.v3.IExportAgentRequest, callback: google.cloud.dialogflow.cx.v3.Agents.ExportAgentCallback): void;

Calls ExportAgent.

Parameters
Name	Description
request	IExportAgentRequest ExportAgentRequest message or plain object
callback	ExportAgentCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

exportAgent(request)

public exportAgent(request: google.cloud.dialogflow.cx.v3.IExportAgentRequest): Promise<google.longrunning.Operation>;

Calls ExportAgent.

Parameter
Name	Description
request	IExportAgentRequest ExportAgentRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getAgent(request, callback)

public getAgent(request: google.cloud.dialogflow.cx.v3.IGetAgentRequest, callback: google.cloud.dialogflow.cx.v3.Agents.GetAgentCallback): void;

Calls GetAgent.

Parameters
Name	Description
request	IGetAgentRequest GetAgentRequest message or plain object
callback	GetAgentCallback Node-style callback called with the error, if any, and Agent

Returns
Type	Description
void

getAgent(request)

public getAgent(request: google.cloud.dialogflow.cx.v3.IGetAgentRequest): Promise<google.cloud.dialogflow.cx.v3.Agent>;

Calls GetAgent.

Parameter
Name	Description
request	IGetAgentRequest GetAgentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.Agent>	Promise

getAgentValidationResult(request, callback)

public getAgentValidationResult(request: google.cloud.dialogflow.cx.v3.IGetAgentValidationResultRequest, callback: google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResultCallback): void;

Calls GetAgentValidationResult.

Parameters
Name	Description
request	IGetAgentValidationResultRequest GetAgentValidationResultRequest message or plain object
callback	GetAgentValidationResultCallback Node-style callback called with the error, if any, and AgentValidationResult

Returns
Type	Description
void

getAgentValidationResult(request)

public getAgentValidationResult(request: google.cloud.dialogflow.cx.v3.IGetAgentValidationResultRequest): Promise<google.cloud.dialogflow.cx.v3.AgentValidationResult>;

Calls GetAgentValidationResult.

Parameter
Name	Description
request	IGetAgentValidationResultRequest GetAgentValidationResultRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.AgentValidationResult>	Promise

getGenerativeSettings(request, callback)

public getGenerativeSettings(request: google.cloud.dialogflow.cx.v3.IGetGenerativeSettingsRequest, callback: google.cloud.dialogflow.cx.v3.Agents.GetGenerativeSettingsCallback): void;

Calls GetGenerativeSettings.

Parameters
Name	Description
request	IGetGenerativeSettingsRequest GetGenerativeSettingsRequest message or plain object
callback	GetGenerativeSettingsCallback Node-style callback called with the error, if any, and GenerativeSettings

Returns
Type	Description
void

getGenerativeSettings(request)

public getGenerativeSettings(request: google.cloud.dialogflow.cx.v3.IGetGenerativeSettingsRequest): Promise<google.cloud.dialogflow.cx.v3.GenerativeSettings>;

Calls GetGenerativeSettings.

Parameter
Name	Description
request	IGetGenerativeSettingsRequest GetGenerativeSettingsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.GenerativeSettings>	Promise

listAgents(request, callback)

public listAgents(request: google.cloud.dialogflow.cx.v3.IListAgentsRequest, callback: google.cloud.dialogflow.cx.v3.Agents.ListAgentsCallback): void;

Calls ListAgents.

Parameters
Name	Description
request	IListAgentsRequest ListAgentsRequest message or plain object
callback	ListAgentsCallback Node-style callback called with the error, if any, and ListAgentsResponse

Returns
Type	Description
void

listAgents(request)

public listAgents(request: google.cloud.dialogflow.cx.v3.IListAgentsRequest): Promise<google.cloud.dialogflow.cx.v3.ListAgentsResponse>;

Calls ListAgents.

Parameter
Name	Description
request	IListAgentsRequest ListAgentsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.ListAgentsResponse>	Promise

restoreAgent(request, callback)

public restoreAgent(request: google.cloud.dialogflow.cx.v3.IRestoreAgentRequest, callback: google.cloud.dialogflow.cx.v3.Agents.RestoreAgentCallback): void;

Calls RestoreAgent.

Parameters
Name	Description
request	IRestoreAgentRequest RestoreAgentRequest message or plain object
callback	RestoreAgentCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

restoreAgent(request)

public restoreAgent(request: google.cloud.dialogflow.cx.v3.IRestoreAgentRequest): Promise<google.longrunning.Operation>;

Calls RestoreAgent.

Parameter
Name	Description
request	IRestoreAgentRequest RestoreAgentRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateAgent(request, callback)

public updateAgent(request: google.cloud.dialogflow.cx.v3.IUpdateAgentRequest, callback: google.cloud.dialogflow.cx.v3.Agents.UpdateAgentCallback): void;

Calls UpdateAgent.

Parameters
Name	Description
request	IUpdateAgentRequest UpdateAgentRequest message or plain object
callback	UpdateAgentCallback Node-style callback called with the error, if any, and Agent

Returns
Type	Description
void

updateAgent(request)

public updateAgent(request: google.cloud.dialogflow.cx.v3.IUpdateAgentRequest): Promise<google.cloud.dialogflow.cx.v3.Agent>;

Calls UpdateAgent.

Parameter
Name	Description
request	IUpdateAgentRequest UpdateAgentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.Agent>	Promise

updateGenerativeSettings(request, callback)

public updateGenerativeSettings(request: google.cloud.dialogflow.cx.v3.IUpdateGenerativeSettingsRequest, callback: google.cloud.dialogflow.cx.v3.Agents.UpdateGenerativeSettingsCallback): void;

Calls UpdateGenerativeSettings.

Parameters
Name	Description
request	IUpdateGenerativeSettingsRequest UpdateGenerativeSettingsRequest message or plain object
callback	UpdateGenerativeSettingsCallback Node-style callback called with the error, if any, and GenerativeSettings

Returns
Type	Description
void

updateGenerativeSettings(request)

public updateGenerativeSettings(request: google.cloud.dialogflow.cx.v3.IUpdateGenerativeSettingsRequest): Promise<google.cloud.dialogflow.cx.v3.GenerativeSettings>;

Calls UpdateGenerativeSettings.

Parameter
Name	Description
request	IUpdateGenerativeSettingsRequest UpdateGenerativeSettingsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.GenerativeSettings>	Promise

validateAgent(request, callback)

public validateAgent(request: google.cloud.dialogflow.cx.v3.IValidateAgentRequest, callback: google.cloud.dialogflow.cx.v3.Agents.ValidateAgentCallback): void;

Calls ValidateAgent.

Parameters
Name	Description
request	IValidateAgentRequest ValidateAgentRequest message or plain object
callback	ValidateAgentCallback Node-style callback called with the error, if any, and AgentValidationResult

Returns
Type	Description
void

validateAgent(request)

public validateAgent(request: google.cloud.dialogflow.cx.v3.IValidateAgentRequest): Promise<google.cloud.dialogflow.cx.v3.AgentValidationResult>;

Calls ValidateAgent.

Parameter
Name	Description
request	IValidateAgentRequest ValidateAgentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dialogflow.cx.v3.AgentValidationResult>	Promise