Agents

google.cloud.dialogflow.cx.v3. 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

createAgent(request, callback) → {undefined}

Calls CreateAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.ICreateAgentRequest

CreateAgentRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.CreateAgentCallback

Node-style callback called with the error, if any, and Agent
Returns:
Type Description
undefined

createAgent(request) → {Promise.<google.cloud.dialogflow.cx.v3.Agent>}

Calls CreateAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.ICreateAgentRequest

CreateAgentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.Agent>

Promise

deleteAgent(request, callback) → {undefined}

Calls DeleteAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IDeleteAgentRequest

DeleteAgentRequest message or plain object
callback google.cloud.dialogflow.cx.v3.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.cx.v3.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.cx.v3.IExportAgentRequest

ExportAgentRequest message or plain object
callback google.cloud.dialogflow.cx.v3.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.cx.v3.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.cx.v3.IGetAgentRequest

GetAgentRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.GetAgentCallback

Node-style callback called with the error, if any, and Agent
Returns:
Type Description
undefined

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

Calls GetAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IGetAgentRequest

GetAgentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.Agent>

Promise

getAgentValidationResult(request, callback) → {undefined}

Calls GetAgentValidationResult.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IGetAgentValidationResultRequest

GetAgentValidationResultRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.GetAgentValidationResultCallback

Node-style callback called with the error, if any, and AgentValidationResult
Returns:
Type Description
undefined

getAgentValidationResult(request) → {Promise.<google.cloud.dialogflow.cx.v3.AgentValidationResult>}

Calls GetAgentValidationResult.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IGetAgentValidationResultRequest

GetAgentValidationResultRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.AgentValidationResult>

Promise

getGenerativeSettings(request, callback) → {undefined}

Calls GetGenerativeSettings.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IGetGenerativeSettingsRequest

GetGenerativeSettingsRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.GetGenerativeSettingsCallback

Node-style callback called with the error, if any, and GenerativeSettings
Returns:
Type Description
undefined

getGenerativeSettings(request) → {Promise.<google.cloud.dialogflow.cx.v3.GenerativeSettings>}

Calls GetGenerativeSettings.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IGetGenerativeSettingsRequest

GetGenerativeSettingsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.GenerativeSettings>

Promise

listAgents(request, callback) → {undefined}

Calls ListAgents.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IListAgentsRequest

ListAgentsRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.ListAgentsCallback

Node-style callback called with the error, if any, and ListAgentsResponse
Returns:
Type Description
undefined

listAgents(request) → {Promise.<google.cloud.dialogflow.cx.v3.ListAgentsResponse>}

Calls ListAgents.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IListAgentsRequest

ListAgentsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.ListAgentsResponse>

Promise

restoreAgent(request, callback) → {undefined}

Calls RestoreAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IRestoreAgentRequest

RestoreAgentRequest message or plain object
callback google.cloud.dialogflow.cx.v3.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.cx.v3.IRestoreAgentRequest

RestoreAgentRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

updateAgent(request, callback) → {undefined}

Calls UpdateAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IUpdateAgentRequest

UpdateAgentRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.UpdateAgentCallback

Node-style callback called with the error, if any, and Agent
Returns:
Type Description
undefined

updateAgent(request) → {Promise.<google.cloud.dialogflow.cx.v3.Agent>}

Calls UpdateAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IUpdateAgentRequest

UpdateAgentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.Agent>

Promise

updateGenerativeSettings(request, callback) → {undefined}

Calls UpdateGenerativeSettings.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IUpdateGenerativeSettingsRequest

UpdateGenerativeSettingsRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.UpdateGenerativeSettingsCallback

Node-style callback called with the error, if any, and GenerativeSettings
Returns:
Type Description
undefined

updateGenerativeSettings(request) → {Promise.<google.cloud.dialogflow.cx.v3.GenerativeSettings>}

Calls UpdateGenerativeSettings.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IUpdateGenerativeSettingsRequest

UpdateGenerativeSettingsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.GenerativeSettings>

Promise

validateAgent(request, callback) → {undefined}

Calls ValidateAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IValidateAgentRequest

ValidateAgentRequest message or plain object
callback google.cloud.dialogflow.cx.v3.Agents.ValidateAgentCallback

Node-style callback called with the error, if any, and AgentValidationResult
Returns:
Type Description
undefined

validateAgent(request) → {Promise.<google.cloud.dialogflow.cx.v3.AgentValidationResult>}

Calls ValidateAgent.

Parameters:
Name Type Description
request google.cloud.dialogflow.cx.v3.IValidateAgentRequest

ValidateAgentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.dialogflow.cx.v3.AgentValidationResult>

Promise

(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.

Type Definitions

CreateAgentCallback(error, responseopt)

Callback as used by createAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.Agent <optional>

Agent

DeleteAgentCallback(error, responseopt)

Callback as used by 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 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 getAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.Agent <optional>

Agent

GetAgentValidationResultCallback(error, responseopt)

Callback as used by getAgentValidationResult.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.AgentValidationResult <optional>

AgentValidationResult

GetGenerativeSettingsCallback(error, responseopt)

Callback as used by getGenerativeSettings.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.GenerativeSettings <optional>

GenerativeSettings

ListAgentsCallback(error, responseopt)

Callback as used by listAgents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.ListAgentsResponse <optional>

ListAgentsResponse

RestoreAgentCallback(error, responseopt)

Callback as used by restoreAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

UpdateAgentCallback(error, responseopt)

Callback as used by updateAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.Agent <optional>

Agent

UpdateGenerativeSettingsCallback(error, responseopt)

Callback as used by updateGenerativeSettings.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.GenerativeSettings <optional>

GenerativeSettings

ValidateAgentCallback(error, responseopt)

Callback as used by validateAgent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.dialogflow.cx.v3.AgentValidationResult <optional>

AgentValidationResult