Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Action.
Action performed by end user or Dialogflow agent in the conversation.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Action
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ user_utterance |
UserUtterance
Optional. Agent obtained a message from the customer. |
↳ agent_utterance |
AgentUtterance
Optional. Action performed by the agent as a message. |
↳ tool_use |
ToolUse
Optional. Action performed on behalf of the agent by calling a plugin tool. |
↳ playbook_invocation |
PlaybookInvocation
Optional. Action performed on behalf of the agent by invoking a child playbook. |
↳ flow_invocation |
FlowInvocation
Optional. Action performed on behalf of the agent by invoking a CX flow. |
↳ playbook_transition |
PlaybookTransition
Optional. Action performed on behalf of the agent by transitioning to a target playbook. |
↳ flow_transition |
FlowTransition
Optional. Action performed on behalf of the agent by transitioning to a target CX flow. |
getUserUtterance
Optional. Agent obtained a message from the customer.
| Returns | |
|---|---|
| Type | Description |
UserUtterance|null |
|
hasUserUtterance
setUserUtterance
Optional. Agent obtained a message from the customer.
| Parameter | |
|---|---|
| Name | Description |
var |
UserUtterance
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAgentUtterance
Optional. Action performed by the agent as a message.
| Returns | |
|---|---|
| Type | Description |
AgentUtterance|null |
|
hasAgentUtterance
setAgentUtterance
Optional. Action performed by the agent as a message.
| Parameter | |
|---|---|
| Name | Description |
var |
AgentUtterance
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToolUse
Optional. Action performed on behalf of the agent by calling a plugin tool.
| Returns | |
|---|---|
| Type | Description |
ToolUse|null |
|
hasToolUse
setToolUse
Optional. Action performed on behalf of the agent by calling a plugin tool.
| Parameter | |
|---|---|
| Name | Description |
var |
ToolUse
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlaybookInvocation
Optional. Action performed on behalf of the agent by invoking a child playbook.
| Returns | |
|---|---|
| Type | Description |
PlaybookInvocation|null |
|
hasPlaybookInvocation
setPlaybookInvocation
Optional. Action performed on behalf of the agent by invoking a child playbook.
| Parameter | |
|---|---|
| Name | Description |
var |
PlaybookInvocation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFlowInvocation
Optional. Action performed on behalf of the agent by invoking a CX flow.
| Returns | |
|---|---|
| Type | Description |
FlowInvocation|null |
|
hasFlowInvocation
setFlowInvocation
Optional. Action performed on behalf of the agent by invoking a CX flow.
| Parameter | |
|---|---|
| Name | Description |
var |
FlowInvocation
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlaybookTransition
Optional. Action performed on behalf of the agent by transitioning to a target playbook.
| Returns | |
|---|---|
| Type | Description |
PlaybookTransition|null |
|
hasPlaybookTransition
setPlaybookTransition
Optional. Action performed on behalf of the agent by transitioning to a target playbook.
| Parameter | |
|---|---|
| Name | Description |
var |
PlaybookTransition
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFlowTransition
Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
| Returns | |
|---|---|
| Type | Description |
FlowTransition|null |
|
hasFlowTransition
setFlowTransition
Optional. Action performed on behalf of the agent by transitioning to a target CX flow.
| Parameter | |
|---|---|
| Name | Description |
var |
FlowTransition
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAction
| Returns | |
|---|---|
| Type | Description |
string |
|