forked from awslabs/aws-sdk-kotlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
comprehend.json
13749 lines (13749 loc) · 690 KB
/
comprehend.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"smithy": "2.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.comprehend#AnyLengthString": {
"type": "string"
},
"com.amazonaws.comprehend#AttributeNamesList": {
"type": "list",
"member": {
"target": "com.amazonaws.comprehend#AttributeNamesListItem"
}
},
"com.amazonaws.comprehend#AttributeNamesListItem": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 63
},
"smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9])*$"
}
},
"com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat": {
"type": "enum",
"members": {
"PLAIN_TEXT_DOCUMENT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PLAIN_TEXT_DOCUMENT"
}
},
"SEMI_STRUCTURED_DOCUMENT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SEMI_STRUCTURED_DOCUMENT"
}
}
}
},
"com.amazonaws.comprehend#AugmentedManifestsListItem": {
"type": "structure",
"members": {
"S3Uri": {
"target": "com.amazonaws.comprehend#S3Uri",
"traits": {
"smithy.api#documentation": "<p>The Amazon S3 location of the augmented manifest file.</p>",
"smithy.api#required": {}
}
},
"Split": {
"target": "com.amazonaws.comprehend#Split",
"traits": {
"smithy.api#documentation": "<p>The purpose of the data you've provided in the augmented manifest. You can either train or\n test this data. If you don't specify, the default is train.</p>\n <p>TRAIN - all of the documents in the manifest will be used for training. If no test\n documents are provided, Amazon Comprehend will automatically reserve a portion of the training\n documents for testing.</p>\n <p> TEST - all of the documents in the manifest will be used for testing.</p>"
}
},
"AttributeNames": {
"target": "com.amazonaws.comprehend#AttributeNamesList",
"traits": {
"smithy.api#documentation": "<p>The JSON attribute that contains the annotations for your training documents. The number\n of attribute names that you specify depends on whether your augmented manifest file is the\n output of a single labeling job or a chained labeling job.</p>\n <p>If your file is the output of a single labeling job, specify the LabelAttributeName key\n that was used when the job was created in Ground Truth.</p>\n <p>If your file is the output of a chained labeling job, specify the LabelAttributeName key\n for one or more jobs in the chain. Each LabelAttributeName key provides the annotations from\n an individual job.</p>",
"smithy.api#required": {}
}
},
"AnnotationDataS3Uri": {
"target": "com.amazonaws.comprehend#S3Uri",
"traits": {
"smithy.api#documentation": "<p>The S3 prefix to the annotation files that are referred in the augmented manifest\n file.</p>"
}
},
"SourceDocumentsS3Uri": {
"target": "com.amazonaws.comprehend#S3Uri",
"traits": {
"smithy.api#documentation": "<p>The S3 prefix to the source files (PDFs) that are referred to in the augmented manifest\n file.</p>"
}
},
"DocumentType": {
"target": "com.amazonaws.comprehend#AugmentedManifestsDocumentTypeFormat",
"traits": {
"smithy.api#documentation": "<p>The type of augmented manifest. PlainTextDocument or SemiStructuredDocument. If you don't\n specify, the default is PlainTextDocument. </p>\n <ul>\n <li>\n <p>\n <code>PLAIN_TEXT_DOCUMENT</code> A document type that represents any unicode text that\n is encoded in UTF-8.</p>\n </li>\n <li>\n <p>\n <code>SEMI_STRUCTURED_DOCUMENT</code> A document type with positional and structural\n context, like a PDF. For training with Amazon Comprehend, only PDFs are supported. For\n inference, Amazon Comprehend support PDFs, DOCX and TXT.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An augmented manifest file that provides training data for your custom model. An augmented\n manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectDominantLanguage": {
"type": "operation",
"input": {
"target": "com.amazonaws.comprehend#BatchDetectDominantLanguageRequest"
},
"output": {
"target": "com.amazonaws.comprehend#BatchDetectDominantLanguageResponse"
},
"errors": [
{
"target": "com.amazonaws.comprehend#BatchSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#InternalServerException"
},
{
"target": "com.amazonaws.comprehend#InvalidRequestException"
},
{
"target": "com.amazonaws.comprehend#TextSizeLimitExceededException"
}
],
"traits": {
"smithy.api#documentation": "<p>Determines the dominant language of the input text for a batch of documents. For a list\n of languages that Amazon Comprehend can detect, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html\">Amazon Comprehend Supported Languages</a>.\n </p>"
}
},
"com.amazonaws.comprehend#BatchDetectDominantLanguageItemResult": {
"type": "structure",
"members": {
"Index": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The zero-based index of the document in the input list.</p>"
}
},
"Languages": {
"target": "com.amazonaws.comprehend#ListOfDominantLanguages",
"traits": {
"smithy.api#documentation": "<p>One or more <a>DominantLanguage</a> objects describing the dominant\n languages in the document.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of calling the operation.\n The operation returns one object for each document that is successfully processed by the\n operation.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectDominantLanguageRequest": {
"type": "structure",
"members": {
"TextList": {
"target": "com.amazonaws.comprehend#CustomerInputStringList",
"traits": {
"smithy.api#documentation": "<p>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.comprehend#BatchDetectDominantLanguageResponse": {
"type": "structure",
"members": {
"ResultList": {
"target": "com.amazonaws.comprehend#ListOfDetectDominantLanguageResult",
"traits": {
"smithy.api#documentation": "<p>A list of objects\n containing the results of the operation. The results are sorted in ascending order by the\n <code>Index</code> field and match the order of the documents in the input list. If all of\n the documents contain an error, the <code>ResultList</code> is empty.</p>",
"smithy.api#required": {}
}
},
"ErrorList": {
"target": "com.amazonaws.comprehend#BatchItemErrorList",
"traits": {
"smithy.api#documentation": "<p>A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the <code>ErrorList</code> is empty.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.comprehend#BatchDetectEntities": {
"type": "operation",
"input": {
"target": "com.amazonaws.comprehend#BatchDetectEntitiesRequest"
},
"output": {
"target": "com.amazonaws.comprehend#BatchDetectEntitiesResponse"
},
"errors": [
{
"target": "com.amazonaws.comprehend#BatchSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#InternalServerException"
},
{
"target": "com.amazonaws.comprehend#InvalidRequestException"
},
{
"target": "com.amazonaws.comprehend#TextSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#UnsupportedLanguageException"
}
],
"traits": {
"smithy.api#documentation": "<p>Inspects the text of a batch of documents for named entities and returns information\n about them. For more information about named entities, see\n <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html\">Entities</a> in the Comprehend Developer Guide.\n </p>"
}
},
"com.amazonaws.comprehend#BatchDetectEntitiesItemResult": {
"type": "structure",
"members": {
"Index": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The zero-based index of the document in the input list.</p>"
}
},
"Entities": {
"target": "com.amazonaws.comprehend#ListOfEntities",
"traits": {
"smithy.api#documentation": "<p>One or more <a>Entity</a> objects, one for each entity detected in the\n document.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectEntitiesRequest": {
"type": "structure",
"members": {
"TextList": {
"target": "com.amazonaws.comprehend#CustomerInputStringList",
"traits": {
"smithy.api#documentation": "<p>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.</p>",
"smithy.api#required": {}
}
},
"LanguageCode": {
"target": "com.amazonaws.comprehend#LanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.comprehend#BatchDetectEntitiesResponse": {
"type": "structure",
"members": {
"ResultList": {
"target": "com.amazonaws.comprehend#ListOfDetectEntitiesResult",
"traits": {
"smithy.api#documentation": "<p>A list of objects containing the\n results of the operation. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the <code>ResultList</code> is empty.</p>",
"smithy.api#required": {}
}
},
"ErrorList": {
"target": "com.amazonaws.comprehend#BatchItemErrorList",
"traits": {
"smithy.api#documentation": "<p>A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the <code>ErrorList</code> is empty.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.comprehend#BatchDetectKeyPhrases": {
"type": "operation",
"input": {
"target": "com.amazonaws.comprehend#BatchDetectKeyPhrasesRequest"
},
"output": {
"target": "com.amazonaws.comprehend#BatchDetectKeyPhrasesResponse"
},
"errors": [
{
"target": "com.amazonaws.comprehend#BatchSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#InternalServerException"
},
{
"target": "com.amazonaws.comprehend#InvalidRequestException"
},
{
"target": "com.amazonaws.comprehend#TextSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#UnsupportedLanguageException"
}
],
"traits": {
"smithy.api#documentation": "<p>Detects the key noun phrases found in a batch of documents.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectKeyPhrasesItemResult": {
"type": "structure",
"members": {
"Index": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The zero-based index of the document in the input list.</p>"
}
},
"KeyPhrases": {
"target": "com.amazonaws.comprehend#ListOfKeyPhrases",
"traits": {
"smithy.api#documentation": "<p>One or more <a>KeyPhrase</a> objects, one for each key phrase detected in\n the document.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectKeyPhrasesRequest": {
"type": "structure",
"members": {
"TextList": {
"target": "com.amazonaws.comprehend#CustomerInputStringList",
"traits": {
"smithy.api#documentation": "<p>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB.</p>",
"smithy.api#required": {}
}
},
"LanguageCode": {
"target": "com.amazonaws.comprehend#LanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.comprehend#BatchDetectKeyPhrasesResponse": {
"type": "structure",
"members": {
"ResultList": {
"target": "com.amazonaws.comprehend#ListOfDetectKeyPhrasesResult",
"traits": {
"smithy.api#documentation": "<p>A list of objects containing the\n results of the operation. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the <code>ResultList</code> is empty.</p>",
"smithy.api#required": {}
}
},
"ErrorList": {
"target": "com.amazonaws.comprehend#BatchItemErrorList",
"traits": {
"smithy.api#documentation": "<p>A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the <code>ErrorList</code> is empty.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.comprehend#BatchDetectSentiment": {
"type": "operation",
"input": {
"target": "com.amazonaws.comprehend#BatchDetectSentimentRequest"
},
"output": {
"target": "com.amazonaws.comprehend#BatchDetectSentimentResponse"
},
"errors": [
{
"target": "com.amazonaws.comprehend#BatchSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#InternalServerException"
},
{
"target": "com.amazonaws.comprehend#InvalidRequestException"
},
{
"target": "com.amazonaws.comprehend#TextSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#UnsupportedLanguageException"
}
],
"traits": {
"smithy.api#documentation": "<p>Inspects a batch of documents and returns an inference of the prevailing sentiment,\n <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>,\n in each one.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectSentimentItemResult": {
"type": "structure",
"members": {
"Index": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The zero-based index of the document in the input list.</p>"
}
},
"Sentiment": {
"target": "com.amazonaws.comprehend#SentimentType",
"traits": {
"smithy.api#documentation": "<p>The sentiment detected in the document.</p>"
}
},
"SentimentScore": {
"target": "com.amazonaws.comprehend#SentimentScore",
"traits": {
"smithy.api#documentation": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its sentiment\n detection.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of calling the operation. The\n operation returns one object for each document that is successfully processed by the\n operation.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectSentimentRequest": {
"type": "structure",
"members": {
"TextList": {
"target": "com.amazonaws.comprehend#CustomerInputStringList",
"traits": {
"smithy.api#documentation": "<p>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size of each document is 5 KB. </p>",
"smithy.api#required": {}
}
},
"LanguageCode": {
"target": "com.amazonaws.comprehend#LanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language of the input documents. You can specify any of the primary languages\n supported by Amazon Comprehend. All documents must be in the same language.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.comprehend#BatchDetectSentimentResponse": {
"type": "structure",
"members": {
"ResultList": {
"target": "com.amazonaws.comprehend#ListOfDetectSentimentResult",
"traits": {
"smithy.api#documentation": "<p>A list of objects containing the\n results of the operation. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the <code>ResultList</code> is empty.</p>",
"smithy.api#required": {}
}
},
"ErrorList": {
"target": "com.amazonaws.comprehend#BatchItemErrorList",
"traits": {
"smithy.api#documentation": "<p>A list containing one object for each document\n that contained an error. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If there are no errors in the\n batch, the <code>ErrorList</code> is empty.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.comprehend#BatchDetectSyntax": {
"type": "operation",
"input": {
"target": "com.amazonaws.comprehend#BatchDetectSyntaxRequest"
},
"output": {
"target": "com.amazonaws.comprehend#BatchDetectSyntaxResponse"
},
"errors": [
{
"target": "com.amazonaws.comprehend#BatchSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#InternalServerException"
},
{
"target": "com.amazonaws.comprehend#InvalidRequestException"
},
{
"target": "com.amazonaws.comprehend#TextSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#UnsupportedLanguageException"
}
],
"traits": {
"smithy.api#documentation": "<p>Inspects the text of a batch of documents for the syntax and part of speech of the words\n in the document and returns information about them. For more information, see\n <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html\">Syntax</a> in the Comprehend Developer Guide.\n </p>"
}
},
"com.amazonaws.comprehend#BatchDetectSyntaxItemResult": {
"type": "structure",
"members": {
"Index": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The zero-based index of the document in the input list.</p>"
}
},
"SyntaxTokens": {
"target": "com.amazonaws.comprehend#ListOfSyntaxTokens",
"traits": {
"smithy.api#documentation": "<p>The syntax tokens for the words in the document, one token for each word.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The result of calling the operation. The\n operation returns one object that is successfully processed by the operation.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectSyntaxRequest": {
"type": "structure",
"members": {
"TextList": {
"target": "com.amazonaws.comprehend#CustomerInputStringList",
"traits": {
"smithy.api#documentation": "<p>A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25\n documents. The maximum size for each document is 5 KB.</p>",
"smithy.api#required": {}
}
},
"LanguageCode": {
"target": "com.amazonaws.comprehend#SyntaxLanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language of the input documents. You can specify any of the following languages\n supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"),\n Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.comprehend#BatchDetectSyntaxResponse": {
"type": "structure",
"members": {
"ResultList": {
"target": "com.amazonaws.comprehend#ListOfDetectSyntaxResult",
"traits": {
"smithy.api#documentation": "<p>A list of objects containing the\n results of the operation. The results are sorted in ascending order by the <code>Index</code>\n field and match the order of the documents in the input list. If all of the documents contain\n an error, the <code>ResultList</code> is empty.</p>",
"smithy.api#required": {}
}
},
"ErrorList": {
"target": "com.amazonaws.comprehend#BatchItemErrorList",
"traits": {
"smithy.api#documentation": "<p>A list containing one object for each document that\n contained an error. The results are sorted in ascending order by the <code>Index</code> field\n and match the order of the documents in the input list. If there are no errors in the batch,\n the <code>ErrorList</code> is empty.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.comprehend#BatchDetectTargetedSentiment": {
"type": "operation",
"input": {
"target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentRequest"
},
"output": {
"target": "com.amazonaws.comprehend#BatchDetectTargetedSentimentResponse"
},
"errors": [
{
"target": "com.amazonaws.comprehend#BatchSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#InternalServerException"
},
{
"target": "com.amazonaws.comprehend#InvalidRequestException"
},
{
"target": "com.amazonaws.comprehend#TextSizeLimitExceededException"
},
{
"target": "com.amazonaws.comprehend#UnsupportedLanguageException"
}
],
"traits": {
"smithy.api#documentation": "<p>Inspects a batch of documents and returns a sentiment analysis\n for each entity identified in the documents.</p>\n <p>For more information about targeted sentiment, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html\">Targeted sentiment</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectTargetedSentimentItemResult": {
"type": "structure",
"members": {
"Index": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The zero-based index of this result in the input list.</p>"
}
},
"Entities": {
"target": "com.amazonaws.comprehend#ListOfTargetedSentimentEntities",
"traits": {
"smithy.api#documentation": "<p>An array of targeted sentiment entities.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Analysis results for one of the documents in the batch.</p>"
}
},
"com.amazonaws.comprehend#BatchDetectTargetedSentimentRequest": {
"type": "structure",
"members": {
"TextList": {
"target": "com.amazonaws.comprehend#CustomerInputStringList",
"traits": {
"smithy.api#documentation": "<p>A list containing the UTF-8 encoded text of the input documents.\n The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.</p>",
"smithy.api#required": {}
}
},
"LanguageCode": {
"target": "com.amazonaws.comprehend#LanguageCode",
"traits": {
"smithy.api#documentation": "<p>The language of the input documents. Currently, English is the only supported language.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.comprehend#BatchDetectTargetedSentimentResponse": {
"type": "structure",
"members": {
"ResultList": {
"target": "com.amazonaws.comprehend#ListOfDetectTargetedSentimentResult",
"traits": {
"smithy.api#documentation": "<p>A list of objects containing the results of the operation.\n The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list.\n If all of the documents contain an error, the <code>ResultList</code> is empty.</p>",
"smithy.api#required": {}
}
},
"ErrorList": {
"target": "com.amazonaws.comprehend#BatchItemErrorList",
"traits": {
"smithy.api#documentation": "<p>List of errors that the operation can return.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {},
"smithy.api#sensitive": {}
}
},
"com.amazonaws.comprehend#BatchItemError": {
"type": "structure",
"members": {
"Index": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The zero-based index of the document in the input list.</p>"
}
},
"ErrorCode": {
"target": "com.amazonaws.comprehend#String",
"traits": {
"smithy.api#documentation": "<p>The numeric error code of the error.</p>"
}
},
"ErrorMessage": {
"target": "com.amazonaws.comprehend#String",
"traits": {
"smithy.api#documentation": "<p>A text description of the error.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes an error that occurred while processing a document in a batch. The operation\n returns on <code>BatchItemError</code> object for each document that contained an\n error.</p>"
}
},
"com.amazonaws.comprehend#BatchItemErrorList": {
"type": "list",
"member": {
"target": "com.amazonaws.comprehend#BatchItemError"
}
},
"com.amazonaws.comprehend#BatchSizeLimitExceededException": {
"type": "structure",
"members": {
"Message": {
"target": "com.amazonaws.comprehend#String"
}
},
"traits": {
"smithy.api#documentation": "<p>The number of documents in the request exceeds the limit of 25. Try your request again\n with fewer documents.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 400
}
},
"com.amazonaws.comprehend#Block": {
"type": "structure",
"members": {
"Id": {
"target": "com.amazonaws.comprehend#String",
"traits": {
"smithy.api#documentation": "<p>Unique identifier for the block.</p>"
}
},
"BlockType": {
"target": "com.amazonaws.comprehend#BlockType",
"traits": {
"smithy.api#documentation": "<p>The block represents a line of text or one word of text.</p>\n <ul>\n <li>\n <p>WORD - A word that's detected on a document page.\n A word is one or more ISO basic Latin script characters that aren't separated by spaces.</p>\n </li>\n <li>\n <p>LINE - A string of tab-delimited, contiguous words\n that are detected on a document page</p>\n </li>\n </ul>"
}
},
"Text": {
"target": "com.amazonaws.comprehend#String",
"traits": {
"smithy.api#documentation": "<p>The word or line of text extracted from the block.</p>"
}
},
"Page": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>Page number where the block appears.</p>"
}
},
"Geometry": {
"target": "com.amazonaws.comprehend#Geometry",
"traits": {
"smithy.api#documentation": "<p>Co-ordinates of the rectangle or polygon that contains the text.</p>"
}
},
"Relationships": {
"target": "com.amazonaws.comprehend#ListOfRelationships",
"traits": {
"smithy.api#documentation": "<p>A list of child blocks of the current block.\n For example, a LINE object has child blocks for each WORD block that's part of the line of text. </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about each word or line of text in the input document.</p>\n <p>For additional information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/API_Block.html\">Block</a> in the Amazon Textract API reference.</p>"
}
},
"com.amazonaws.comprehend#BlockReference": {
"type": "structure",
"members": {
"BlockId": {
"target": "com.amazonaws.comprehend#String",
"traits": {
"smithy.api#documentation": "<p>Unique identifier for the block.</p>"
}
},
"BeginOffset": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>Offset of the start of the block within its parent block.</p>"
}
},
"EndOffset": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>Offset of the end of the block within its parent block.</p>"
}
},
"ChildBlocks": {
"target": "com.amazonaws.comprehend#ListOfChildBlocks",
"traits": {
"smithy.api#documentation": "<p>List of child blocks within this block.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A reference to a block. </p>"
}
},
"com.amazonaws.comprehend#BlockType": {
"type": "enum",
"members": {
"LINE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "LINE"
}
},
"WORD": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "WORD"
}
}
}
},
"com.amazonaws.comprehend#BoundingBox": {
"type": "structure",
"members": {
"Height": {
"target": "com.amazonaws.comprehend#Float",
"traits": {
"smithy.api#documentation": "<p>The height of the bounding box as a ratio of the overall document page height.</p>"
}
},
"Left": {
"target": "com.amazonaws.comprehend#Float",
"traits": {
"smithy.api#documentation": "<p>The left coordinate of the bounding box as a ratio of overall document page width.</p>"
}
},
"Top": {
"target": "com.amazonaws.comprehend#Float",
"traits": {
"smithy.api#documentation": "<p>The top coordinate of the bounding box as a ratio of overall document page height.</p>"
}
},
"Width": {
"target": "com.amazonaws.comprehend#Float",
"traits": {
"smithy.api#documentation": "<p>The width of the bounding box as a ratio of the overall document page width.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The bounding box around the detected page\n or around an element on a document page.\n The left (x-coordinate) and top (y-coordinate) are coordinates that\n represent the top and left sides of the bounding box. Note that the upper-left\n corner of the image is the origin (0,0). </p>\n <p>For additional information, see <a href=\"https://docs.aws.amazon.com/textract/latest/dg/API_BoundingBox.html\">BoundingBox</a> in the Amazon Textract API reference.</p>"
}
},
"com.amazonaws.comprehend#ChildBlock": {
"type": "structure",
"members": {
"ChildBlockId": {
"target": "com.amazonaws.comprehend#String",
"traits": {
"smithy.api#documentation": "<p>Unique identifier for the child block.</p>"
}
},
"BeginOffset": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>Offset of the start of the child block within its parent block.</p>"
}
},
"EndOffset": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>Offset of the end of the child block within its parent block.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Nested block contained within a block.</p>"
}
},
"com.amazonaws.comprehend#ClassifierEvaluationMetrics": {
"type": "structure",
"members": {
"Accuracy": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>The fraction of the labels that were correct recognized. It is computed by dividing the\n number of labels in the test documents that were correctly recognized by the total number of\n labels in the test documents.</p>"
}
},
"Precision": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>A measure of the usefulness of the classifier results in the test data. High precision\n means that the classifier returned substantially more relevant results than irrelevant\n ones.</p>"
}
},
"Recall": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results. </p>"
}
},
"F1Score": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>A measure of how accurate the classifier results are for the test data. It is derived from\n the <code>Precision</code> and <code>Recall</code> values. The <code>F1Score</code> is the\n harmonic average of the two scores. The highest score is 1, and the worst score is 0. </p>"
}
},
"MicroPrecision": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>A measure of the usefulness of the recognizer results in the test data. High precision\n means that the recognizer returned substantially more relevant results than irrelevant ones.\n Unlike the Precision metric which comes from averaging the precision of all available labels,\n this is based on the overall score of all precision scores added together.</p>"
}
},
"MicroRecall": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>A measure of how complete the classifier results are for the test data. High recall means\n that the classifier returned most of the relevant results. Specifically, this indicates how\n many of the correct categories in the text that the model can predict. It is a percentage of\n correct categories in the text that can found. Instead of averaging the recall scores of all\n labels (as with Recall), micro Recall is based on the overall score of all recall scores added\n together.</p>"
}
},
"MicroF1Score": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>A measure of how accurate the classifier results are for the test data. It is a\n combination of the <code>Micro Precision</code> and <code>Micro Recall</code> values. The\n <code>Micro F1Score</code> is the harmonic mean of the two scores. The highest score is 1,\n and the worst score is 0.</p>"
}
},
"HammingLoss": {
"target": "com.amazonaws.comprehend#Double",
"traits": {
"smithy.api#documentation": "<p>Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction\n of wrong labels compared to the total number of labels. Scores closer to zero are\n better.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the result metrics for the test data associated with an documentation\n classifier.</p>"
}
},
"com.amazonaws.comprehend#ClassifierMetadata": {
"type": "structure",
"members": {
"NumberOfLabels": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of labels in the input data. </p>"
}
},
"NumberOfTrainedDocuments": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of documents in the input data that were used to train the classifier.\n Typically this is 80 to 90 percent of the input documents.</p>"
}
},
"NumberOfTestDocuments": {
"target": "com.amazonaws.comprehend#Integer",
"traits": {
"smithy.api#documentation": "<p>The number of documents in the input data that were used to test the classifier. Typically\n this is 10 to 20 percent of the input documents, up to 10,000 documents.</p>"
}
},
"EvaluationMetrics": {
"target": "com.amazonaws.comprehend#ClassifierEvaluationMetrics",
"traits": {
"smithy.api#documentation": "<p> Describes the result metrics for the test data associated with an documentation\n classifier.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Provides information about a document classifier.</p>",
"smithy.api#sensitive": {}
}
},
"com.amazonaws.comprehend#ClassifyDocument": {
"type": "operation",
"input": {
"target": "com.amazonaws.comprehend#ClassifyDocumentRequest"
},
"output": {
"target": "com.amazonaws.comprehend#ClassifyDocumentResponse"
},
"errors": [
{
"target": "com.amazonaws.comprehend#InternalServerException"
},
{
"target": "com.amazonaws.comprehend#InvalidRequestException"
},
{
"target": "com.amazonaws.comprehend#ResourceUnavailableException"
},
{
"target": "com.amazonaws.comprehend#TextSizeLimitExceededException"
}
],
"traits": {
"smithy.api#documentation": "<p>Creates a classification request to analyze a single document in real-time. <code>ClassifyDocument</code> \n supports the following model types:</p>\n <ul>\n <li>\n <p>Custom classifier - a custom model that you have created and trained. \n For input, you can provide plain text, a single-page document (PDF, Word, or image), or \n Amazon Textract API output. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html\">Custom classification</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>\n </li>\n <li>\n <p>Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying \n input prompts for generative AI applications. \n For input, you provide English plain text input.\n For prompt safety classification, the response includes only the <code>Classes</code> field.\n For more information about prompt safety classifiers, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification\">Prompt safety classification</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>\n </li>\n </ul>\n <p>If the system detects errors while processing a page in the input document,\n the API response includes an <code>Errors</code> field that describes the errors.</p>\n <p>If the system detects a document-level error in your input document, the API returns an\n <code>InvalidRequestException</code> error response.\n For details about this exception, see\n <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html\">\n Errors in semi-structured documents</a> in the Comprehend Developer Guide.\n </p>"
}
},
"com.amazonaws.comprehend#ClassifyDocumentRequest": {
"type": "structure",
"members": {
"Text": {
"target": "com.amazonaws.comprehend#CustomerInputString",
"traits": {
"smithy.api#documentation": "<p>The document text to be analyzed. If you enter text using this parameter,\n do not use the <code>Bytes</code> parameter.</p>"
}
},
"EndpointArn": {
"target": "com.amazonaws.comprehend#DocumentClassifierEndpointArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Number (ARN) of the endpoint. </p>\n <p>For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/trust-safety.html#prompt-classification\">Prompt safety classification</a> in the <i>Amazon Comprehend Developer Guide</i>\n </p>\n <p>For custom classification, you create an endpoint for your custom model. For more information, \n see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html\">Using Amazon Comprehend endpoints</a>.</p>",
"smithy.api#required": {}
}
},