Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AutomatedAgentReply.
Represents a response from an automated agent.
Generated from protobuf message google.cloud.dialogflow.v2.AutomatedAgentReply
Namespace
Google \ Cloud \ Dialogflow \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ detect_intent_response |
DetectIntentResponse
Response of the Dialogflow Sessions.DetectIntent call. |
↳ response_messages |
array<ResponseMessage>
Response messages from the automated agent. |
↳ intent |
string
Name of the intent if an intent is matched for the query. For a V2 query, the value format is |
↳ event |
string
Event name if an event is triggered for the query. |
↳ match_confidence |
float
The confidence of the match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. |
↳ parameters |
Google\Protobuf\Struct
The collection of current parameters at the time of this response. |
↳ automated_agent_reply_type |
int
AutomatedAgentReply type. |
↳ allow_cancellation |
bool
Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled. |
↳ cx_current_page |
string
The unique identifier of the current Dialogflow CX conversation page. Format: |
↳ call_companion_auth_code |
string
The auth code for accessing Call Companion UI. |
getDetectIntentResponse
Response of the Dialogflow Sessions.DetectIntent call.
| Returns | |
|---|---|
| Type | Description |
DetectIntentResponse|null |
|
hasDetectIntentResponse
clearDetectIntentResponse
setDetectIntentResponse
Response of the Dialogflow Sessions.DetectIntent call.
| Parameter | |
|---|---|
| Name | Description |
var |
DetectIntentResponse
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResponseMessages
Response messages from the automated agent.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ResponseMessage> |
|
setResponseMessages
Response messages from the automated agent.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ResponseMessage>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIntent
Name of the intent if an intent is matched for the query.
For a V2 query, the value format is projects/<Project ID>/locations/
<Location ID>/agent/intents/<Intent ID>.
For a V3 query, the value format is projects/<Project ID>/locations/
<Location ID>/agents/<Agent ID>/intents/<Intent ID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setIntent
Name of the intent if an intent is matched for the query.
For a V2 query, the value format is projects/<Project ID>/locations/
<Location ID>/agent/intents/<Intent ID>.
For a V3 query, the value format is projects/<Project ID>/locations/
<Location ID>/agents/<Agent ID>/intents/<Intent ID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEvent
Event name if an event is triggered for the query.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEvent
Event name if an event is triggered for the query.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMatchConfidence
The confidence of the match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).
This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.
| Returns | |
|---|---|
| Type | Description |
float |
|
setMatchConfidence
The confidence of the match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).
This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParameters
The collection of current parameters at the time of this response.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null |
|
hasParameters
clearParameters
setParameters
The collection of current parameters at the time of this response.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutomatedAgentReplyType
AutomatedAgentReply type.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type AutomatedAgentReplyType. |
setAutomatedAgentReplyType
AutomatedAgentReply type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type AutomatedAgentReplyType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowCancellation
Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setAllowCancellation
Indicates whether the partial automated agent reply is interruptible when a later reply message arrives. e.g. if the agent specified some music as partial response, it can be cancelled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCxCurrentPage
The unique identifier of the current Dialogflow CX conversation page.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCxCurrentPage
The unique identifier of the current Dialogflow CX conversation page.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCallCompanionAuthCode
The auth code for accessing Call Companion UI.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCallCompanionAuthCode
The auth code for accessing Call Companion UI.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|