Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::EventInput (v0.18.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::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?".

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#language_code

def language_code() -> ::String
Returns
  • (::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.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::String) — Required. The unique identifier of the event.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The unique identifier of the event.
Returns
  • (::String) — Required. The unique identifier of the event.

#parameters

def parameters() -> ::Google::Protobuf::Struct
Returns
  • (::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

#parameters=

def parameters=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::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
Returns
  • (::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