File Coverage

blib/lib/Paws/LexModels/Slot.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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