class Aws::LexModelsV2::Types::SlotValueElicitationSetting
Settings that you can use for eliciting a slot value.
@note When making an API call, you may pass SlotValueElicitationSetting
data as a hash: { default_value_specification: { default_value_list: [ # required { default_value: "SlotDefaultValueString", # required }, ], }, slot_constraint: "Required", # required, accepts Required, Optional prompt_specification: { message_groups: [ # required { message: { # required plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, variations: [ { plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, ], }, ], max_retries: 1, # required allow_interrupt: false, }, sample_utterances: [ { utterance: "Utterance", # required }, ], wait_and_continue_specification: { waiting_response: { # required message_groups: [ # required { message: { # required plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, variations: [ { plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, ], }, ], allow_interrupt: false, }, continue_response: { # required message_groups: [ # required { message: { # required plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, variations: [ { plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, ], }, ], allow_interrupt: false, }, still_waiting_response: { message_groups: [ # required { message: { # required plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, variations: [ { plain_text_message: { value: "PlainTextMessageValue", # required }, custom_payload: { value: "CustomPayloadValue", # required }, ssml_message: { value: "SSMLMessageValue", # required }, image_response_card: { title: "AttachmentTitle", # required subtitle: "AttachmentTitle", image_url: "AttachmentUrl", buttons: [ { text: "ButtonText", # required value: "ButtonValue", # required }, ], }, }, ], }, ], frequency_in_seconds: 1, # required timeout_in_seconds: 1, # required allow_interrupt: false, }, active: false, }, }
@!attribute [rw] default_value_specification
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, sesion attributes, and defined values. @return [Types::SlotDefaultValueSpecification]
@!attribute [rw] slot_constraint
Specifies whether the slot is required or optional. @return [String]
@!attribute [rw] prompt_specification
The prompt that Amazon Lex uses to elicit the slot value from the user. @return [Types::PromptSpecification]
@!attribute [rw] sample_utterances
If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances. @return [Array<Types::SampleUtterance>]
@!attribute [rw] wait_and_continue_specification
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input. @return [Types::WaitAndContinueSpecification]
@see docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotValueElicitationSetting AWS API Documentation
Constants
- SENSITIVE