Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class Parameter.
Represents intent parameters.
Generated from protobuf message google.cloud.dialogflow.v2.Intent.Parameter
Namespace
Google \ Cloud \ Dialogflow \ V2 \ IntentMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The unique identifier of this parameter.
↳ display_name
string
Required. The name of the 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
.
↳ default_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
.
↳ entity_type_display_name
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.
↳ mandatory
bool
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
↳ prompts
array
Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
↳ is_list
bool
Optional. Indicates whether the parameter represents a list of values.
getName
The unique identifier of this parameter.
string
setName
The unique identifier of this parameter.
var
string
$this
getDisplayName
Required. The name of the parameter.
string
setDisplayName
Required. The name of the parameter.
var
string
$this
getValue
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.
string
setValue
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.
var
string
$this
getDefaultValue
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
.
string
setDefaultValue
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
.
var
string
$this
getEntityTypeDisplayName
Optional. The name of the entity type, prefixed with @
, that
describes values of the parameter. If the parameter is
required, this must be provided.
string
setEntityTypeDisplayName
Optional. The name of the entity type, prefixed with @
, that
describes values of the parameter. If the parameter is
required, this must be provided.
var
string
$this
getMandatory
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
bool
setMandatory
Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
var
bool
$this
getPrompts
Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
setPrompts
Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.
var
string[]
$this
getIsList
Optional. Indicates whether the parameter represents a list of values.
bool
setIsList
Optional. Indicates whether the parameter represents a list of values.
var
bool
$this
