Google Cloud Dialogflow V2 Client - Class AgentCoachingInstruction (2.3.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AgentCoachingInstruction.

Agent Coaching instructions that customer can configure.

Generated from protobuf message google.cloud.dialogflow.v2.AgentCoachingInstruction

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ display_name string

Optional. Display name for the instruction.

↳ display_details string

Optional. The detailed description of this instruction.

↳ condition string

Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.

↳ agent_action string

Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty

↳ system_action string

Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty

↳ duplicate_check_result AgentCoachingInstruction\DuplicateCheckResult

Output only. Duplication check for the AgentCoachingInstruction.

↳ triggering_event int

Optional. The event that should trigger this instruction. If UNSPECIFIED, the instruction triggering will be same as the generator's trigger_event.

getDisplayName

Optional. Display name for the instruction.

Returns
Type Description
string

setDisplayName

Optional. Display name for the instruction.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayDetails

Optional. The detailed description of this instruction.

Returns
Type Description
string

setDisplayDetails

Optional. The detailed description of this instruction.

Parameter
Name Description
var string
Returns
Type Description
$this

getCondition

Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.

Returns
Type Description
string

setCondition

Optional. The condition of the instruction. For example, "the customer wants to cancel an order". If the users want the instruction to be triggered unconditionally, the condition can be empty.

Parameter
Name Description
var string
Returns
Type Description
$this

getAgentAction

Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty

Returns
Type Description
string

setAgentAction

Optional. The action that human agent should take. For example, "apologize for the slow shipping". If the users only want to use agent coaching for intent detection, agent_action can be empty

Parameter
Name Description
var string
Returns
Type Description
$this

getSystemAction

Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty

Returns
Type Description
string

setSystemAction

Optional. The action that system should take. For example, "call GetOrderTime with order_number={order number provided by the customer}". If the users don't have plugins or don't want to trigger plugins, the system_action can be empty

Parameter
Name Description
var string
Returns
Type Description
$this

getDuplicateCheckResult

Output only. Duplication check for the AgentCoachingInstruction.

Returns
Type Description
AgentCoachingInstruction\DuplicateCheckResult|null

hasDuplicateCheckResult

clearDuplicateCheckResult

setDuplicateCheckResult

Output only. Duplication check for the AgentCoachingInstruction.

Parameter
Name Description
var AgentCoachingInstruction\DuplicateCheckResult
Returns
Type Description
$this

getTriggeringEvent

Optional. The event that should trigger this instruction.

If UNSPECIFIED, the instruction triggering will be same as the generator's trigger_event.

Returns
Type Description
int Enum of type TriggerEvent.

setTriggeringEvent

Optional. The event that should trigger this instruction.

If UNSPECIFIED, the instruction triggering will be same as the generator's trigger_event.

Parameter
Name Description
var int

Enum of type TriggerEvent.

Returns
Type Description
$this