Agents

google.cloud.dialogflow.v2. Agents

Represents an Agents

Constructor

new Agents(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Agents service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Agents}

Creates new Agents service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
Agents

RPC service. Useful where requests and/or responses are streamed.

deleteAgent(request, callback) → {undefined}

Calls DeleteAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IDeleteAgentRequest

DeleteAgentRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.DeleteAgentCallback

Node-style callback called with the error, if any, and Empty

Returns:
Type Description
undefined

deleteAgent(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IDeleteAgentRequest

DeleteAgentRequest message or plain object

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

Promise

exportAgent(request, callback) → {undefined}

Calls ExportAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IExportAgentRequest

ExportAgentRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.ExportAgentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

exportAgent(request) → {Promise.<google.longrunning.Operation>}

Calls ExportAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IExportAgentRequest

ExportAgentRequest message or plain object

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

Promise

getAgent(request, callback) → {undefined}

Calls GetAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IGetAgentRequest

GetAgentRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.GetAgentCallback

Node-style callback called with the error, if any, and Agent

Returns:
Type Description
undefined

getAgent(request) → {Promise.<google.cloud.dialogflow.v2.Agent>}

Calls GetAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IGetAgentRequest

GetAgentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.dialogflow.v2.Agent>

Promise

getValidationResult(request, callback) → {undefined}

Calls GetValidationResult.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IGetValidationResultRequest

GetValidationResultRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.GetValidationResultCallback

Node-style callback called with the error, if any, and ValidationResult

Returns:
Type Description
undefined

getValidationResult(request) → {Promise.<google.cloud.dialogflow.v2.ValidationResult>}

Calls GetValidationResult.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IGetValidationResultRequest

GetValidationResultRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.dialogflow.v2.ValidationResult>

Promise

importAgent(request, callback) → {undefined}

Calls ImportAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IImportAgentRequest

ImportAgentRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.ImportAgentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

importAgent(request) → {Promise.<google.longrunning.Operation>}

Calls ImportAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IImportAgentRequest

ImportAgentRequest message or plain object

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

Promise

restoreAgent(request, callback) → {undefined}

Calls RestoreAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IRestoreAgentRequest

RestoreAgentRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.RestoreAgentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

restoreAgent(request) → {Promise.<google.longrunning.Operation>}

Calls RestoreAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.IRestoreAgentRequest

RestoreAgentRequest message or plain object

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

Promise

searchAgents(request, callback) → {undefined}

Calls SearchAgents.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.ISearchAgentsRequest

SearchAgentsRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.SearchAgentsCallback

Node-style callback called with the error, if any, and SearchAgentsResponse

Returns:
Type Description
undefined

searchAgents(request) → {Promise.<google.cloud.dialogflow.v2.SearchAgentsResponse>}

Calls SearchAgents.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.ISearchAgentsRequest

SearchAgentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.dialogflow.v2.SearchAgentsResponse>

Promise

setAgent(request, callback) → {undefined}

Calls SetAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.ISetAgentRequest

SetAgentRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.SetAgentCallback

Node-style callback called with the error, if any, and Agent

Returns:
Type Description
undefined

setAgent(request) → {Promise.<google.cloud.dialogflow.v2.Agent>}

Calls SetAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.ISetAgentRequest

SetAgentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.dialogflow.v2.Agent>

Promise

trainAgent(request, callback) → {undefined}

Calls TrainAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.ITrainAgentRequest

TrainAgentRequest message or plain object

callback google.cloud.dialogflow.v2.Agents.TrainAgentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

trainAgent(request) → {Promise.<google.longrunning.Operation>}

Calls TrainAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.v2.ITrainAgentRequest

TrainAgentRequest message or plain object

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

Promise

Type Definitions

DeleteAgentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#deleteAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

ExportAgentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#exportAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

GetAgentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#getAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.dialogflow.v2.Agent <optional>

Agent

GetValidationResultCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#getValidationResult.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.dialogflow.v2.ValidationResult <optional>

ValidationResult

ImportAgentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#importAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

RestoreAgentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#restoreAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

SearchAgentsCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#searchAgents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.dialogflow.v2.SearchAgentsResponse <optional>

SearchAgentsResponse

SetAgentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#setAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.dialogflow.v2.Agent <optional>

Agent

TrainAgentCallback(error, responseopt)

Callback as used by google.cloud.dialogflow.v2.Agents#trainAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation