Google Cloud Dialogflow Cx V3 Client - Class MatchIntentResponse (0.4.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class MatchIntentResponse.

Response of MatchIntent.

Generated from protobuf message google.cloud.dialogflow.cx.v3.MatchIntentResponse

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ text string

If natural language text was provided as input, this field will contain a copy of the text.

↳ trigger_intent string

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

↳ transcript string

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

↳ trigger_event string

If an event was provided as input, this field will contain a copy of the event name.

↳ matches array<Google\Cloud\Dialogflow\Cx\V3\PBMatch>

Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query.

↳ current_page Google\Cloud\Dialogflow\Cx\V3\Page

The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

getText

If natural language text was provided as input, this field will contain a copy of the text.

Returns
Type Description
string

hasText

setText

If natural language text was provided as input, this field will contain a copy of the text.

Parameter
Name Description
var string
Returns
Type Description
$this

getTriggerIntent

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Returns
Type Description
string

hasTriggerIntent

setTriggerIntent

If an intent was provided as input, this field will contain a copy of the intent identifier. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/intents/<Intent ID>.

Parameter
Name Description
var string
Returns
Type Description
$this

getTranscript

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

Returns
Type Description
string

hasTranscript

setTranscript

If natural language speech audio was provided as input, this field will contain the transcript for the audio.

Parameter
Name Description
var string
Returns
Type Description
$this

getTriggerEvent

If an event was provided as input, this field will contain a copy of the event name.

Returns
Type Description
string

hasTriggerEvent

setTriggerEvent

If an event was provided as input, this field will contain a copy of the event name.

Parameter
Name Description
var string
Returns
Type Description
$this

getMatches

Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMatches

Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query.

Parameter
Name Description
var array<Google\Cloud\Dialogflow\Cx\V3\PBMatch>
Returns
Type Description
$this

getCurrentPage

The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

Returns
Type Description
Google\Cloud\Dialogflow\Cx\V3\Page|null

hasCurrentPage

clearCurrentPage

setCurrentPage

The current Page. Some, not all fields are filled in this message, including but not limited to name and display_name.

Parameter
Name Description
var Google\Cloud\Dialogflow\Cx\V3\Page
Returns
Type Description
$this

getQuery

Returns
Type Description
string