Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Intent::Parameter (v1.2.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Intent::Parameter.

Represents intent parameters.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#default_value

def default_value() -> ::String
Returns
  • (::String) — Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name.

#default_value=

def default_value=(value) -> ::String
Parameter
  • value (::String) — Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name.
Returns
  • (::String) — Optional. The default value to use when the value yields an empty result. Default values can be extracted from contexts by using the following syntax: #context_name.parameter_name.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The name of the parameter.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the parameter.
Returns
  • (::String) — Required. The name of the parameter.

#entity_type_display_name

def entity_type_display_name() -> ::String
Returns
  • (::String) — Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided.

#entity_type_display_name=

def entity_type_display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided.
Returns
  • (::String) — Optional. The name of the entity type, prefixed with @, that describes values of the parameter. If the parameter is required, this must be provided.

#is_list

def is_list() -> ::Boolean
Returns
  • (::Boolean) — Optional. Indicates whether the parameter represents a list of values.

#is_list=

def is_list=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Indicates whether the parameter represents a list of values.
Returns
  • (::Boolean) — Optional. Indicates whether the parameter represents a list of values.

#mandatory

def mandatory() -> ::Boolean
Returns
  • (::Boolean) — Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

#mandatory=

def mandatory=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
Returns
  • (::Boolean) — Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.

#name

def name() -> ::String
Returns
  • (::String) — The unique identifier of this parameter.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of this parameter.
Returns
  • (::String) — The unique identifier of this parameter.

#prompts

def prompts() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

#prompts=

def prompts=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
Returns
  • (::Array<::String>) — Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.

#value

def value() -> ::String
Returns
  • (::String) —

    Optional. The definition of the parameter value. It can be:

    • a constant string,
    • a parameter value defined as $parameter_name,
    • an original parameter value defined as $parameter_name.original,
    • a parameter value from some context defined as #context_name.parameter_name.

#value=

def value=(value) -> ::String
Parameter
  • value (::String) —

    Optional. The definition of the parameter value. It can be:

    • a constant string,
    • a parameter value defined as $parameter_name,
    • an original parameter value defined as $parameter_name.original,
    • a parameter value from some context defined as #context_name.parameter_name.
Returns
  • (::String) —

    Optional. The definition of the parameter value. It can be:

    • a constant string,
    • a parameter value defined as $parameter_name,
    • an original parameter value defined as $parameter_name.original,
    • a parameter value from some context defined as #context_name.parameter_name.