Google Cloud Dialogflow V2 Client - Class TurnInput (2.8.0)

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

Input that forms data for a single turn.

Generated from protobuf message google.cloud.dialogflow.v2.BidiStreamingAnalyzeContentRequest.TurnInput

Namespace

Google \ Cloud \ Dialogflow \ V2 \ BidiStreamingAnalyzeContentRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ text string

The UTF-8 encoded natural language text to be processed.

↳ intent string

The intent to be triggered on V3 agent. Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>. This can only be used to trigger the Welcome intent id if the modality is text.

↳ event string

The input event name. This can only be sent once and would cancel the ongoing speech recognition if any. To trigger the Welcome intent use the event "WELCOME"

↳ suggestion_input Google\Cloud\Dialogflow\V2\SuggestionInput

Optional. Input for confirming, revising, or canceling a suggestion.

↳ virtual_agent_parameters Google\Protobuf\Struct

Optional. Parameters to be passed to the virtual agent.

getText

The UTF-8 encoded natural language text to be processed.

Returns
Type Description
string

hasText

setText

The UTF-8 encoded natural language text to be processed.

Parameter
Name Description
var string
Returns
Type Description
$this

getIntent

The intent to be triggered on V3 agent.

Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>. This can only be used to trigger the Welcome intent id if the modality is text.

Returns
Type Description
string

hasIntent

setIntent

The intent to be triggered on V3 agent.

Format: projects/<Project ID>/locations/<Location ID>/locations/ <Location ID>/agents/<Agent ID>/intents/<Intent ID>. This can only be used to trigger the Welcome intent id if the modality is text.

Parameter
Name Description
var string
Returns
Type Description
$this

getEvent

The input event name.

This can only be sent once and would cancel the ongoing speech recognition if any. To trigger the Welcome intent use the event "WELCOME"

Returns
Type Description
string

hasEvent

setEvent

The input event name.

This can only be sent once and would cancel the ongoing speech recognition if any. To trigger the Welcome intent use the event "WELCOME"

Parameter
Name Description
var string
Returns
Type Description
$this

getSuggestionInput

Optional. Input for confirming, revising, or canceling a suggestion.

Returns
Type Description
Google\Cloud\Dialogflow\V2\SuggestionInput|null

hasSuggestionInput

setSuggestionInput

Optional. Input for confirming, revising, or canceling a suggestion.

Parameter
Name Description
var Google\Cloud\Dialogflow\V2\SuggestionInput
Returns
Type Description
$this

getVirtualAgentParameters

Optional. Parameters to be passed to the virtual agent.

Returns
Type Description
Google\Protobuf\Struct|null

hasVirtualAgentParameters

clearVirtualAgentParameters

setVirtualAgentParameters

Optional. Parameters to be passed to the virtual agent.

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this

getMainContent

Returns
Type Description
string