Class: Aws::LexModelsV2::Types::CreateSlotRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

Note:

When making an API call, you may pass CreateSlotRequest data as a hash:

{
  slot_name: "Name", # required
  description: "Description",
  slot_type_id: "BuiltInOrCustomSlotTypeId", # required
  value_elicitation_setting: { # required
    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,
    },
  },
  obfuscation_setting: {
    obfuscation_setting_type: "None", # required, accepts None, DefaultObfuscation
  },
  bot_id: "Id", # required
  bot_version: "DraftBotVersion", # required
  locale_id: "LocaleId", # required
  intent_id: "Id", # required
  multiple_values_setting: {
    allow_multiple_values: false,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bot_idString

The identifier of the bot associated with the slot.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#bot_versionString

The version of the bot associated with the slot.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the slot. Use this to help identify the slot in lists.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#intent_idString

The identifier of the intent that contains the slot.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#locale_idString

The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#multiple_values_settingTypes::MultipleValuesSetting

Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

If the multipleValuesSetting is not set, the default value is false.



2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#obfuscation_settingTypes::ObfuscationSetting

Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.

The default is to obfuscate values in the CloudWatch logs.



2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#slot_nameString

The name of the slot. Slot names must be unique within the bot that contains the slot.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#slot_type_idString

The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

Returns:

  • (String)


2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end

#value_elicitation_settingTypes::SlotValueElicitationSetting

Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.



2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 2978

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting)
  SENSITIVE = []
  include Aws::Structure
end