Class Parameter (2.38.0)

Version latest

• 2.38.0 (latest)
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.2
• 2.29.0
• 2.28.3
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.8.0
• 0.7.2

Parameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents intent parameters.

Attributes
Name	Description
name	str The unique identifier of this parameter.
display_name	str Required. The name of the parameter.
value	str 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	str 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	str 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	MutableSequence[str] 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.