aws-sdk-comprehend 1.27.0 → 1.32.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-comprehend.rb +7 -4
- data/lib/aws-sdk-comprehend/client.rb +371 -45
- data/lib/aws-sdk-comprehend/client_api.rb +187 -0
- data/lib/aws-sdk-comprehend/errors.rb +38 -16
- data/lib/aws-sdk-comprehend/resource.rb +1 -0
- data/lib/aws-sdk-comprehend/types.rb +487 -43
- metadata +3 -3
@@ -107,10 +107,8 @@ module Aws::Comprehend
|
|
107
107
|
#
|
108
108
|
# @!attribute [rw] language_code
|
109
109
|
# The language of the input documents. You can specify any of the
|
110
|
-
# primary languages supported by Amazon Comprehend
|
111
|
-
#
|
112
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
113
|
-
# language.
|
110
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
111
|
+
# be in the same language.
|
114
112
|
# @return [String]
|
115
113
|
#
|
116
114
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectEntitiesRequest AWS API Documentation
|
@@ -179,10 +177,8 @@ module Aws::Comprehend
|
|
179
177
|
#
|
180
178
|
# @!attribute [rw] language_code
|
181
179
|
# The language of the input documents. You can specify any of the
|
182
|
-
# primary languages supported by Amazon Comprehend
|
183
|
-
#
|
184
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
185
|
-
# language.
|
180
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
181
|
+
# be in the same language.
|
186
182
|
# @return [String]
|
187
183
|
#
|
188
184
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrasesRequest AWS API Documentation
|
@@ -256,10 +252,8 @@ module Aws::Comprehend
|
|
256
252
|
#
|
257
253
|
# @!attribute [rw] language_code
|
258
254
|
# The language of the input documents. You can specify any of the
|
259
|
-
# primary languages supported by Amazon Comprehend
|
260
|
-
#
|
261
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
262
|
-
# language.
|
255
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
256
|
+
# be in the same language.
|
263
257
|
# @return [String]
|
264
258
|
#
|
265
259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSentimentRequest AWS API Documentation
|
@@ -328,7 +322,7 @@ module Aws::Comprehend
|
|
328
322
|
#
|
329
323
|
# @!attribute [rw] language_code
|
330
324
|
# The language of the input documents. You can specify any of the
|
331
|
-
#
|
325
|
+
# following languages supported by Amazon Comprehend: German ("de"),
|
332
326
|
# English ("en"), Spanish ("es"), French ("fr"), Italian
|
333
327
|
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
334
328
|
# language.
|
@@ -431,13 +425,50 @@ module Aws::Comprehend
|
|
431
425
|
# score is 1, and the worst score is 0.
|
432
426
|
# @return [Float]
|
433
427
|
#
|
428
|
+
# @!attribute [rw] micro_precision
|
429
|
+
# A measure of the usefulness of the recognizer results in the test
|
430
|
+
# data. High precision means that the recognizer returned
|
431
|
+
# substantially more relevant results than irrelevant ones. Unlike the
|
432
|
+
# Precision metric which comes from averaging the precision of all
|
433
|
+
# available labels, this is based on the overall score of all
|
434
|
+
# precision scores added together.
|
435
|
+
# @return [Float]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] micro_recall
|
438
|
+
# A measure of how complete the classifier results are for the test
|
439
|
+
# data. High recall means that the classifier returned most of the
|
440
|
+
# relevant results. Specifically, this indicates how many of the
|
441
|
+
# correct categories in the text that the model can predict. It is a
|
442
|
+
# percentage of correct categories in the text that can found. Instead
|
443
|
+
# of averaging the recall scores of all labels (as with Recall), micro
|
444
|
+
# Recall is based on the overall score of all recall scores added
|
445
|
+
# together.
|
446
|
+
# @return [Float]
|
447
|
+
#
|
448
|
+
# @!attribute [rw] micro_f1_score
|
449
|
+
# A measure of how accurate the classifier results are for the test
|
450
|
+
# data. It is a combination of the `Micro Precision` and `Micro
|
451
|
+
# Recall` values. The `Micro F1Score` is the harmonic mean of the two
|
452
|
+
# scores. The highest score is 1, and the worst score is 0.
|
453
|
+
# @return [Float]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] hamming_loss
|
456
|
+
# Indicates the fraction of labels that are incorrectly predicted.
|
457
|
+
# Also seen as the fraction of wrong labels compared to the total
|
458
|
+
# number of labels. Scores closer to zero are better.
|
459
|
+
# @return [Float]
|
460
|
+
#
|
434
461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifierEvaluationMetrics AWS API Documentation
|
435
462
|
#
|
436
463
|
class ClassifierEvaluationMetrics < Struct.new(
|
437
464
|
:accuracy,
|
438
465
|
:precision,
|
439
466
|
:recall,
|
440
|
-
:f1_score
|
467
|
+
:f1_score,
|
468
|
+
:micro_precision,
|
469
|
+
:micro_recall,
|
470
|
+
:micro_f1_score,
|
471
|
+
:hamming_loss)
|
441
472
|
include Aws::Structure
|
442
473
|
end
|
443
474
|
|
@@ -474,6 +505,55 @@ module Aws::Comprehend
|
|
474
505
|
include Aws::Structure
|
475
506
|
end
|
476
507
|
|
508
|
+
# @note When making an API call, you may pass ClassifyDocumentRequest
|
509
|
+
# data as a hash:
|
510
|
+
#
|
511
|
+
# {
|
512
|
+
# text: "String", # required
|
513
|
+
# endpoint_arn: "DocumentClassifierEndpointArn", # required
|
514
|
+
# }
|
515
|
+
#
|
516
|
+
# @!attribute [rw] text
|
517
|
+
# The document text to be analyzed.
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
# @!attribute [rw] endpoint_arn
|
521
|
+
# The Amazon Resource Number (ARN) of the endpoint.
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentRequest AWS API Documentation
|
525
|
+
#
|
526
|
+
class ClassifyDocumentRequest < Struct.new(
|
527
|
+
:text,
|
528
|
+
:endpoint_arn)
|
529
|
+
include Aws::Structure
|
530
|
+
end
|
531
|
+
|
532
|
+
# @!attribute [rw] classes
|
533
|
+
# The classes used by the document being analyzed. These are used for
|
534
|
+
# multi-class trained models. Individual classes are mutually
|
535
|
+
# exclusive and each document is expected to have only a single class
|
536
|
+
# assigned to it. For example, an animal can be a dog or a cat, but
|
537
|
+
# not both at the same time.
|
538
|
+
# @return [Array<Types::DocumentClass>]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] labels
|
541
|
+
# The labels used the document being analyzed. These are used for
|
542
|
+
# multi-label trained models. Individual labels represent different
|
543
|
+
# categories that are related in some manner and are not multually
|
544
|
+
# exclusive. For example, a movie can be just an action movie, or it
|
545
|
+
# can be an action movie, a science fiction movie, and a comedy, all
|
546
|
+
# at the same time.
|
547
|
+
# @return [Array<Types::DocumentLabel>]
|
548
|
+
#
|
549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentResponse AWS API Documentation
|
550
|
+
#
|
551
|
+
class ClassifyDocumentResponse < Struct.new(
|
552
|
+
:classes,
|
553
|
+
:labels)
|
554
|
+
include Aws::Structure
|
555
|
+
end
|
556
|
+
|
477
557
|
# Concurrent modification of the tags associated with an Amazon
|
478
558
|
# Comprehend resource is not supported.
|
479
559
|
#
|
@@ -501,6 +581,7 @@ module Aws::Comprehend
|
|
501
581
|
# ],
|
502
582
|
# input_data_config: { # required
|
503
583
|
# s3_uri: "S3Uri", # required
|
584
|
+
# label_delimiter: "LabelDelimiter",
|
504
585
|
# },
|
505
586
|
# output_data_config: {
|
506
587
|
# s3_uri: "S3Uri",
|
@@ -513,6 +594,7 @@ module Aws::Comprehend
|
|
513
594
|
# security_group_ids: ["SecurityGroupId"], # required
|
514
595
|
# subnets: ["SubnetId"], # required
|
515
596
|
# },
|
597
|
+
# mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
|
516
598
|
# }
|
517
599
|
#
|
518
600
|
# @!attribute [rw] document_classifier_name
|
@@ -552,7 +634,7 @@ module Aws::Comprehend
|
|
552
634
|
#
|
553
635
|
# @!attribute [rw] language_code
|
554
636
|
# The language of the input documents. You can specify any of the
|
555
|
-
#
|
637
|
+
# following languages supported by Amazon Comprehend: German ("de"),
|
556
638
|
# English ("en"), Spanish ("es"), French ("fr"), Italian
|
557
639
|
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
558
640
|
# language.
|
@@ -580,6 +662,15 @@ module Aws::Comprehend
|
|
580
662
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
581
663
|
# @return [Types::VpcConfig]
|
582
664
|
#
|
665
|
+
# @!attribute [rw] mode
|
666
|
+
# Indicates the mode in which the classifier will be trained. The
|
667
|
+
# classifier can be trained in multi-class mode, which identifies one
|
668
|
+
# and only one class for each document, or multi-label mode, which
|
669
|
+
# identifies one or more labels for each document. In multi-label
|
670
|
+
# mode, multiple labels for an individual document are separated by a
|
671
|
+
# delimiter. The default delimiter between labels is a pipe (\|).
|
672
|
+
# @return [String]
|
673
|
+
#
|
583
674
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
|
584
675
|
#
|
585
676
|
class CreateDocumentClassifierRequest < Struct.new(
|
@@ -591,7 +682,8 @@ module Aws::Comprehend
|
|
591
682
|
:client_request_token,
|
592
683
|
:language_code,
|
593
684
|
:volume_kms_key_id,
|
594
|
-
:vpc_config
|
685
|
+
:vpc_config,
|
686
|
+
:mode)
|
595
687
|
include Aws::Structure
|
596
688
|
end
|
597
689
|
|
@@ -607,6 +699,76 @@ module Aws::Comprehend
|
|
607
699
|
include Aws::Structure
|
608
700
|
end
|
609
701
|
|
702
|
+
# @note When making an API call, you may pass CreateEndpointRequest
|
703
|
+
# data as a hash:
|
704
|
+
#
|
705
|
+
# {
|
706
|
+
# endpoint_name: "ComprehendEndpointName", # required
|
707
|
+
# model_arn: "ComprehendModelArn", # required
|
708
|
+
# desired_inference_units: 1, # required
|
709
|
+
# client_request_token: "ClientRequestTokenString",
|
710
|
+
# tags: [
|
711
|
+
# {
|
712
|
+
# key: "TagKey", # required
|
713
|
+
# value: "TagValue",
|
714
|
+
# },
|
715
|
+
# ],
|
716
|
+
# }
|
717
|
+
#
|
718
|
+
# @!attribute [rw] endpoint_name
|
719
|
+
# This is the descriptive suffix that becomes part of the
|
720
|
+
# `EndpointArn` used for all subsequent requests to this resource.
|
721
|
+
# @return [String]
|
722
|
+
#
|
723
|
+
# @!attribute [rw] model_arn
|
724
|
+
# The Amazon Resource Number (ARN) of the model to which the endpoint
|
725
|
+
# will be attached.
|
726
|
+
# @return [String]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] desired_inference_units
|
729
|
+
# The desired number of inference units to be used by the model using
|
730
|
+
# this endpoint. Each inference unit represents of a throughput of 100
|
731
|
+
# characters per second.
|
732
|
+
# @return [Integer]
|
733
|
+
#
|
734
|
+
# @!attribute [rw] client_request_token
|
735
|
+
# An idempotency token provided by the customer. If this token matches
|
736
|
+
# a previous endpoint creation request, Amazon Comprehend will not
|
737
|
+
# return a `ResourceInUseException`.
|
738
|
+
#
|
739
|
+
# **A suitable default value is auto-generated.** You should normally
|
740
|
+
# not need to pass this option.
|
741
|
+
# @return [String]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] tags
|
744
|
+
# Tags associated with the endpoint being created. A tag is a
|
745
|
+
# key-value pair that adds metadata to the endpoint. For example, a
|
746
|
+
# tag with "Sales" as the key might be added to an endpoint to
|
747
|
+
# indicate its use by the sales department.
|
748
|
+
# @return [Array<Types::Tag>]
|
749
|
+
#
|
750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointRequest AWS API Documentation
|
751
|
+
#
|
752
|
+
class CreateEndpointRequest < Struct.new(
|
753
|
+
:endpoint_name,
|
754
|
+
:model_arn,
|
755
|
+
:desired_inference_units,
|
756
|
+
:client_request_token,
|
757
|
+
:tags)
|
758
|
+
include Aws::Structure
|
759
|
+
end
|
760
|
+
|
761
|
+
# @!attribute [rw] endpoint_arn
|
762
|
+
# The Amazon Resource Number (ARN) of the endpoint being created.
|
763
|
+
# @return [String]
|
764
|
+
#
|
765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpointResponse AWS API Documentation
|
766
|
+
#
|
767
|
+
class CreateEndpointResponse < Struct.new(
|
768
|
+
:endpoint_arn)
|
769
|
+
include Aws::Structure
|
770
|
+
end
|
771
|
+
|
610
772
|
# @note When making an API call, you may pass CreateEntityRecognizerRequest
|
611
773
|
# data as a hash:
|
612
774
|
#
|
@@ -755,6 +917,28 @@ module Aws::Comprehend
|
|
755
917
|
#
|
756
918
|
class DeleteDocumentClassifierResponse < Aws::EmptyStructure; end
|
757
919
|
|
920
|
+
# @note When making an API call, you may pass DeleteEndpointRequest
|
921
|
+
# data as a hash:
|
922
|
+
#
|
923
|
+
# {
|
924
|
+
# endpoint_arn: "ComprehendEndpointArn", # required
|
925
|
+
# }
|
926
|
+
#
|
927
|
+
# @!attribute [rw] endpoint_arn
|
928
|
+
# The Amazon Resource Number (ARN) of the endpoint being deleted.
|
929
|
+
# @return [String]
|
930
|
+
#
|
931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEndpointRequest AWS API Documentation
|
932
|
+
#
|
933
|
+
class DeleteEndpointRequest < Struct.new(
|
934
|
+
:endpoint_arn)
|
935
|
+
include Aws::Structure
|
936
|
+
end
|
937
|
+
|
938
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteEndpointResponse AWS API Documentation
|
939
|
+
#
|
940
|
+
class DeleteEndpointResponse < Aws::EmptyStructure; end
|
941
|
+
|
758
942
|
# @note When making an API call, you may pass DeleteEntityRecognizerRequest
|
759
943
|
# data as a hash:
|
760
944
|
#
|
@@ -871,6 +1055,35 @@ module Aws::Comprehend
|
|
871
1055
|
include Aws::Structure
|
872
1056
|
end
|
873
1057
|
|
1058
|
+
# @note When making an API call, you may pass DescribeEndpointRequest
|
1059
|
+
# data as a hash:
|
1060
|
+
#
|
1061
|
+
# {
|
1062
|
+
# endpoint_arn: "ComprehendEndpointArn", # required
|
1063
|
+
# }
|
1064
|
+
#
|
1065
|
+
# @!attribute [rw] endpoint_arn
|
1066
|
+
# The Amazon Resource Number (ARN) of the endpoint being described.
|
1067
|
+
# @return [String]
|
1068
|
+
#
|
1069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpointRequest AWS API Documentation
|
1070
|
+
#
|
1071
|
+
class DescribeEndpointRequest < Struct.new(
|
1072
|
+
:endpoint_arn)
|
1073
|
+
include Aws::Structure
|
1074
|
+
end
|
1075
|
+
|
1076
|
+
# @!attribute [rw] endpoint_properties
|
1077
|
+
# Describes information associated with the specific endpoint.
|
1078
|
+
# @return [Types::EndpointProperties]
|
1079
|
+
#
|
1080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpointResponse AWS API Documentation
|
1081
|
+
#
|
1082
|
+
class DescribeEndpointResponse < Struct.new(
|
1083
|
+
:endpoint_properties)
|
1084
|
+
include Aws::Structure
|
1085
|
+
end
|
1086
|
+
|
874
1087
|
# @note When making an API call, you may pass DescribeEntitiesDetectionJobRequest
|
875
1088
|
# data as a hash:
|
876
1089
|
#
|
@@ -1077,10 +1290,8 @@ module Aws::Comprehend
|
|
1077
1290
|
#
|
1078
1291
|
# @!attribute [rw] language_code
|
1079
1292
|
# The language of the input documents. You can specify any of the
|
1080
|
-
# primary languages supported by Amazon Comprehend
|
1081
|
-
#
|
1082
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
1083
|
-
# language.
|
1293
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
1294
|
+
# be in the same language.
|
1084
1295
|
# @return [String]
|
1085
1296
|
#
|
1086
1297
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest AWS API Documentation
|
@@ -1121,10 +1332,8 @@ module Aws::Comprehend
|
|
1121
1332
|
#
|
1122
1333
|
# @!attribute [rw] language_code
|
1123
1334
|
# The language of the input documents. You can specify any of the
|
1124
|
-
# primary languages supported by Amazon Comprehend
|
1125
|
-
#
|
1126
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
1127
|
-
# language.
|
1335
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
1336
|
+
# be in the same language.
|
1128
1337
|
# @return [String]
|
1129
1338
|
#
|
1130
1339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectKeyPhrasesRequest AWS API Documentation
|
@@ -1165,10 +1374,8 @@ module Aws::Comprehend
|
|
1165
1374
|
#
|
1166
1375
|
# @!attribute [rw] language_code
|
1167
1376
|
# The language of the input documents. You can specify any of the
|
1168
|
-
# primary languages supported by Amazon Comprehend
|
1169
|
-
#
|
1170
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
1171
|
-
# language.
|
1377
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
1378
|
+
# be in the same language.
|
1172
1379
|
# @return [String]
|
1173
1380
|
#
|
1174
1381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSentimentRequest AWS API Documentation
|
@@ -1212,7 +1419,7 @@ module Aws::Comprehend
|
|
1212
1419
|
#
|
1213
1420
|
# @!attribute [rw] language_code
|
1214
1421
|
# The language code of the input documents. You can specify any of the
|
1215
|
-
#
|
1422
|
+
# following languages supported by Amazon Comprehend: German ("de"),
|
1216
1423
|
# English ("en"), Spanish ("es"), French ("fr"), Italian
|
1217
1424
|
# ("it"), or Portuguese ("pt").
|
1218
1425
|
# @return [String]
|
@@ -1240,6 +1447,25 @@ module Aws::Comprehend
|
|
1240
1447
|
include Aws::Structure
|
1241
1448
|
end
|
1242
1449
|
|
1450
|
+
# Specifies the class that categorizes the document being analyzed
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] name
|
1453
|
+
# The name of the class.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] score
|
1457
|
+
# The confidence score that Amazon Comprehend has this class correctly
|
1458
|
+
# attributed.
|
1459
|
+
# @return [Float]
|
1460
|
+
#
|
1461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClass AWS API Documentation
|
1462
|
+
#
|
1463
|
+
class DocumentClass < Struct.new(
|
1464
|
+
:name,
|
1465
|
+
:score)
|
1466
|
+
include Aws::Structure
|
1467
|
+
end
|
1468
|
+
|
1243
1469
|
# Provides information for filtering a list of document classification
|
1244
1470
|
# jobs. For more information, see the operation. You can provide only
|
1245
1471
|
# one filter parameter in each request.
|
@@ -1426,6 +1652,7 @@ module Aws::Comprehend
|
|
1426
1652
|
#
|
1427
1653
|
# {
|
1428
1654
|
# s3_uri: "S3Uri", # required
|
1655
|
+
# label_delimiter: "LabelDelimiter",
|
1429
1656
|
# }
|
1430
1657
|
#
|
1431
1658
|
# @!attribute [rw] s3_uri
|
@@ -1440,10 +1667,21 @@ module Aws::Comprehend
|
|
1440
1667
|
# all of them as input.
|
1441
1668
|
# @return [String]
|
1442
1669
|
#
|
1670
|
+
# @!attribute [rw] label_delimiter
|
1671
|
+
# Indicates the delimiter used to separate each label for training a
|
1672
|
+
# multi-label classifier. The default delimiter between labels is a
|
1673
|
+
# pipe (\|). You can use a different character as a delimiter (if
|
1674
|
+
# it's an allowed character) by specifying it under Delimiter for
|
1675
|
+
# labels. If the training documents use a delimiter other than the
|
1676
|
+
# default or the delimiter you specify, the labels on that line will
|
1677
|
+
# be combined to make a single unique label, such as LABELLABELLABEL.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1443
1680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
|
1444
1681
|
#
|
1445
1682
|
class DocumentClassifierInputDataConfig < Struct.new(
|
1446
|
-
:s3_uri
|
1683
|
+
:s3_uri,
|
1684
|
+
:label_delimiter)
|
1447
1685
|
include Aws::Structure
|
1448
1686
|
end
|
1449
1687
|
|
@@ -1583,6 +1821,13 @@ module Aws::Comprehend
|
|
1583
1821
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
1584
1822
|
# @return [Types::VpcConfig]
|
1585
1823
|
#
|
1824
|
+
# @!attribute [rw] mode
|
1825
|
+
# Indicates the mode in which the specific classifier was trained.
|
1826
|
+
# This also indicates the format of input documents and the format of
|
1827
|
+
# the confusion matrix. Each classifier can only be trained in one
|
1828
|
+
# mode and this cannot be changed once the classifier is trained.
|
1829
|
+
# @return [String]
|
1830
|
+
#
|
1586
1831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
|
1587
1832
|
#
|
1588
1833
|
class DocumentClassifierProperties < Struct.new(
|
@@ -1599,7 +1844,28 @@ module Aws::Comprehend
|
|
1599
1844
|
:classifier_metadata,
|
1600
1845
|
:data_access_role_arn,
|
1601
1846
|
:volume_kms_key_id,
|
1602
|
-
:vpc_config
|
1847
|
+
:vpc_config,
|
1848
|
+
:mode)
|
1849
|
+
include Aws::Structure
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
# Specifies one of the label or labels that categorize the document
|
1853
|
+
# being analyzed.
|
1854
|
+
#
|
1855
|
+
# @!attribute [rw] name
|
1856
|
+
# The name of the label.
|
1857
|
+
# @return [String]
|
1858
|
+
#
|
1859
|
+
# @!attribute [rw] score
|
1860
|
+
# The confidence score that Amazon Comprehend has this label correctly
|
1861
|
+
# attributed.
|
1862
|
+
# @return [Float]
|
1863
|
+
#
|
1864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentLabel AWS API Documentation
|
1865
|
+
#
|
1866
|
+
class DocumentLabel < Struct.new(
|
1867
|
+
:name,
|
1868
|
+
:score)
|
1603
1869
|
include Aws::Structure
|
1604
1870
|
end
|
1605
1871
|
|
@@ -1759,6 +2025,104 @@ module Aws::Comprehend
|
|
1759
2025
|
include Aws::Structure
|
1760
2026
|
end
|
1761
2027
|
|
2028
|
+
# The filter used to determine which endpoints are are returned. You can
|
2029
|
+
# filter jobs on their name, model, status, or the date and time that
|
2030
|
+
# they were created. You can only set one filter at a time.
|
2031
|
+
#
|
2032
|
+
# @note When making an API call, you may pass EndpointFilter
|
2033
|
+
# data as a hash:
|
2034
|
+
#
|
2035
|
+
# {
|
2036
|
+
# model_arn: "ComprehendModelArn",
|
2037
|
+
# status: "CREATING", # accepts CREATING, DELETING, FAILED, IN_SERVICE, UPDATING
|
2038
|
+
# creation_time_before: Time.now,
|
2039
|
+
# creation_time_after: Time.now,
|
2040
|
+
# }
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] model_arn
|
2043
|
+
# The Amazon Resource Number (ARN) of the model to which the endpoint
|
2044
|
+
# is attached.
|
2045
|
+
# @return [String]
|
2046
|
+
#
|
2047
|
+
# @!attribute [rw] status
|
2048
|
+
# Specifies the status of the endpoint being returned. Possible values
|
2049
|
+
# are: Creating, Ready, Updating, Deleting, Failed.
|
2050
|
+
# @return [String]
|
2051
|
+
#
|
2052
|
+
# @!attribute [rw] creation_time_before
|
2053
|
+
# Specifies a date before which the returned endpoint or endpoints
|
2054
|
+
# were created.
|
2055
|
+
# @return [Time]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] creation_time_after
|
2058
|
+
# Specifies a date after which the returned endpoint or endpoints were
|
2059
|
+
# created.
|
2060
|
+
# @return [Time]
|
2061
|
+
#
|
2062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointFilter AWS API Documentation
|
2063
|
+
#
|
2064
|
+
class EndpointFilter < Struct.new(
|
2065
|
+
:model_arn,
|
2066
|
+
:status,
|
2067
|
+
:creation_time_before,
|
2068
|
+
:creation_time_after)
|
2069
|
+
include Aws::Structure
|
2070
|
+
end
|
2071
|
+
|
2072
|
+
# Specifies information about the specified endpoint.
|
2073
|
+
#
|
2074
|
+
# @!attribute [rw] endpoint_arn
|
2075
|
+
# The Amazon Resource Number (ARN) of the endpoint.
|
2076
|
+
# @return [String]
|
2077
|
+
#
|
2078
|
+
# @!attribute [rw] status
|
2079
|
+
# Specifies the status of the endpoint. Because the endpoint updates
|
2080
|
+
# and creation are asynchronous, so customers will need to wait for
|
2081
|
+
# the endpoint to be `Ready` status before making inference requests.
|
2082
|
+
# @return [String]
|
2083
|
+
#
|
2084
|
+
# @!attribute [rw] message
|
2085
|
+
# Specifies a reason for failure in cases of `Failed` status.
|
2086
|
+
# @return [String]
|
2087
|
+
#
|
2088
|
+
# @!attribute [rw] model_arn
|
2089
|
+
# The Amazon Resource Number (ARN) of the model to which the endpoint
|
2090
|
+
# is attached.
|
2091
|
+
# @return [String]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] desired_inference_units
|
2094
|
+
# The desired number of inference units to be used by the model using
|
2095
|
+
# this endpoint. Each inference unit represents of a throughput of 100
|
2096
|
+
# characters per second.
|
2097
|
+
# @return [Integer]
|
2098
|
+
#
|
2099
|
+
# @!attribute [rw] current_inference_units
|
2100
|
+
# The number of inference units currently used by the model using this
|
2101
|
+
# endpoint.
|
2102
|
+
# @return [Integer]
|
2103
|
+
#
|
2104
|
+
# @!attribute [rw] creation_time
|
2105
|
+
# The creation date and time of the endpoint.
|
2106
|
+
# @return [Time]
|
2107
|
+
#
|
2108
|
+
# @!attribute [rw] last_modified_time
|
2109
|
+
# The date and time that the endpoint was last modified.
|
2110
|
+
# @return [Time]
|
2111
|
+
#
|
2112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
|
2113
|
+
#
|
2114
|
+
class EndpointProperties < Struct.new(
|
2115
|
+
:endpoint_arn,
|
2116
|
+
:status,
|
2117
|
+
:message,
|
2118
|
+
:model_arn,
|
2119
|
+
:desired_inference_units,
|
2120
|
+
:current_inference_units,
|
2121
|
+
:creation_time,
|
2122
|
+
:last_modified_time)
|
2123
|
+
include Aws::Structure
|
2124
|
+
end
|
2125
|
+
|
1762
2126
|
# Provides information for filtering a list of dominant language
|
1763
2127
|
# detection jobs. For more information, see the operation.
|
1764
2128
|
#
|
@@ -2766,6 +3130,61 @@ module Aws::Comprehend
|
|
2766
3130
|
include Aws::Structure
|
2767
3131
|
end
|
2768
3132
|
|
3133
|
+
# @note When making an API call, you may pass ListEndpointsRequest
|
3134
|
+
# data as a hash:
|
3135
|
+
#
|
3136
|
+
# {
|
3137
|
+
# filter: {
|
3138
|
+
# model_arn: "ComprehendModelArn",
|
3139
|
+
# status: "CREATING", # accepts CREATING, DELETING, FAILED, IN_SERVICE, UPDATING
|
3140
|
+
# creation_time_before: Time.now,
|
3141
|
+
# creation_time_after: Time.now,
|
3142
|
+
# },
|
3143
|
+
# next_token: "String",
|
3144
|
+
# max_results: 1,
|
3145
|
+
# }
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] filter
|
3148
|
+
# Filters the endpoints that are returned. You can filter endpoints on
|
3149
|
+
# their name, model, status, or the date and time that they were
|
3150
|
+
# created. You can only set one filter at a time.
|
3151
|
+
# @return [Types::EndpointFilter]
|
3152
|
+
#
|
3153
|
+
# @!attribute [rw] next_token
|
3154
|
+
# Identifies the next page of results to return.
|
3155
|
+
# @return [String]
|
3156
|
+
#
|
3157
|
+
# @!attribute [rw] max_results
|
3158
|
+
# The maximum number of results to return in each page. The default is
|
3159
|
+
# 100.
|
3160
|
+
# @return [Integer]
|
3161
|
+
#
|
3162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpointsRequest AWS API Documentation
|
3163
|
+
#
|
3164
|
+
class ListEndpointsRequest < Struct.new(
|
3165
|
+
:filter,
|
3166
|
+
:next_token,
|
3167
|
+
:max_results)
|
3168
|
+
include Aws::Structure
|
3169
|
+
end
|
3170
|
+
|
3171
|
+
# @!attribute [rw] endpoint_properties_list
|
3172
|
+
# Displays a list of endpoint properties being retrieved by the
|
3173
|
+
# service in response to the request.
|
3174
|
+
# @return [Array<Types::EndpointProperties>]
|
3175
|
+
#
|
3176
|
+
# @!attribute [rw] next_token
|
3177
|
+
# Identifies the next page of results to return.
|
3178
|
+
# @return [String]
|
3179
|
+
#
|
3180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpointsResponse AWS API Documentation
|
3181
|
+
#
|
3182
|
+
class ListEndpointsResponse < Struct.new(
|
3183
|
+
:endpoint_properties_list,
|
3184
|
+
:next_token)
|
3185
|
+
include Aws::Structure
|
3186
|
+
end
|
3187
|
+
|
2769
3188
|
# @note When making an API call, you may pass ListEntitiesDetectionJobsRequest
|
2770
3189
|
# data as a hash:
|
2771
3190
|
#
|
@@ -3657,10 +4076,9 @@ module Aws::Comprehend
|
|
3657
4076
|
# @!attribute [rw] language_code
|
3658
4077
|
# The language of the input documents. All documents must be in the
|
3659
4078
|
# same language. You can specify any of the languages supported by
|
3660
|
-
# Amazon Comprehend
|
3661
|
-
#
|
3662
|
-
#
|
3663
|
-
# and the language used for training the model is used instead.
|
4079
|
+
# Amazon Comprehend. If custom entities recognition is used, this
|
4080
|
+
# parameter is ignored and the language used for training the model is
|
4081
|
+
# used instead.
|
3664
4082
|
# @return [String]
|
3665
4083
|
#
|
3666
4084
|
# @!attribute [rw] client_request_token
|
@@ -3789,10 +4207,8 @@ module Aws::Comprehend
|
|
3789
4207
|
#
|
3790
4208
|
# @!attribute [rw] language_code
|
3791
4209
|
# The language of the input documents. You can specify any of the
|
3792
|
-
# primary languages supported by Amazon Comprehend
|
3793
|
-
#
|
3794
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
3795
|
-
# language.
|
4210
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
4211
|
+
# be in the same language.
|
3796
4212
|
# @return [String]
|
3797
4213
|
#
|
3798
4214
|
# @!attribute [rw] client_request_token
|
@@ -3915,10 +4331,8 @@ module Aws::Comprehend
|
|
3915
4331
|
#
|
3916
4332
|
# @!attribute [rw] language_code
|
3917
4333
|
# The language of the input documents. You can specify any of the
|
3918
|
-
# primary languages supported by Amazon Comprehend
|
3919
|
-
#
|
3920
|
-
# ("it"), or Portuguese ("pt"). All documents must be in the same
|
3921
|
-
# language.
|
4334
|
+
# primary languages supported by Amazon Comprehend. All documents must
|
4335
|
+
# be in the same language.
|
3922
4336
|
# @return [String]
|
3923
4337
|
#
|
3924
4338
|
# @!attribute [rw] client_request_token
|
@@ -4654,6 +5068,36 @@ module Aws::Comprehend
|
|
4654
5068
|
#
|
4655
5069
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
4656
5070
|
|
5071
|
+
# @note When making an API call, you may pass UpdateEndpointRequest
|
5072
|
+
# data as a hash:
|
5073
|
+
#
|
5074
|
+
# {
|
5075
|
+
# endpoint_arn: "ComprehendEndpointArn", # required
|
5076
|
+
# desired_inference_units: 1, # required
|
5077
|
+
# }
|
5078
|
+
#
|
5079
|
+
# @!attribute [rw] endpoint_arn
|
5080
|
+
# The Amazon Resource Number (ARN) of the endpoint being updated.
|
5081
|
+
# @return [String]
|
5082
|
+
#
|
5083
|
+
# @!attribute [rw] desired_inference_units
|
5084
|
+
# The desired number of inference units to be used by the model using
|
5085
|
+
# this endpoint. Each inference unit represents of a throughput of 100
|
5086
|
+
# characters per second.
|
5087
|
+
# @return [Integer]
|
5088
|
+
#
|
5089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointRequest AWS API Documentation
|
5090
|
+
#
|
5091
|
+
class UpdateEndpointRequest < Struct.new(
|
5092
|
+
:endpoint_arn,
|
5093
|
+
:desired_inference_units)
|
5094
|
+
include Aws::Structure
|
5095
|
+
end
|
5096
|
+
|
5097
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointResponse AWS API Documentation
|
5098
|
+
#
|
5099
|
+
class UpdateEndpointResponse < Aws::EmptyStructure; end
|
5100
|
+
|
4657
5101
|
# Configuration parameters for an optional private Virtual Private Cloud
|
4658
5102
|
# (VPC) containing the resources you are using for the job. For For more
|
4659
5103
|
# information, see [Amazon VPC][1].
|