« blib/lib/Paws/LexModels/ResourceReference.pm
↑ Summary
blib/lib/Paws/LexModels/SlotDefaultValue.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::LexModels::Slot; | ||
| 3 | use Moose; | ||
| 4 | has DefaultValueSpec => (is => 'ro', isa => 'Paws::LexModels::SlotDefaultValueSpec', request_name => 'defaultValueSpec', traits => ['NameInRequest']); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1); | ||
| 7 | has ObfuscationSetting => (is => 'ro', isa => 'Str', request_name => 'obfuscationSetting', traits => ['NameInRequest']); | ||
| 8 | has Priority => (is => 'ro', isa => 'Int', request_name => 'priority', traits => ['NameInRequest']); | ||
| 9 | has ResponseCard => (is => 'ro', isa => 'Str', request_name => 'responseCard', traits => ['NameInRequest']); | ||
| 10 | has SampleUtterances => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'sampleUtterances', traits => ['NameInRequest']); | ||
| 11 | has SlotConstraint => (is => 'ro', isa => 'Str', request_name => 'slotConstraint', traits => ['NameInRequest'], required => 1); | ||
| 12 | has SlotType => (is => 'ro', isa => 'Str', request_name => 'slotType', traits => ['NameInRequest']); | ||
| 13 | has SlotTypeVersion => (is => 'ro', isa => 'Str', request_name => 'slotTypeVersion', traits => ['NameInRequest']); | ||
| 14 | has ValueElicitationPrompt => (is => 'ro', isa => 'Paws::LexModels::Prompt', request_name => 'valueElicitationPrompt', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::LexModels::Slot | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::LexModels::Slot object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { DefaultValueSpec => $value, ..., ValueElicitationPrompt => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::LexModels::Slot object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->DefaultValueSpec | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Identifies the version of a specific slot. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 DefaultValueSpec => L<Paws::LexModels::SlotDefaultValueSpec> | ||
| 52 | |||
| 53 | A list of default values for the slot. Default values are used when | ||
| 54 | Amazon Lex hasn't determined a value for a slot. You can specify | ||
| 55 | default values from context variables, session attributes, and defined | ||
| 56 | values. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Description => Str | ||
| 60 | |||
| 61 | A description of the slot. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Name => Str | ||
| 65 | |||
| 66 | The name of the slot. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ObfuscationSetting => Str | ||
| 70 | |||
| 71 | Determines whether a slot is obfuscated in conversation logs and stored | ||
| 72 | utterances. When you obfuscate a slot, the value is replaced by the | ||
| 73 | slot name in curly braces ({}). For example, if the slot name is | ||
| 74 | "full_name", obfuscated values are replaced with "{full_name}". For | ||
| 75 | more information, see Slot Obfuscation | ||
| 76 | (https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html). | ||
| 77 | |||
| 78 | |||
| 79 | =head2 Priority => Int | ||
| 80 | |||
| 81 | Directs Amazon Lex the order in which to elicit this slot value from | ||
| 82 | the user. For example, if the intent has two slots with priorities 1 | ||
| 83 | and 2, AWS Amazon Lex first elicits a value for the slot with priority | ||
| 84 | 1. | ||
| 85 | |||
| 86 | If multiple slots share the same priority, the order in which Amazon | ||
| 87 | Lex elicits values is arbitrary. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ResponseCard => Str | ||
| 91 | |||
| 92 | A set of possible responses for the slot type used by text-based | ||
| 93 | clients. A user chooses an option from the response card, instead of | ||
| 94 | using text to reply. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 SampleUtterances => ArrayRef[Str|Undef] | ||
| 98 | |||
| 99 | If you know a specific pattern with which users might respond to an | ||
| 100 | Amazon Lex request for a slot value, you can provide those utterances | ||
| 101 | to improve accuracy. This is optional. In most cases, Amazon Lex is | ||
| 102 | capable of understanding user utterances. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> SlotConstraint => Str | ||
| 106 | |||
| 107 | Specifies whether the slot is required or optional. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 SlotType => Str | ||
| 111 | |||
| 112 | The type of the slot, either a custom slot type that you defined or one | ||
| 113 | of the built-in slot types. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 SlotTypeVersion => Str | ||
| 117 | |||
| 118 | The version of the slot type. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 ValueElicitationPrompt => L<Paws::LexModels::Prompt> | ||
| 122 | |||
| 123 | The prompt that Amazon Lex uses to elicit the slot value from the user. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head1 SEE ALSO | ||
| 128 | |||
| 129 | This class forms part of L<Paws>, describing an object used in L<Paws::LexModels> | ||
| 130 | |||
| 131 | =head1 BUGS and CONTRIBUTIONS | ||
| 132 | |||
| 133 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 134 | |||
| 135 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 136 | |||
| 137 | =cut | ||
| 138 |