interface SubSlotValueElicitationSettingProperty

Language	Type name
.NET	Amazon.CDK.AWS.Lex.CfnBot.SubSlotValueElicitationSettingProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_SubSlotValueElicitationSettingProperty
Java	software.amazon.awscdk.services.lex.CfnBot.SubSlotValueElicitationSettingProperty
Python	aws_cdk.aws_lex.CfnBot.SubSlotValueElicitationSettingProperty
TypeScript	aws-cdk-lib » aws_lex » CfnBot » SubSlotValueElicitationSettingProperty

Subslot elicitation settings.

DefaultValueSpecification is a list of default values for a constituent sub slot in a composite 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. This is similar to DefaultValueSpecification for slots.

PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification for slots.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
const subSlotValueElicitationSettingProperty: lex.CfnBot.SubSlotValueElicitationSettingProperty = {
  defaultValueSpecification: {
    defaultValueList: [{
      defaultValue: 'defaultValue',
    }],
  },
  promptSpecification: {
    maxRetries: 123,
    messageGroupsList: [{
      message: {
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      },

      // the properties below are optional
      variations: [{
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      }],
    }],

    // the properties below are optional
    allowInterrupt: false,
    messageSelectionStrategy: 'messageSelectionStrategy',
    promptAttemptsSpecification: {
      promptAttemptsSpecificationKey: {
        allowedInputTypes: {
          allowAudioInput: false,
          allowDtmfInput: false,
        },

        // the properties below are optional
        allowInterrupt: false,
        audioAndDtmfInputSpecification: {
          startTimeoutMs: 123,

          // the properties below are optional
          audioSpecification: {
            endTimeoutMs: 123,
            maxLengthMs: 123,
          },
          dtmfSpecification: {
            deletionCharacter: 'deletionCharacter',
            endCharacter: 'endCharacter',
            endTimeoutMs: 123,
            maxLength: 123,
          },
        },
        textInputSpecification: {
          startTimeoutMs: 123,
        },
      },
    },
  },
  sampleUtterances: [{
    utterance: 'utterance',
  }],
  waitAndContinueSpecification: {
    continueResponse: {
      messageGroupsList: [{
        message: {
          customPayload: {
            value: 'value',
          },
          imageResponseCard: {
            title: 'title',

            // the properties below are optional
            buttons: [{
              text: 'text',
              value: 'value',
            }],
            imageUrl: 'imageUrl',
            subtitle: 'subtitle',
          },
          plainTextMessage: {
            value: 'value',
          },
          ssmlMessage: {
            value: 'value',
          },
        },

        // the properties below are optional
        variations: [{
          customPayload: {
            value: 'value',
          },
          imageResponseCard: {
            title: 'title',

            // the properties below are optional
            buttons: [{
              text: 'text',
              value: 'value',
            }],
            imageUrl: 'imageUrl',
            subtitle: 'subtitle',
          },
          plainTextMessage: {
            value: 'value',
          },
          ssmlMessage: {
            value: 'value',
          },
        }],
      }],

      // the properties below are optional
      allowInterrupt: false,
    },
    waitingResponse: {
      messageGroupsList: [{
        message: {
          customPayload: {
            value: 'value',
          },
          imageResponseCard: {
            title: 'title',

            // the properties below are optional
            buttons: [{
              text: 'text',
              value: 'value',
            }],
            imageUrl: 'imageUrl',
            subtitle: 'subtitle',
          },
          plainTextMessage: {
            value: 'value',
          },
          ssmlMessage: {
            value: 'value',
          },
        },

        // the properties below are optional
        variations: [{
          customPayload: {
            value: 'value',
          },
          imageResponseCard: {
            title: 'title',

            // the properties below are optional
            buttons: [{
              text: 'text',
              value: 'value',
            }],
            imageUrl: 'imageUrl',
            subtitle: 'subtitle',
          },
          plainTextMessage: {
            value: 'value',
          },
          ssmlMessage: {
            value: 'value',
          },
        }],
      }],

      // the properties below are optional
      allowInterrupt: false,
    },

    // the properties below are optional
    isActive: false,
    stillWaitingResponse: {
      frequencyInSeconds: 123,
      messageGroupsList: [{
        message: {
          customPayload: {
            value: 'value',
          },
          imageResponseCard: {
            title: 'title',

            // the properties below are optional
            buttons: [{
              text: 'text',
              value: 'value',
            }],
            imageUrl: 'imageUrl',
            subtitle: 'subtitle',
          },
          plainTextMessage: {
            value: 'value',
          },
          ssmlMessage: {
            value: 'value',
          },
        },

        // the properties below are optional
        variations: [{
          customPayload: {
            value: 'value',
          },
          imageResponseCard: {
            title: 'title',

            // the properties below are optional
            buttons: [{
              text: 'text',
              value: 'value',
            }],
            imageUrl: 'imageUrl',
            subtitle: 'subtitle',
          },
          plainTextMessage: {
            value: 'value',
          },
          ssmlMessage: {
            value: 'value',
          },
        }],
      }],
      timeoutInSeconds: 123,

      // the properties below are optional
      allowInterrupt: false,
    },
  },
};

Properties

Name	Type	Description
defaultValueSpecification?	IResolvable | SlotDefaultValueSpecificationProperty
promptSpecification?	IResolvable | PromptSpecificationProperty
sampleUtterances?	IResolvable | IResolvable | SampleUtteranceProperty[]	If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy.
waitAndContinueSpecification?	IResolvable | WaitAndContinueSpecificationProperty

---

defaultValueSpecification?

Type: IResolvable | SlotDefaultValueSpecificationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-defaultvaluespecification

---

promptSpecification?

Type: IResolvable | PromptSpecificationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-promptspecification

---

sampleUtterances?

Type: IResolvable | IResolvable | SampleUtteranceProperty[] (optional)

If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy.

This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-sampleutterances

---

waitAndContinueSpecification?

Type: IResolvable | WaitAndContinueSpecificationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-waitandcontinuespecification