Struct Parameter 

#[non_exhaustive]
pub struct Parameter {
    pub name: String,
    pub display_name: String,
    pub value: String,
    pub default_value: String,
    pub entity_type_display_name: String,
    pub mandatory: bool,
    pub prompts: Vec<String>,
    pub is_list: bool,
    /* private fields */
}

Available on crate features answer-records or intents or participants or sessions only.

Represents intent parameters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: Vec<String>

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.

Implementations

impl Parameter

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Parameter::new().set_name("example");

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = Parameter::new().set_display_name("example");

pub fn set_value<T: Into<String>>(self, v: T) -> Self

Sets the value of value.

Example

let x = Parameter::new().set_value("example");

pub fn set_default_value<T: Into<String>>(self, v: T) -> Self

Sets the value of default_value.

Example

let x = Parameter::new().set_default_value("example");

pub fn set_entity_type_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of entity_type_display_name.

Example

let x = Parameter::new().set_entity_type_display_name("example");

pub fn set_mandatory<T: Into<bool>>(self, v: T) -> Self

Sets the value of mandatory.

Example

let x = Parameter::new().set_mandatory(true);

pub fn set_prompts<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of prompts.

Example

let x = Parameter::new().set_prompts(["a", "b", "c"]);

pub fn set_is_list<T: Into<bool>>(self, v: T) -> Self

Sets the value of is_list.

Example

let x = Parameter::new().set_is_list(true);

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Parameter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

impl Message for Parameter

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Parameter

fn eq(&self, other: &Parameter) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Parameter