Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class VirtualAgentOutput.
The output from the virtual agent.
Generated from protobuf message google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3 \ ConversationTurnMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session_parameters |
Google\Protobuf\Struct
The session parameters available to the bot at this point. |
↳ differences |
array<Google\Cloud\Dialogflow\Cx\V3\TestRunDifference>
Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any. |
↳ diagnostic_info |
Google\Protobuf\Struct
Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage. |
↳ triggered_intent |
Google\Cloud\Dialogflow\Cx\V3\Intent
The Intent that triggered the response. Only name and displayName will be set. |
↳ current_page |
Google\Cloud\Dialogflow\Cx\V3\Page
The Page on which the utterance was spoken. Only name and displayName will be set. |
↳ text_responses |
array<Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\Text>
The text responses from the agent for the turn. |
↳ status |
Google\Rpc\Status
Response error from the agent in the test result. If set, other output is empty. |
getSessionParameters
The session parameters available to the bot at this point.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasSessionParameters
clearSessionParameters
setSessionParameters
The session parameters available to the bot at this point.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDifferences
Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDifferences
Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\Cx\V3\TestRunDifference>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiagnosticInfo
Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasDiagnosticInfo
clearDiagnosticInfo
setDiagnosticInfo
Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTriggeredIntent
The Intent that triggered the response. Only name and displayName will be set.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\Cx\V3\Intent|null | |
hasTriggeredIntent
clearTriggeredIntent
setTriggeredIntent
The Intent that triggered the response. Only name and displayName will be set.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\Intent
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCurrentPage
The Page on which the utterance was spoken. Only name and displayName will be set.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\Cx\V3\Page|null | |
hasCurrentPage
clearCurrentPage
setCurrentPage
The Page on which the utterance was spoken. Only name and displayName will be set.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\Cx\V3\Page
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTextResponses
The text responses from the agent for the turn.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTextResponses
The text responses from the agent for the turn.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\Text>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
Response error from the agent in the test result. If set, other output is empty.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasStatus
clearStatus
setStatus
Response error from the agent in the test result. If set, other output is empty.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |