Slot

public struct Slot : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • A description of the slot.

    Declaration

    Swift

    public let description: String?

  • The name of the slot.

    Declaration

    Swift

    public let name: String

  • Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is “full_name”, obfuscated values are replaced with “{full_name}”. For more information, see Slot Obfuscation .

    Declaration

    Swift

    public let obfuscationSetting: ObfuscationSetting?

  • Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1. If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.

    Declaration

    Swift

    public let priority: Int?

  • A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

    Declaration

    Swift

    public let responseCard: String?

  • If you know a specific pattern with which 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.

    Declaration

    Swift

    public let sampleUtterances: [String]?

  • Specifies whether the slot is required or optional.

    Declaration

    Swift

    public let slotConstraint: SlotConstraint

  • The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

    Declaration

    Swift

    public let slotType: String?

  • The version of the slot type.

    Declaration

    Swift

    public let slotTypeVersion: String?

  • The prompt that Amazon Lex uses to elicit the slot value from the user.

    Declaration

    Swift

    public let valueElicitationPrompt: Prompt?

  • Undocumented

    Declaration

    Swift

    public init(description: String? = nil, name: String, obfuscationSetting: ObfuscationSetting? = nil, priority: Int? = nil, responseCard: String? = nil, sampleUtterances: [String]? = nil, slotConstraint: SlotConstraint, slotType: String? = nil, slotTypeVersion: String? = nil, valueElicitationPrompt: Prompt? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws