aws-sdk-comprehend 1.39.0 → 1.40.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fb841e7f98bf2b40de5e3f385e3585ec64e29b61e921778971208d527886a5c9
4
- data.tar.gz: 4e8687f7495e31d6c9a844ba6a29b1867cf91ecfba0b3bdd64be8e3fda8dfa88
3
+ metadata.gz: c616569ac151be94478678e8f509d8cc0a148201704f390a297716813aacdbb4
4
+ data.tar.gz: 04544c64f14ae2c12f441c69ddb498c328f6eb5d7bc9753daecc92870a8ef26c
5
5
  SHA512:
6
- metadata.gz: 24ee5c1f0fa7e826845c22538e65a110fc59a26b171a2fb47ca05ac5ddc050c09adae81ace2c086dca498f1a47cd6910cfd2630d221e8a8bd61ccaf57812060b
7
- data.tar.gz: 0eccd1f090108d68ff3f208b0499112eea405e401966f6dff53174e29c71e1892cd530ce3bf9b0bcac977101a626e1f8dca1de1d0f04d909f67cc89640b50e19
6
+ metadata.gz: 1739c21b0c89d9ab9e466bd9a10beb11ed6cfb01f300361a02c00c0af927745c5e431443ec1c402a3db4308f97ac40ae303f8ad2fbd59cf1cd74f6a0d1d34c62
7
+ data.tar.gz: ac326f22ea88035afdb8345306e01d5bb828d095463a4761958b6b0bca8d697bf4faebee237eff8f0aa8a0036f62c15b335d1024bd21af2727e5f54b4b8ead56
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-comprehend/customizations'
48
48
  # @!group service
49
49
  module Aws::Comprehend
50
50
 
51
- GEM_VERSION = '1.39.0'
51
+ GEM_VERSION = '1.40.0'
52
52
 
53
53
  end
@@ -706,8 +706,15 @@ module Aws::Comprehend
706
706
  # },
707
707
  # ],
708
708
  # input_data_config: { # required
709
- # s3_uri: "S3Uri", # required
709
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
710
+ # s3_uri: "S3Uri",
710
711
  # label_delimiter: "LabelDelimiter",
712
+ # augmented_manifests: [
713
+ # {
714
+ # s3_uri: "S3Uri", # required
715
+ # attribute_names: ["AttributeNamesListItem"], # required
716
+ # },
717
+ # ],
711
718
  # },
712
719
  # output_data_config: {
713
720
  # s3_uri: "S3Uri",
@@ -873,12 +880,13 @@ module Aws::Comprehend
873
880
  # },
874
881
  # ],
875
882
  # input_data_config: { # required
883
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
876
884
  # entity_types: [ # required
877
885
  # {
878
886
  # type: "EntityTypeName", # required
879
887
  # },
880
888
  # ],
881
- # documents: { # required
889
+ # documents: {
882
890
  # s3_uri: "S3Uri", # required
883
891
  # },
884
892
  # annotations: {
@@ -887,6 +895,12 @@ module Aws::Comprehend
887
895
  # entity_list: {
888
896
  # s3_uri: "S3Uri", # required
889
897
  # },
898
+ # augmented_manifests: [
899
+ # {
900
+ # s3_uri: "S3Uri", # required
901
+ # attribute_names: ["AttributeNamesListItem"], # required
902
+ # },
903
+ # ],
890
904
  # },
891
905
  # client_request_token: "ClientRequestTokenString",
892
906
  # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
@@ -1069,8 +1083,13 @@ module Aws::Comprehend
1069
1083
  # resp.document_classifier_properties.end_time #=> Time
1070
1084
  # resp.document_classifier_properties.training_start_time #=> Time
1071
1085
  # resp.document_classifier_properties.training_end_time #=> Time
1086
+ # resp.document_classifier_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
1072
1087
  # resp.document_classifier_properties.input_data_config.s3_uri #=> String
1073
1088
  # resp.document_classifier_properties.input_data_config.label_delimiter #=> String
1089
+ # resp.document_classifier_properties.input_data_config.augmented_manifests #=> Array
1090
+ # resp.document_classifier_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
1091
+ # resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
1092
+ # resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
1074
1093
  # resp.document_classifier_properties.output_data_config.s3_uri #=> String
1075
1094
  # resp.document_classifier_properties.output_data_config.kms_key_id #=> String
1076
1095
  # resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
@@ -1256,11 +1275,16 @@ module Aws::Comprehend
1256
1275
  # resp.entity_recognizer_properties.end_time #=> Time
1257
1276
  # resp.entity_recognizer_properties.training_start_time #=> Time
1258
1277
  # resp.entity_recognizer_properties.training_end_time #=> Time
1278
+ # resp.entity_recognizer_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
1259
1279
  # resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
1260
1280
  # resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
1261
1281
  # resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
1262
1282
  # resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
1263
1283
  # resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
1284
+ # resp.entity_recognizer_properties.input_data_config.augmented_manifests #=> Array
1285
+ # resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
1286
+ # resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
1287
+ # resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
1264
1288
  # resp.entity_recognizer_properties.recognizer_metadata.number_of_trained_documents #=> Integer
1265
1289
  # resp.entity_recognizer_properties.recognizer_metadata.number_of_test_documents #=> Integer
1266
1290
  # resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.precision #=> Float
@@ -1835,8 +1859,13 @@ module Aws::Comprehend
1835
1859
  # resp.document_classifier_properties_list[0].end_time #=> Time
1836
1860
  # resp.document_classifier_properties_list[0].training_start_time #=> Time
1837
1861
  # resp.document_classifier_properties_list[0].training_end_time #=> Time
1862
+ # resp.document_classifier_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
1838
1863
  # resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
1839
1864
  # resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
1865
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
1866
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
1867
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
1868
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
1840
1869
  # resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
1841
1870
  # resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
1842
1871
  # resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
@@ -2104,11 +2133,16 @@ module Aws::Comprehend
2104
2133
  # resp.entity_recognizer_properties_list[0].end_time #=> Time
2105
2134
  # resp.entity_recognizer_properties_list[0].training_start_time #=> Time
2106
2135
  # resp.entity_recognizer_properties_list[0].training_end_time #=> Time
2136
+ # resp.entity_recognizer_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
2107
2137
  # resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
2108
2138
  # resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
2109
2139
  # resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
2110
2140
  # resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
2111
2141
  # resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
2142
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
2143
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
2144
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
2145
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
2112
2146
  # resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_trained_documents #=> Integer
2113
2147
  # resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_test_documents #=> Integer
2114
2148
  # resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.precision #=> Float
@@ -3447,7 +3481,7 @@ module Aws::Comprehend
3447
3481
  params: params,
3448
3482
  config: config)
3449
3483
  context[:gem_name] = 'aws-sdk-comprehend'
3450
- context[:gem_version] = '1.39.0'
3484
+ context[:gem_version] = '1.40.0'
3451
3485
  Seahorse::Client::Request.new(handlers, context)
3452
3486
  end
3453
3487
 
@@ -14,6 +14,9 @@ module Aws::Comprehend
14
14
  include Seahorse::Model
15
15
 
16
16
  AnyLengthString = Shapes::StringShape.new(name: 'AnyLengthString')
17
+ AttributeNamesList = Shapes::ListShape.new(name: 'AttributeNamesList')
18
+ AttributeNamesListItem = Shapes::StringShape.new(name: 'AttributeNamesListItem')
19
+ AugmentedManifestsListItem = Shapes::StructureShape.new(name: 'AugmentedManifestsListItem')
17
20
  BatchDetectDominantLanguageItemResult = Shapes::StructureShape.new(name: 'BatchDetectDominantLanguageItemResult')
18
21
  BatchDetectDominantLanguageRequest = Shapes::StructureShape.new(name: 'BatchDetectDominantLanguageRequest')
19
22
  BatchDetectDominantLanguageResponse = Shapes::StructureShape.new(name: 'BatchDetectDominantLanguageResponse')
@@ -94,6 +97,8 @@ module Aws::Comprehend
94
97
  DocumentClassificationJobProperties = Shapes::StructureShape.new(name: 'DocumentClassificationJobProperties')
95
98
  DocumentClassificationJobPropertiesList = Shapes::ListShape.new(name: 'DocumentClassificationJobPropertiesList')
96
99
  DocumentClassifierArn = Shapes::StringShape.new(name: 'DocumentClassifierArn')
100
+ DocumentClassifierAugmentedManifestsList = Shapes::ListShape.new(name: 'DocumentClassifierAugmentedManifestsList')
101
+ DocumentClassifierDataFormat = Shapes::StringShape.new(name: 'DocumentClassifierDataFormat')
97
102
  DocumentClassifierEndpointArn = Shapes::StringShape.new(name: 'DocumentClassifierEndpointArn')
98
103
  DocumentClassifierFilter = Shapes::StructureShape.new(name: 'DocumentClassifierFilter')
99
104
  DocumentClassifierInputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierInputDataConfig')
@@ -117,6 +122,8 @@ module Aws::Comprehend
117
122
  Entity = Shapes::StructureShape.new(name: 'Entity')
118
123
  EntityRecognizerAnnotations = Shapes::StructureShape.new(name: 'EntityRecognizerAnnotations')
119
124
  EntityRecognizerArn = Shapes::StringShape.new(name: 'EntityRecognizerArn')
125
+ EntityRecognizerAugmentedManifestsList = Shapes::ListShape.new(name: 'EntityRecognizerAugmentedManifestsList')
126
+ EntityRecognizerDataFormat = Shapes::StringShape.new(name: 'EntityRecognizerDataFormat')
120
127
  EntityRecognizerDocuments = Shapes::StructureShape.new(name: 'EntityRecognizerDocuments')
121
128
  EntityRecognizerEndpointArn = Shapes::StringShape.new(name: 'EntityRecognizerEndpointArn')
122
129
  EntityRecognizerEntityList = Shapes::StructureShape.new(name: 'EntityRecognizerEntityList')
@@ -272,6 +279,12 @@ module Aws::Comprehend
272
279
  UpdateEndpointResponse = Shapes::StructureShape.new(name: 'UpdateEndpointResponse')
273
280
  VpcConfig = Shapes::StructureShape.new(name: 'VpcConfig')
274
281
 
282
+ AttributeNamesList.member = Shapes::ShapeRef.new(shape: AttributeNamesListItem)
283
+
284
+ AugmentedManifestsListItem.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
285
+ AugmentedManifestsListItem.add_member(:attribute_names, Shapes::ShapeRef.new(shape: AttributeNamesList, required: true, location_name: "AttributeNames"))
286
+ AugmentedManifestsListItem.struct_class = Types::AugmentedManifestsListItem
287
+
275
288
  BatchDetectDominantLanguageItemResult.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "Index"))
276
289
  BatchDetectDominantLanguageItemResult.add_member(:languages, Shapes::ShapeRef.new(shape: ListOfDominantLanguages, location_name: "Languages"))
277
290
  BatchDetectDominantLanguageItemResult.struct_class = Types::BatchDetectDominantLanguageItemResult
@@ -553,13 +566,17 @@ module Aws::Comprehend
553
566
 
554
567
  DocumentClassificationJobPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassificationJobProperties)
555
568
 
569
+ DocumentClassifierAugmentedManifestsList.member = Shapes::ShapeRef.new(shape: AugmentedManifestsListItem)
570
+
556
571
  DocumentClassifierFilter.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
557
572
  DocumentClassifierFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
558
573
  DocumentClassifierFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
559
574
  DocumentClassifierFilter.struct_class = Types::DocumentClassifierFilter
560
575
 
561
- DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
576
+ DocumentClassifierInputDataConfig.add_member(:data_format, Shapes::ShapeRef.new(shape: DocumentClassifierDataFormat, location_name: "DataFormat"))
577
+ DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
562
578
  DocumentClassifierInputDataConfig.add_member(:label_delimiter, Shapes::ShapeRef.new(shape: LabelDelimiter, location_name: "LabelDelimiter"))
579
+ DocumentClassifierInputDataConfig.add_member(:augmented_manifests, Shapes::ShapeRef.new(shape: DocumentClassifierAugmentedManifestsList, location_name: "AugmentedManifests"))
563
580
  DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
564
581
 
565
582
  DocumentClassifierOutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
@@ -665,6 +682,8 @@ module Aws::Comprehend
665
682
  EntityRecognizerAnnotations.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
666
683
  EntityRecognizerAnnotations.struct_class = Types::EntityRecognizerAnnotations
667
684
 
685
+ EntityRecognizerAugmentedManifestsList.member = Shapes::ShapeRef.new(shape: AugmentedManifestsListItem)
686
+
668
687
  EntityRecognizerDocuments.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
669
688
  EntityRecognizerDocuments.struct_class = Types::EntityRecognizerDocuments
670
689
 
@@ -681,10 +700,12 @@ module Aws::Comprehend
681
700
  EntityRecognizerFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
682
701
  EntityRecognizerFilter.struct_class = Types::EntityRecognizerFilter
683
702
 
703
+ EntityRecognizerInputDataConfig.add_member(:data_format, Shapes::ShapeRef.new(shape: EntityRecognizerDataFormat, location_name: "DataFormat"))
684
704
  EntityRecognizerInputDataConfig.add_member(:entity_types, Shapes::ShapeRef.new(shape: EntityTypesList, required: true, location_name: "EntityTypes"))
685
- EntityRecognizerInputDataConfig.add_member(:documents, Shapes::ShapeRef.new(shape: EntityRecognizerDocuments, required: true, location_name: "Documents"))
705
+ EntityRecognizerInputDataConfig.add_member(:documents, Shapes::ShapeRef.new(shape: EntityRecognizerDocuments, location_name: "Documents"))
686
706
  EntityRecognizerInputDataConfig.add_member(:annotations, Shapes::ShapeRef.new(shape: EntityRecognizerAnnotations, location_name: "Annotations"))
687
707
  EntityRecognizerInputDataConfig.add_member(:entity_list, Shapes::ShapeRef.new(shape: EntityRecognizerEntityList, location_name: "EntityList"))
708
+ EntityRecognizerInputDataConfig.add_member(:augmented_manifests, Shapes::ShapeRef.new(shape: EntityRecognizerAugmentedManifestsList, location_name: "AugmentedManifests"))
688
709
  EntityRecognizerInputDataConfig.struct_class = Types::EntityRecognizerInputDataConfig
689
710
 
690
711
  EntityRecognizerMetadata.add_member(:number_of_trained_documents, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfTrainedDocuments"))
@@ -10,6 +10,47 @@
10
10
  module Aws::Comprehend
11
11
  module Types
12
12
 
13
+ # An augmented manifest file that provides training data for your custom
14
+ # model. An augmented manifest file is a labeled dataset that is
15
+ # produced by Amazon SageMaker Ground Truth.
16
+ #
17
+ # @note When making an API call, you may pass AugmentedManifestsListItem
18
+ # data as a hash:
19
+ #
20
+ # {
21
+ # s3_uri: "S3Uri", # required
22
+ # attribute_names: ["AttributeNamesListItem"], # required
23
+ # }
24
+ #
25
+ # @!attribute [rw] s3_uri
26
+ # The Amazon S3 location of the augmented manifest file.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] attribute_names
30
+ # The JSON attribute that contains the annotations for your training
31
+ # documents. The number of attribute names that you specify depends on
32
+ # whether your augmented manifest file is the output of a single
33
+ # labeling job or a chained labeling job.
34
+ #
35
+ # If your file is the output of a single labeling job, specify the
36
+ # LabelAttributeName key that was used when the job was created in
37
+ # Ground Truth.
38
+ #
39
+ # If your file is the output of a chained labeling job, specify the
40
+ # LabelAttributeName key for one or more jobs in the chain. Each
41
+ # LabelAttributeName key provides the annotations from an individual
42
+ # job.
43
+ # @return [Array<String>]
44
+ #
45
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/AugmentedManifestsListItem AWS API Documentation
46
+ #
47
+ class AugmentedManifestsListItem < Struct.new(
48
+ :s3_uri,
49
+ :attribute_names)
50
+ SENSITIVE = []
51
+ include Aws::Structure
52
+ end
53
+
13
54
  # The result of calling the operation. The operation returns one object
14
55
  # for each document that is successfully processed by the operation.
15
56
  #
@@ -604,8 +645,15 @@ module Aws::Comprehend
604
645
  # },
605
646
  # ],
606
647
  # input_data_config: { # required
607
- # s3_uri: "S3Uri", # required
648
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
649
+ # s3_uri: "S3Uri",
608
650
  # label_delimiter: "LabelDelimiter",
651
+ # augmented_manifests: [
652
+ # {
653
+ # s3_uri: "S3Uri", # required
654
+ # attribute_names: ["AttributeNamesListItem"], # required
655
+ # },
656
+ # ],
609
657
  # },
610
658
  # output_data_config: {
611
659
  # s3_uri: "S3Uri",
@@ -810,12 +858,13 @@ module Aws::Comprehend
810
858
  # },
811
859
  # ],
812
860
  # input_data_config: { # required
861
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
813
862
  # entity_types: [ # required
814
863
  # {
815
864
  # type: "EntityTypeName", # required
816
865
  # },
817
866
  # ],
818
- # documents: { # required
867
+ # documents: {
819
868
  # s3_uri: "S3Uri", # required
820
869
  # },
821
870
  # annotations: {
@@ -824,6 +873,12 @@ module Aws::Comprehend
824
873
  # entity_list: {
825
874
  # s3_uri: "S3Uri", # required
826
875
  # },
876
+ # augmented_manifests: [
877
+ # {
878
+ # s3_uri: "S3Uri", # required
879
+ # attribute_names: ["AttributeNamesListItem"], # required
880
+ # },
881
+ # ],
827
882
  # },
828
883
  # client_request_token: "ClientRequestTokenString",
829
884
  # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
@@ -1813,10 +1868,37 @@ module Aws::Comprehend
1813
1868
  # data as a hash:
1814
1869
  #
1815
1870
  # {
1816
- # s3_uri: "S3Uri", # required
1871
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
1872
+ # s3_uri: "S3Uri",
1817
1873
  # label_delimiter: "LabelDelimiter",
1874
+ # augmented_manifests: [
1875
+ # {
1876
+ # s3_uri: "S3Uri", # required
1877
+ # attribute_names: ["AttributeNamesListItem"], # required
1878
+ # },
1879
+ # ],
1818
1880
  # }
1819
1881
  #
1882
+ # @!attribute [rw] data_format
1883
+ # The format of your training data:
1884
+ #
1885
+ # * `COMPREHEND_CSV`\: A two-column CSV file, where labels are
1886
+ # provided in the first column, and documents are provided in the
1887
+ # second. If you use this value, you must provide the `S3Uri`
1888
+ # parameter in your request.
1889
+ #
1890
+ # * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
1891
+ # Amazon SageMaker Ground Truth. This file is in JSON lines format.
1892
+ # Each line is a complete JSON object that contains a training
1893
+ # document and its associated labels.
1894
+ #
1895
+ # If you use this value, you must provide the `AugmentedManifests`
1896
+ # parameter in your request.
1897
+ #
1898
+ # If you don't specify a value, Amazon Comprehend uses
1899
+ # `COMPREHEND_CSV` as the default.
1900
+ # @return [String]
1901
+ #
1820
1902
  # @!attribute [rw] s3_uri
1821
1903
  # The Amazon S3 URI for the input data. The S3 bucket must be in the
1822
1904
  # same region as the API endpoint that you are calling. The URI can
@@ -1827,6 +1909,9 @@ module Aws::Comprehend
1827
1909
  # prefix is a single file, Amazon Comprehend uses that file as input.
1828
1910
  # If more than one file begins with the prefix, Amazon Comprehend uses
1829
1911
  # all of them as input.
1912
+ #
1913
+ # This parameter is required if you set `DataFormat` to
1914
+ # `COMPREHEND_CSV`.
1830
1915
  # @return [String]
1831
1916
  #
1832
1917
  # @!attribute [rw] label_delimiter
@@ -1839,11 +1924,22 @@ module Aws::Comprehend
1839
1924
  # be combined to make a single unique label, such as LABELLABELLABEL.
1840
1925
  # @return [String]
1841
1926
  #
1927
+ # @!attribute [rw] augmented_manifests
1928
+ # A list of augmented manifest files that provide training data for
1929
+ # your custom model. An augmented manifest file is a labeled dataset
1930
+ # that is produced by Amazon SageMaker Ground Truth.
1931
+ #
1932
+ # This parameter is required if you set `DataFormat` to
1933
+ # `AUGMENTED_MANIFEST`.
1934
+ # @return [Array<Types::AugmentedManifestsListItem>]
1935
+ #
1842
1936
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
1843
1937
  #
1844
1938
  class DocumentClassifierInputDataConfig < Struct.new(
1939
+ :data_format,
1845
1940
  :s3_uri,
1846
- :label_delimiter)
1941
+ :label_delimiter,
1942
+ :augmented_manifests)
1847
1943
  SENSITIVE = []
1848
1944
  include Aws::Structure
1849
1945
  end
@@ -2626,12 +2722,13 @@ module Aws::Comprehend
2626
2722
  # data as a hash:
2627
2723
  #
2628
2724
  # {
2725
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
2629
2726
  # entity_types: [ # required
2630
2727
  # {
2631
2728
  # type: "EntityTypeName", # required
2632
2729
  # },
2633
2730
  # ],
2634
- # documents: { # required
2731
+ # documents: {
2635
2732
  # s3_uri: "S3Uri", # required
2636
2733
  # },
2637
2734
  # annotations: {
@@ -2640,33 +2737,89 @@ module Aws::Comprehend
2640
2737
  # entity_list: {
2641
2738
  # s3_uri: "S3Uri", # required
2642
2739
  # },
2740
+ # augmented_manifests: [
2741
+ # {
2742
+ # s3_uri: "S3Uri", # required
2743
+ # attribute_names: ["AttributeNamesListItem"], # required
2744
+ # },
2745
+ # ],
2643
2746
  # }
2644
2747
  #
2748
+ # @!attribute [rw] data_format
2749
+ # The format of your training data:
2750
+ #
2751
+ # * `COMPREHEND_CSV`\: A CSV file that supplements your training
2752
+ # documents. The CSV file contains information about the custom
2753
+ # entities that your trained model will detect. The required format
2754
+ # of the file depends on whether you are providing annotations or an
2755
+ # entity list.
2756
+ #
2757
+ # If you use this value, you must provide your CSV file by using
2758
+ # either the `Annotations` or `EntityList` parameters. You must
2759
+ # provide your training documents by using the `Documents`
2760
+ # parameter.
2761
+ #
2762
+ # * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
2763
+ # Amazon SageMaker Ground Truth. This file is in JSON lines format.
2764
+ # Each line is a complete JSON object that contains a training
2765
+ # document and its labels. Each label annotates a named entity in
2766
+ # the training document.
2767
+ #
2768
+ # If you use this value, you must provide the `AugmentedManifests`
2769
+ # parameter in your request.
2770
+ #
2771
+ # If you don't specify a value, Amazon Comprehend uses
2772
+ # `COMPREHEND_CSV` as the default.
2773
+ # @return [String]
2774
+ #
2645
2775
  # @!attribute [rw] entity_types
2646
- # The entity types in the input data for an entity recognizer. A
2647
- # maximum of 25 entity types can be used at one time to train an
2648
- # entity recognizer.
2776
+ # The entity types in the labeled training data that Amazon Comprehend
2777
+ # uses to train the custom entity recognizer. Any entity types that
2778
+ # you don't specify are ignored.
2779
+ #
2780
+ # A maximum of 25 entity types can be used at one time to train an
2781
+ # entity recognizer. Entity types must not contain the following
2782
+ # invalid characters: \\n (line break), \\\\n (escaped line break),
2783
+ # \\r (carriage return), \\\\r (escaped carriage return), \\t (tab),
2784
+ # \\\\t (escaped tab), space, and , (comma).
2649
2785
  # @return [Array<Types::EntityTypesListItem>]
2650
2786
  #
2651
2787
  # @!attribute [rw] documents
2652
- # S3 location of the documents folder for an entity recognizer
2788
+ # The S3 location of the folder that contains the training documents
2789
+ # for your custom entity recognizer.
2790
+ #
2791
+ # This parameter is required if you set `DataFormat` to
2792
+ # `COMPREHEND_CSV`.
2653
2793
  # @return [Types::EntityRecognizerDocuments]
2654
2794
  #
2655
2795
  # @!attribute [rw] annotations
2656
- # S3 location of the annotations file for an entity recognizer.
2796
+ # The S3 location of the CSV file that annotates your training
2797
+ # documents.
2657
2798
  # @return [Types::EntityRecognizerAnnotations]
2658
2799
  #
2659
2800
  # @!attribute [rw] entity_list
2660
- # S3 location of the entity list for an entity recognizer.
2801
+ # The S3 location of the CSV file that has the entity list for your
2802
+ # custom entity recognizer.
2661
2803
  # @return [Types::EntityRecognizerEntityList]
2662
2804
  #
2805
+ # @!attribute [rw] augmented_manifests
2806
+ # A list of augmented manifest files that provide training data for
2807
+ # your custom model. An augmented manifest file is a labeled dataset
2808
+ # that is produced by Amazon SageMaker Ground Truth.
2809
+ #
2810
+ # This parameter is required if you set `DataFormat` to
2811
+ # `AUGMENTED_MANIFEST`.
2812
+ # @return [Array<Types::AugmentedManifestsListItem>]
2813
+ #
2663
2814
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerInputDataConfig AWS API Documentation
2664
2815
  #
2665
2816
  class EntityRecognizerInputDataConfig < Struct.new(
2817
+ :data_format,
2666
2818
  :entity_types,
2667
2819
  :documents,
2668
2820
  :annotations,
2669
- :entity_list)
2821
+ :entity_list,
2822
+ :augmented_manifests)
2670
2823
  SENSITIVE = []
2671
2824
  include Aws::Structure
2672
2825
  end
@@ -2858,7 +3011,8 @@ module Aws::Comprehend
2858
3011
  include Aws::Structure
2859
3012
  end
2860
3013
 
2861
- # Information about an individual item on a list of entity types.
3014
+ # An entity type within a labeled training dataset that Amazon
3015
+ # Comprehend uses to train a custom entity recognizer.
2862
3016
  #
2863
3017
  # @note When making an API call, you may pass EntityTypesListItem
2864
3018
  # data as a hash:
@@ -2868,7 +3022,13 @@ module Aws::Comprehend
2868
3022
  # }
2869
3023
  #
2870
3024
  # @!attribute [rw] type
2871
- # Entity type of an item on an entity type list.
3025
+ # An entity type within a labeled training dataset that Amazon
3026
+ # Comprehend uses to train a custom entity recognizer.
3027
+ #
3028
+ # Entity types must not contain the following invalid characters: \\n
3029
+ # (line break), \\\\n (escaped line break, \\r (carriage return),
3030
+ # \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),
3031
+ # space, and , (comma).
2872
3032
  # @return [String]
2873
3033
  #
2874
3034
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesListItem AWS API Documentation
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.39.0
4
+ version: 1.40.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: 2020-09-17 00:00:00.000000000 Z
11
+ date: 2020-09-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core