Google Cloud Dialogflow V2 Client - Class GuidanceInstruction (2.8.0)

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

Guidance instruction for the companion agent.

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

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. This name should be unique within the companion agent.

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

↳ actions array<GuidanceInstruction\Action>

Optional. The action items that can be processed.

↳ trigger_event int

Optional. Event that triggers the guidance instruction. If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.

↳ disable_suggested_reply bool

Optional. Whether to disable suggested reply generation for this instruction. When set to true, guidance generated from this instruction will not include a suggested reply. Default is false (suggested reply enabled).

getDisplayName

Optional. Display name for the instruction. This name should be unique within the companion agent.

Returns
Type Description
string

setDisplayName

Optional. Display name for the instruction. This name should be unique within the companion agent.

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

getActions

Optional. The action items that can be processed.

Returns
Type Description
Google\Protobuf\RepeatedField<GuidanceInstruction\Action>

setActions

Optional. The action items that can be processed.

Parameter
Name Description
var array<GuidanceInstruction\Action>
Returns
Type Description
$this

getTriggerEvent

Optional. Event that triggers the guidance instruction.

If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.

Returns
Type Description
int Enum of type TriggerEvent.

setTriggerEvent

Optional. Event that triggers the guidance instruction.

If UNSPECIFIED, the instruction triggering will be the same as the skill's skill_triggering_event.

Parameter
Name Description
var int

Enum of type TriggerEvent.

Returns
Type Description
$this

getDisableSuggestedReply

Optional. Whether to disable suggested reply generation for this instruction. When set to true, guidance generated from this instruction will not include a suggested reply. Default is false (suggested reply enabled).

Returns
Type Description
bool

setDisableSuggestedReply

Optional. Whether to disable suggested reply generation for this instruction. When set to true, guidance generated from this instruction will not include a suggested reply. Default is false (suggested reply enabled).

Parameter
Name Description
var bool
Returns
Type Description
$this