Class: Aws::LexModelsV2::Types::SlotValueElicitationSetting
- Inherits:
-
Struct
- Object
- Struct
- Aws::LexModelsV2::Types::SlotValueElicitationSetting
- Defined in:
- gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb
Overview
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,
message_selection_strategy: "Random", # accepts Random, Ordered
},
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,
},
}
Settings that you can use for eliciting a slot value.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#default_value_specification ⇒ Types::SlotDefaultValueSpecification
A list of default values for a slot.
-
#prompt_specification ⇒ Types::PromptSpecification
The prompt that Amazon Lex uses to elicit the slot value from the user.
-
#sample_utterances ⇒ Array<Types::SampleUtterance>
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.
-
#slot_constraint ⇒ String
Specifies whether the slot is required or optional.
-
#wait_and_continue_specification ⇒ Types::WaitAndContinueSpecification
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
Instance Attribute Details
#default_value_specification ⇒ Types::SlotDefaultValueSpecification
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, session attributes, and defined values.
10429 10430 10431 10432 10433 10434 10435 10436 10437 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 10429 class SlotValueElicitationSetting < Struct.new( :default_value_specification, :slot_constraint, :prompt_specification, :sample_utterances, :wait_and_continue_specification) SENSITIVE = [] include Aws::Structure end |
#prompt_specification ⇒ Types::PromptSpecification
The prompt that Amazon Lex uses to elicit the slot value from the user.
10429 10430 10431 10432 10433 10434 10435 10436 10437 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 10429 class SlotValueElicitationSetting < Struct.new( :default_value_specification, :slot_constraint, :prompt_specification, :sample_utterances, :wait_and_continue_specification) SENSITIVE = [] include Aws::Structure end |
#sample_utterances ⇒ Array<Types::SampleUtterance>
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.
10429 10430 10431 10432 10433 10434 10435 10436 10437 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 10429 class SlotValueElicitationSetting < Struct.new( :default_value_specification, :slot_constraint, :prompt_specification, :sample_utterances, :wait_and_continue_specification) SENSITIVE = [] include Aws::Structure end |
#slot_constraint ⇒ String
Specifies whether the slot is required or optional.
10429 10430 10431 10432 10433 10434 10435 10436 10437 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 10429 class SlotValueElicitationSetting < Struct.new( :default_value_specification, :slot_constraint, :prompt_specification, :sample_utterances, :wait_and_continue_specification) SENSITIVE = [] include Aws::Structure end |
#wait_and_continue_specification ⇒ Types::WaitAndContinueSpecification
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
10429 10430 10431 10432 10433 10434 10435 10436 10437 |
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 10429 class SlotValueElicitationSetting < Struct.new( :default_value_specification, :slot_constraint, :prompt_specification, :sample_utterances, :wait_and_continue_specification) SENSITIVE = [] include Aws::Structure end |