aws-sdk-comprehend 1.28.0 → 1.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +27 -1
- data/lib/aws-sdk-comprehend/client_api.rb +18 -0
- data/lib/aws-sdk-comprehend/types.rb +104 -5
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4afe5433ec3a1d2473588dd9f167df7718049623
|
4
|
+
data.tar.gz: ee542fc30381c67dfc6ab6b8522afd99d9163fb7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1aab4ead901fdba21f144907e7fd7b645ad6c5b927ae2a8bc3c5a82c39146529a22c91485d5d35534ec7fa059c5c7775c8ca579a7dd1aa29943aa1f5d801bfaf
|
7
|
+
data.tar.gz: 99ad0f388ce5a540962d14387ffac775d011b493c81bcf4cd6e45ed6702b30383492120bb3d2462196aa2ab10fd8acb42e52013a8d0383a6968c515281c0571f
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -521,6 +521,7 @@ module Aws::Comprehend
|
|
521
521
|
# @return [Types::ClassifyDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
522
522
|
#
|
523
523
|
# * {Types::ClassifyDocumentResponse#classes #classes} => Array<Types::DocumentClass>
|
524
|
+
# * {Types::ClassifyDocumentResponse#labels #labels} => Array<Types::DocumentLabel>
|
524
525
|
#
|
525
526
|
# @example Request syntax with placeholder values
|
526
527
|
#
|
@@ -534,6 +535,9 @@ module Aws::Comprehend
|
|
534
535
|
# resp.classes #=> Array
|
535
536
|
# resp.classes[0].name #=> String
|
536
537
|
# resp.classes[0].score #=> Float
|
538
|
+
# resp.labels #=> Array
|
539
|
+
# resp.labels[0].name #=> String
|
540
|
+
# resp.labels[0].score #=> Float
|
537
541
|
#
|
538
542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocument AWS API Documentation
|
539
543
|
#
|
@@ -605,6 +609,14 @@ module Aws::Comprehend
|
|
605
609
|
#
|
606
610
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
607
611
|
#
|
612
|
+
# @option params [String] :mode
|
613
|
+
# Indicates the mode in which the classifier will be trained. The
|
614
|
+
# classifier can be trained in multi-class mode, which identifies one
|
615
|
+
# and only one class for each document, or multi-label mode, which
|
616
|
+
# identifies one or more labels for each document. In multi-label mode,
|
617
|
+
# multiple labels for an individual document are separated by a
|
618
|
+
# delimiter. The default delimiter between labels is a pipe (\|).
|
619
|
+
#
|
608
620
|
# @return [Types::CreateDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
609
621
|
#
|
610
622
|
# * {Types::CreateDocumentClassifierResponse#document_classifier_arn #document_classifier_arn} => String
|
@@ -622,6 +634,7 @@ module Aws::Comprehend
|
|
622
634
|
# ],
|
623
635
|
# input_data_config: { # required
|
624
636
|
# s3_uri: "S3Uri", # required
|
637
|
+
# label_delimiter: "LabelDelimiter",
|
625
638
|
# },
|
626
639
|
# output_data_config: {
|
627
640
|
# s3_uri: "S3Uri",
|
@@ -634,6 +647,7 @@ module Aws::Comprehend
|
|
634
647
|
# security_group_ids: ["SecurityGroupId"], # required
|
635
648
|
# subnets: ["SubnetId"], # required
|
636
649
|
# },
|
650
|
+
# mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
|
637
651
|
# })
|
638
652
|
#
|
639
653
|
# @example Response structure
|
@@ -981,6 +995,7 @@ module Aws::Comprehend
|
|
981
995
|
# resp.document_classifier_properties.training_start_time #=> Time
|
982
996
|
# resp.document_classifier_properties.training_end_time #=> Time
|
983
997
|
# resp.document_classifier_properties.input_data_config.s3_uri #=> String
|
998
|
+
# resp.document_classifier_properties.input_data_config.label_delimiter #=> String
|
984
999
|
# resp.document_classifier_properties.output_data_config.s3_uri #=> String
|
985
1000
|
# resp.document_classifier_properties.output_data_config.kms_key_id #=> String
|
986
1001
|
# resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
|
@@ -990,12 +1005,17 @@ module Aws::Comprehend
|
|
990
1005
|
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.precision #=> Float
|
991
1006
|
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.recall #=> Float
|
992
1007
|
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.f1_score #=> Float
|
1008
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_precision #=> Float
|
1009
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_recall #=> Float
|
1010
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.micro_f1_score #=> Float
|
1011
|
+
# resp.document_classifier_properties.classifier_metadata.evaluation_metrics.hamming_loss #=> Float
|
993
1012
|
# resp.document_classifier_properties.data_access_role_arn #=> String
|
994
1013
|
# resp.document_classifier_properties.volume_kms_key_id #=> String
|
995
1014
|
# resp.document_classifier_properties.vpc_config.security_group_ids #=> Array
|
996
1015
|
# resp.document_classifier_properties.vpc_config.security_group_ids[0] #=> String
|
997
1016
|
# resp.document_classifier_properties.vpc_config.subnets #=> Array
|
998
1017
|
# resp.document_classifier_properties.vpc_config.subnets[0] #=> String
|
1018
|
+
# resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
999
1019
|
#
|
1000
1020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
|
1001
1021
|
#
|
@@ -1638,6 +1658,7 @@ module Aws::Comprehend
|
|
1638
1658
|
# resp.document_classifier_properties_list[0].training_start_time #=> Time
|
1639
1659
|
# resp.document_classifier_properties_list[0].training_end_time #=> Time
|
1640
1660
|
# resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
|
1661
|
+
# resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
|
1641
1662
|
# resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
|
1642
1663
|
# resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
|
1643
1664
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
|
@@ -1647,12 +1668,17 @@ module Aws::Comprehend
|
|
1647
1668
|
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.precision #=> Float
|
1648
1669
|
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.recall #=> Float
|
1649
1670
|
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.f1_score #=> Float
|
1671
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_precision #=> Float
|
1672
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_recall #=> Float
|
1673
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.micro_f1_score #=> Float
|
1674
|
+
# resp.document_classifier_properties_list[0].classifier_metadata.evaluation_metrics.hamming_loss #=> Float
|
1650
1675
|
# resp.document_classifier_properties_list[0].data_access_role_arn #=> String
|
1651
1676
|
# resp.document_classifier_properties_list[0].volume_kms_key_id #=> String
|
1652
1677
|
# resp.document_classifier_properties_list[0].vpc_config.security_group_ids #=> Array
|
1653
1678
|
# resp.document_classifier_properties_list[0].vpc_config.security_group_ids[0] #=> String
|
1654
1679
|
# resp.document_classifier_properties_list[0].vpc_config.subnets #=> Array
|
1655
1680
|
# resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
|
1681
|
+
# resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
1656
1682
|
# resp.next_token #=> String
|
1657
1683
|
#
|
1658
1684
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
|
@@ -3058,7 +3084,7 @@ module Aws::Comprehend
|
|
3058
3084
|
params: params,
|
3059
3085
|
config: config)
|
3060
3086
|
context[:gem_name] = 'aws-sdk-comprehend'
|
3061
|
-
context[:gem_version] = '1.
|
3087
|
+
context[:gem_version] = '1.29.0'
|
3062
3088
|
Seahorse::Client::Request.new(handlers, context)
|
3063
3089
|
end
|
3064
3090
|
|
@@ -89,9 +89,11 @@ module Aws::Comprehend
|
|
89
89
|
DocumentClassifierEndpointArn = Shapes::StringShape.new(name: 'DocumentClassifierEndpointArn')
|
90
90
|
DocumentClassifierFilter = Shapes::StructureShape.new(name: 'DocumentClassifierFilter')
|
91
91
|
DocumentClassifierInputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierInputDataConfig')
|
92
|
+
DocumentClassifierMode = Shapes::StringShape.new(name: 'DocumentClassifierMode')
|
92
93
|
DocumentClassifierOutputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierOutputDataConfig')
|
93
94
|
DocumentClassifierProperties = Shapes::StructureShape.new(name: 'DocumentClassifierProperties')
|
94
95
|
DocumentClassifierPropertiesList = Shapes::ListShape.new(name: 'DocumentClassifierPropertiesList')
|
96
|
+
DocumentLabel = Shapes::StructureShape.new(name: 'DocumentLabel')
|
95
97
|
DominantLanguage = Shapes::StructureShape.new(name: 'DominantLanguage')
|
96
98
|
DominantLanguageDetectionJobFilter = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobFilter')
|
97
99
|
DominantLanguageDetectionJobProperties = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobProperties')
|
@@ -141,6 +143,7 @@ module Aws::Comprehend
|
|
141
143
|
KeyPhrasesDetectionJobPropertiesList = Shapes::ListShape.new(name: 'KeyPhrasesDetectionJobPropertiesList')
|
142
144
|
KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
|
143
145
|
KmsKeyValidationException = Shapes::StructureShape.new(name: 'KmsKeyValidationException')
|
146
|
+
LabelDelimiter = Shapes::StringShape.new(name: 'LabelDelimiter')
|
144
147
|
LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
|
145
148
|
ListDocumentClassificationJobsRequest = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsRequest')
|
146
149
|
ListDocumentClassificationJobsResponse = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsResponse')
|
@@ -165,6 +168,7 @@ module Aws::Comprehend
|
|
165
168
|
ListOfDominantLanguages = Shapes::ListShape.new(name: 'ListOfDominantLanguages')
|
166
169
|
ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
|
167
170
|
ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
|
171
|
+
ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
|
168
172
|
ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
|
169
173
|
ListSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsRequest')
|
170
174
|
ListSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsResponse')
|
@@ -316,6 +320,10 @@ module Aws::Comprehend
|
|
316
320
|
ClassifierEvaluationMetrics.add_member(:precision, Shapes::ShapeRef.new(shape: Double, location_name: "Precision"))
|
317
321
|
ClassifierEvaluationMetrics.add_member(:recall, Shapes::ShapeRef.new(shape: Double, location_name: "Recall"))
|
318
322
|
ClassifierEvaluationMetrics.add_member(:f1_score, Shapes::ShapeRef.new(shape: Double, location_name: "F1Score"))
|
323
|
+
ClassifierEvaluationMetrics.add_member(:micro_precision, Shapes::ShapeRef.new(shape: Double, location_name: "MicroPrecision"))
|
324
|
+
ClassifierEvaluationMetrics.add_member(:micro_recall, Shapes::ShapeRef.new(shape: Double, location_name: "MicroRecall"))
|
325
|
+
ClassifierEvaluationMetrics.add_member(:micro_f1_score, Shapes::ShapeRef.new(shape: Double, location_name: "MicroF1Score"))
|
326
|
+
ClassifierEvaluationMetrics.add_member(:hamming_loss, Shapes::ShapeRef.new(shape: Double, location_name: "HammingLoss"))
|
319
327
|
ClassifierEvaluationMetrics.struct_class = Types::ClassifierEvaluationMetrics
|
320
328
|
|
321
329
|
ClassifierMetadata.add_member(:number_of_labels, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfLabels"))
|
@@ -329,6 +337,7 @@ module Aws::Comprehend
|
|
329
337
|
ClassifyDocumentRequest.struct_class = Types::ClassifyDocumentRequest
|
330
338
|
|
331
339
|
ClassifyDocumentResponse.add_member(:classes, Shapes::ShapeRef.new(shape: ListOfClasses, location_name: "Classes"))
|
340
|
+
ClassifyDocumentResponse.add_member(:labels, Shapes::ShapeRef.new(shape: ListOfLabels, location_name: "Labels"))
|
332
341
|
ClassifyDocumentResponse.struct_class = Types::ClassifyDocumentResponse
|
333
342
|
|
334
343
|
ConcurrentModificationException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
@@ -343,6 +352,7 @@ module Aws::Comprehend
|
|
343
352
|
CreateDocumentClassifierRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
344
353
|
CreateDocumentClassifierRequest.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
345
354
|
CreateDocumentClassifierRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
355
|
+
CreateDocumentClassifierRequest.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
|
346
356
|
CreateDocumentClassifierRequest.struct_class = Types::CreateDocumentClassifierRequest
|
347
357
|
|
348
358
|
CreateDocumentClassifierResponse.add_member(:document_classifier_arn, Shapes::ShapeRef.new(shape: DocumentClassifierArn, location_name: "DocumentClassifierArn"))
|
@@ -507,6 +517,7 @@ module Aws::Comprehend
|
|
507
517
|
DocumentClassifierFilter.struct_class = Types::DocumentClassifierFilter
|
508
518
|
|
509
519
|
DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
520
|
+
DocumentClassifierInputDataConfig.add_member(:label_delimiter, Shapes::ShapeRef.new(shape: LabelDelimiter, location_name: "LabelDelimiter"))
|
510
521
|
DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
|
511
522
|
|
512
523
|
DocumentClassifierOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
|
@@ -527,10 +538,15 @@ module Aws::Comprehend
|
|
527
538
|
DocumentClassifierProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
528
539
|
DocumentClassifierProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
529
540
|
DocumentClassifierProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
541
|
+
DocumentClassifierProperties.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
|
530
542
|
DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
|
531
543
|
|
532
544
|
DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
|
533
545
|
|
546
|
+
DocumentLabel.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
|
547
|
+
DocumentLabel.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
548
|
+
DocumentLabel.struct_class = Types::DocumentLabel
|
549
|
+
|
534
550
|
DominantLanguage.add_member(:language_code, Shapes::ShapeRef.new(shape: String, location_name: "LanguageCode"))
|
535
551
|
DominantLanguage.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
536
552
|
DominantLanguage.struct_class = Types::DominantLanguage
|
@@ -797,6 +813,8 @@ module Aws::Comprehend
|
|
797
813
|
|
798
814
|
ListOfKeyPhrases.member = Shapes::ShapeRef.new(shape: KeyPhrase)
|
799
815
|
|
816
|
+
ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
|
817
|
+
|
800
818
|
ListOfSyntaxTokens.member = Shapes::ShapeRef.new(shape: SyntaxToken)
|
801
819
|
|
802
820
|
ListSentimentDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: SentimentDetectionJobFilter, location_name: "Filter"))
|
@@ -425,13 +425,50 @@ module Aws::Comprehend
|
|
425
425
|
# score is 1, and the worst score is 0.
|
426
426
|
# @return [Float]
|
427
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
|
+
#
|
428
461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifierEvaluationMetrics AWS API Documentation
|
429
462
|
#
|
430
463
|
class ClassifierEvaluationMetrics < Struct.new(
|
431
464
|
:accuracy,
|
432
465
|
:precision,
|
433
466
|
:recall,
|
434
|
-
:f1_score
|
467
|
+
:f1_score,
|
468
|
+
:micro_precision,
|
469
|
+
:micro_recall,
|
470
|
+
:micro_f1_score,
|
471
|
+
:hamming_loss)
|
435
472
|
include Aws::Structure
|
436
473
|
end
|
437
474
|
|
@@ -500,10 +537,20 @@ module Aws::Comprehend
|
|
500
537
|
# not both at the same time.
|
501
538
|
# @return [Array<Types::DocumentClass>]
|
502
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
|
+
#
|
503
549
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentResponse AWS API Documentation
|
504
550
|
#
|
505
551
|
class ClassifyDocumentResponse < Struct.new(
|
506
|
-
:classes
|
552
|
+
:classes,
|
553
|
+
:labels)
|
507
554
|
include Aws::Structure
|
508
555
|
end
|
509
556
|
|
@@ -534,6 +581,7 @@ module Aws::Comprehend
|
|
534
581
|
# ],
|
535
582
|
# input_data_config: { # required
|
536
583
|
# s3_uri: "S3Uri", # required
|
584
|
+
# label_delimiter: "LabelDelimiter",
|
537
585
|
# },
|
538
586
|
# output_data_config: {
|
539
587
|
# s3_uri: "S3Uri",
|
@@ -546,6 +594,7 @@ module Aws::Comprehend
|
|
546
594
|
# security_group_ids: ["SecurityGroupId"], # required
|
547
595
|
# subnets: ["SubnetId"], # required
|
548
596
|
# },
|
597
|
+
# mode: "MULTI_CLASS", # accepts MULTI_CLASS, MULTI_LABEL
|
549
598
|
# }
|
550
599
|
#
|
551
600
|
# @!attribute [rw] document_classifier_name
|
@@ -613,6 +662,15 @@ module Aws::Comprehend
|
|
613
662
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
614
663
|
# @return [Types::VpcConfig]
|
615
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
|
+
#
|
616
674
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDocumentClassifierRequest AWS API Documentation
|
617
675
|
#
|
618
676
|
class CreateDocumentClassifierRequest < Struct.new(
|
@@ -624,7 +682,8 @@ module Aws::Comprehend
|
|
624
682
|
:client_request_token,
|
625
683
|
:language_code,
|
626
684
|
:volume_kms_key_id,
|
627
|
-
:vpc_config
|
685
|
+
:vpc_config,
|
686
|
+
:mode)
|
628
687
|
include Aws::Structure
|
629
688
|
end
|
630
689
|
|
@@ -1593,6 +1652,7 @@ module Aws::Comprehend
|
|
1593
1652
|
#
|
1594
1653
|
# {
|
1595
1654
|
# s3_uri: "S3Uri", # required
|
1655
|
+
# label_delimiter: "LabelDelimiter",
|
1596
1656
|
# }
|
1597
1657
|
#
|
1598
1658
|
# @!attribute [rw] s3_uri
|
@@ -1607,10 +1667,21 @@ module Aws::Comprehend
|
|
1607
1667
|
# all of them as input.
|
1608
1668
|
# @return [String]
|
1609
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
|
+
#
|
1610
1680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
|
1611
1681
|
#
|
1612
1682
|
class DocumentClassifierInputDataConfig < Struct.new(
|
1613
|
-
:s3_uri
|
1683
|
+
:s3_uri,
|
1684
|
+
:label_delimiter)
|
1614
1685
|
include Aws::Structure
|
1615
1686
|
end
|
1616
1687
|
|
@@ -1750,6 +1821,13 @@ module Aws::Comprehend
|
|
1750
1821
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
1751
1822
|
# @return [Types::VpcConfig]
|
1752
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
|
+
#
|
1753
1831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
|
1754
1832
|
#
|
1755
1833
|
class DocumentClassifierProperties < Struct.new(
|
@@ -1766,7 +1844,28 @@ module Aws::Comprehend
|
|
1766
1844
|
:classifier_metadata,
|
1767
1845
|
:data_access_role_arn,
|
1768
1846
|
:volume_kms_key_id,
|
1769
|
-
: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)
|
1770
1869
|
include Aws::Structure
|
1771
1870
|
end
|
1772
1871
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-comprehend
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.29.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-01-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|