Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class EventInput.
Events allow for matching intents by event name instead of the natural
language input. For instance, input <event: { name: "welcome_event",
parameters: { name: "Sam" } }> can trigger a personalized welcome response.
The parameter name may be used by the agent in the response:
"Hello #welcome_event.name! What can I do for you today?".
Generated from protobuf message google.cloud.dialogflow.v2.EventInput
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The unique identifier of the event. |
↳ parameters |
Google\Protobuf\Struct
The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value |
↳ language_code |
string
Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request. |
getName
Required. The unique identifier of the event.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The unique identifier of the event.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParameters
The collection of parameters associated with the event.
Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
- MapKey type: string
- MapKey value: parameter name
- MapValue type:
- If parameter's entity type is a composite entity: map
- Else: depending on parameter value type, could be one of string, number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity: map from composite entity property names to property values
- Else: parameter value
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasParameters
clearParameters
setParameters
The collection of parameters associated with the event.
Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
- MapKey type: string
- MapKey value: parameter name
- MapValue type:
- If parameter's entity type is a composite entity: map
- Else: depending on parameter value type, could be one of string, number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity: map from composite entity property names to property values
- Else: parameter value
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageCode
Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.
| Returns | |
|---|---|
| Type | Description |
string | |
setLanguageCode
Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |