Google Cloud Dialogflow Cx V3 Client - Class VirtualAgentOutput (0.2.1)

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 \ ConversationTurn

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
Google\Protobuf\Struct|null

hasSessionParameters

clearSessionParameters

setSessionParameters

The session parameters available to the bot at this point.

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\Dialogflow\Cx\V3\TestRunDifference>
Returns
TypeDescription
$this

getDiagnosticInfo

Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.

Returns
TypeDescription
Google\Protobuf\Struct|null

hasDiagnosticInfo

clearDiagnosticInfo

setDiagnosticInfo

Required. Input only. The diagnostic info output for the turn. Required to calculate the testing coverage.

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this

getTriggeredIntent

The Intent that triggered the response. Only name and displayName will be set.

Returns
TypeDescription
Google\Cloud\Dialogflow\Cx\V3\Intent|null

hasTriggeredIntent

clearTriggeredIntent

setTriggeredIntent

The Intent that triggered the response. Only name and displayName will be set.

Parameter
NameDescription
var Google\Cloud\Dialogflow\Cx\V3\Intent
Returns
TypeDescription
$this

getCurrentPage

The Page on which the utterance was spoken. Only name and displayName will be set.

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Dialogflow\Cx\V3\Page
Returns
TypeDescription
$this

getTextResponses

The text responses from the agent for the turn.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTextResponses

The text responses from the agent for the turn.

Parameter
NameDescription
var array<Google\Cloud\Dialogflow\Cx\V3\ResponseMessage\Text>
Returns
TypeDescription
$this

getStatus

Response error from the agent in the test result. If set, other output is empty.

Returns
TypeDescription
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

Response error from the agent in the test result. If set, other output is empty.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this