aws-sdk-comprehend 1.51.0 → 1.55.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehend/client.rb +154 -4
- data/lib/aws-sdk-comprehend/client_api.rb +94 -1
- data/lib/aws-sdk-comprehend/types.rb +299 -7
- data/lib/aws-sdk-comprehend.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4a66eae86704576739d4e329c11b1467017387e8592bc50024e44d136c3b86e8
|
4
|
+
data.tar.gz: 559e0fa79cad84ab64ea8bef97120b289a590024cb67615cd167993c18e7508b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1865c6d05fe08f74261b392a0b75aa76a77f3b9d82ae21b52e4deb072b20638e137e308728cdba26a0cfeafcc009385a2fd7f61423e5a880c3992a09bc5620d3
|
7
|
+
data.tar.gz: c1a70be4e54b66e8dda1fc1093d2153446d405a428689936795fcf2f1790097d9c1c7a7f9009828e7c8a0c1b48cb24a938c2eaf77649f751a77f265fdc241de8
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.55.0 (2021-11-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.54.0 (2021-11-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.53.0 (2021-10-18)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.52.0 (2021-09-21)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Amazon Comprehend now supports versioning of custom models, improved training with ONE_DOC_PER_FILE text documents for custom entity recognition, ability to provide specific test sets during training, and live migration to new model endpoints.
|
23
|
+
|
4
24
|
1.51.0 (2021-09-14)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.55.0
|
@@ -119,7 +119,9 @@ module Aws::Comprehend
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -285,6 +287,15 @@ module Aws::Comprehend
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
288
|
# requests are made, and retries are disabled.
|
287
289
|
#
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
|
+
# will be used if available.
|
293
|
+
#
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
297
|
+
# is set to `true`.
|
298
|
+
#
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
289
300
|
# When `true`, request parameters are validated before
|
290
301
|
# sending the request.
|
@@ -669,6 +680,13 @@ module Aws::Comprehend
|
|
669
680
|
# @option params [required, String] :document_classifier_name
|
670
681
|
# The name of the document classifier.
|
671
682
|
#
|
683
|
+
# @option params [String] :version_name
|
684
|
+
# The version name given to the newly created classifier. Version names
|
685
|
+
# can have a maximum of 256 characters. Alphanumeric characters, hyphens
|
686
|
+
# (-) and underscores (\_) are allowed. The version name must be unique
|
687
|
+
# among all models with the same classifier name in the account/AWS
|
688
|
+
# Region.
|
689
|
+
#
|
672
690
|
# @option params [required, String] :data_access_role_arn
|
673
691
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
674
692
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -746,6 +764,7 @@ module Aws::Comprehend
|
|
746
764
|
#
|
747
765
|
# resp = client.create_document_classifier({
|
748
766
|
# document_classifier_name: "ComprehendArnName", # required
|
767
|
+
# version_name: "VersionName",
|
749
768
|
# data_access_role_arn: "IamRoleArn", # required
|
750
769
|
# tags: [
|
751
770
|
# {
|
@@ -756,10 +775,12 @@ module Aws::Comprehend
|
|
756
775
|
# input_data_config: { # required
|
757
776
|
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
758
777
|
# s3_uri: "S3Uri",
|
778
|
+
# test_s3_uri: "S3Uri",
|
759
779
|
# label_delimiter: "LabelDelimiter",
|
760
780
|
# augmented_manifests: [
|
761
781
|
# {
|
762
782
|
# s3_uri: "S3Uri", # required
|
783
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
763
784
|
# attribute_names: ["AttributeNamesListItem"], # required
|
764
785
|
# annotation_data_s3_uri: "S3Uri",
|
765
786
|
# source_documents_s3_uri: "S3Uri",
|
@@ -874,6 +895,13 @@ module Aws::Comprehend
|
|
874
895
|
# and underscores (\_) are allowed. The name must be unique in the
|
875
896
|
# account/region.
|
876
897
|
#
|
898
|
+
# @option params [String] :version_name
|
899
|
+
# The version name given to the newly created recognizer. Version names
|
900
|
+
# can be a maximum of 256 characters. Alphanumeric characters, hyphens
|
901
|
+
# (-) and underscores (\_) are allowed. The version name must be unique
|
902
|
+
# among all models with the same recognizer name in the account/ AWS
|
903
|
+
# Region.
|
904
|
+
#
|
877
905
|
# @option params [required, String] :data_access_role_arn
|
878
906
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
879
907
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -941,6 +969,7 @@ module Aws::Comprehend
|
|
941
969
|
#
|
942
970
|
# resp = client.create_entity_recognizer({
|
943
971
|
# recognizer_name: "ComprehendArnName", # required
|
972
|
+
# version_name: "VersionName",
|
944
973
|
# data_access_role_arn: "IamRoleArn", # required
|
945
974
|
# tags: [
|
946
975
|
# {
|
@@ -957,9 +986,12 @@ module Aws::Comprehend
|
|
957
986
|
# ],
|
958
987
|
# documents: {
|
959
988
|
# s3_uri: "S3Uri", # required
|
989
|
+
# test_s3_uri: "S3Uri",
|
990
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
960
991
|
# },
|
961
992
|
# annotations: {
|
962
993
|
# s3_uri: "S3Uri", # required
|
994
|
+
# test_s3_uri: "S3Uri",
|
963
995
|
# },
|
964
996
|
# entity_list: {
|
965
997
|
# s3_uri: "S3Uri", # required
|
@@ -967,6 +999,7 @@ module Aws::Comprehend
|
|
967
999
|
# augmented_manifests: [
|
968
1000
|
# {
|
969
1001
|
# s3_uri: "S3Uri", # required
|
1002
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
970
1003
|
# attribute_names: ["AttributeNamesListItem"], # required
|
971
1004
|
# annotation_data_s3_uri: "S3Uri",
|
972
1005
|
# source_documents_s3_uri: "S3Uri",
|
@@ -1163,9 +1196,11 @@ module Aws::Comprehend
|
|
1163
1196
|
# resp.document_classifier_properties.training_end_time #=> Time
|
1164
1197
|
# resp.document_classifier_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
1165
1198
|
# resp.document_classifier_properties.input_data_config.s3_uri #=> String
|
1199
|
+
# resp.document_classifier_properties.input_data_config.test_s3_uri #=> String
|
1166
1200
|
# resp.document_classifier_properties.input_data_config.label_delimiter #=> String
|
1167
1201
|
# resp.document_classifier_properties.input_data_config.augmented_manifests #=> Array
|
1168
1202
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
|
1203
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
1169
1204
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1170
1205
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
1171
1206
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
@@ -1192,6 +1227,7 @@ module Aws::Comprehend
|
|
1192
1227
|
# resp.document_classifier_properties.vpc_config.subnets[0] #=> String
|
1193
1228
|
# resp.document_classifier_properties.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
1194
1229
|
# resp.document_classifier_properties.model_kms_key_id #=> String
|
1230
|
+
# resp.document_classifier_properties.version_name #=> String
|
1195
1231
|
#
|
1196
1232
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
|
1197
1233
|
#
|
@@ -1274,11 +1310,13 @@ module Aws::Comprehend
|
|
1274
1310
|
# resp.endpoint_properties.status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
|
1275
1311
|
# resp.endpoint_properties.message #=> String
|
1276
1312
|
# resp.endpoint_properties.model_arn #=> String
|
1313
|
+
# resp.endpoint_properties.desired_model_arn #=> String
|
1277
1314
|
# resp.endpoint_properties.desired_inference_units #=> Integer
|
1278
1315
|
# resp.endpoint_properties.current_inference_units #=> Integer
|
1279
1316
|
# resp.endpoint_properties.creation_time #=> Time
|
1280
1317
|
# resp.endpoint_properties.last_modified_time #=> Time
|
1281
1318
|
# resp.endpoint_properties.data_access_role_arn #=> String
|
1319
|
+
# resp.endpoint_properties.desired_data_access_role_arn #=> String
|
1282
1320
|
#
|
1283
1321
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
|
1284
1322
|
#
|
@@ -1372,10 +1410,14 @@ module Aws::Comprehend
|
|
1372
1410
|
# resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
|
1373
1411
|
# resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
|
1374
1412
|
# resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
|
1413
|
+
# resp.entity_recognizer_properties.input_data_config.documents.test_s3_uri #=> String
|
1414
|
+
# resp.entity_recognizer_properties.input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1375
1415
|
# resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
|
1416
|
+
# resp.entity_recognizer_properties.input_data_config.annotations.test_s3_uri #=> String
|
1376
1417
|
# resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
|
1377
1418
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests #=> Array
|
1378
1419
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
|
1420
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
1379
1421
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1380
1422
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
1381
1423
|
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
@@ -1399,6 +1441,7 @@ module Aws::Comprehend
|
|
1399
1441
|
# resp.entity_recognizer_properties.vpc_config.subnets #=> Array
|
1400
1442
|
# resp.entity_recognizer_properties.vpc_config.subnets[0] #=> String
|
1401
1443
|
# resp.entity_recognizer_properties.model_kms_key_id #=> String
|
1444
|
+
# resp.entity_recognizer_properties.version_name #=> String
|
1402
1445
|
#
|
1403
1446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
|
1404
1447
|
#
|
@@ -1983,6 +2026,49 @@ module Aws::Comprehend
|
|
1983
2026
|
req.send_request(options)
|
1984
2027
|
end
|
1985
2028
|
|
2029
|
+
# Gets a list of summaries of the document classifiers that you have
|
2030
|
+
# created
|
2031
|
+
#
|
2032
|
+
# @option params [String] :next_token
|
2033
|
+
# Identifies the next page of results to return.
|
2034
|
+
#
|
2035
|
+
# @option params [Integer] :max_results
|
2036
|
+
# The maximum number of results to return on each page. The default is
|
2037
|
+
# 100.
|
2038
|
+
#
|
2039
|
+
# @return [Types::ListDocumentClassifierSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2040
|
+
#
|
2041
|
+
# * {Types::ListDocumentClassifierSummariesResponse#document_classifier_summaries_list #document_classifier_summaries_list} => Array<Types::DocumentClassifierSummary>
|
2042
|
+
# * {Types::ListDocumentClassifierSummariesResponse#next_token #next_token} => String
|
2043
|
+
#
|
2044
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2045
|
+
#
|
2046
|
+
# @example Request syntax with placeholder values
|
2047
|
+
#
|
2048
|
+
# resp = client.list_document_classifier_summaries({
|
2049
|
+
# next_token: "String",
|
2050
|
+
# max_results: 1,
|
2051
|
+
# })
|
2052
|
+
#
|
2053
|
+
# @example Response structure
|
2054
|
+
#
|
2055
|
+
# resp.document_classifier_summaries_list #=> Array
|
2056
|
+
# resp.document_classifier_summaries_list[0].document_classifier_name #=> String
|
2057
|
+
# resp.document_classifier_summaries_list[0].number_of_versions #=> Integer
|
2058
|
+
# resp.document_classifier_summaries_list[0].latest_version_created_at #=> Time
|
2059
|
+
# resp.document_classifier_summaries_list[0].latest_version_name #=> String
|
2060
|
+
# resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
2061
|
+
# resp.next_token #=> String
|
2062
|
+
#
|
2063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries AWS API Documentation
|
2064
|
+
#
|
2065
|
+
# @overload list_document_classifier_summaries(params = {})
|
2066
|
+
# @param [Hash] params ({})
|
2067
|
+
def list_document_classifier_summaries(params = {}, options = {})
|
2068
|
+
req = build_request(:list_document_classifier_summaries, params)
|
2069
|
+
req.send_request(options)
|
2070
|
+
end
|
2071
|
+
|
1986
2072
|
# Gets a list of the document classifiers that you have created.
|
1987
2073
|
#
|
1988
2074
|
# @option params [Types::DocumentClassifierFilter] :filter
|
@@ -2009,6 +2095,7 @@ module Aws::Comprehend
|
|
2009
2095
|
# resp = client.list_document_classifiers({
|
2010
2096
|
# filter: {
|
2011
2097
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
2098
|
+
# document_classifier_name: "ComprehendArnName",
|
2012
2099
|
# submit_time_before: Time.now,
|
2013
2100
|
# submit_time_after: Time.now,
|
2014
2101
|
# },
|
@@ -2029,9 +2116,11 @@ module Aws::Comprehend
|
|
2029
2116
|
# resp.document_classifier_properties_list[0].training_end_time #=> Time
|
2030
2117
|
# resp.document_classifier_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
2031
2118
|
# resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
|
2119
|
+
# resp.document_classifier_properties_list[0].input_data_config.test_s3_uri #=> String
|
2032
2120
|
# resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
|
2033
2121
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
|
2034
2122
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
|
2123
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
2035
2124
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
|
2036
2125
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
2037
2126
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
@@ -2058,6 +2147,7 @@ module Aws::Comprehend
|
|
2058
2147
|
# resp.document_classifier_properties_list[0].vpc_config.subnets[0] #=> String
|
2059
2148
|
# resp.document_classifier_properties_list[0].mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
2060
2149
|
# resp.document_classifier_properties_list[0].model_kms_key_id #=> String
|
2150
|
+
# resp.document_classifier_properties_list[0].version_name #=> String
|
2061
2151
|
# resp.next_token #=> String
|
2062
2152
|
#
|
2063
2153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
|
@@ -2178,11 +2268,13 @@ module Aws::Comprehend
|
|
2178
2268
|
# resp.endpoint_properties_list[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "IN_SERVICE", "UPDATING"
|
2179
2269
|
# resp.endpoint_properties_list[0].message #=> String
|
2180
2270
|
# resp.endpoint_properties_list[0].model_arn #=> String
|
2271
|
+
# resp.endpoint_properties_list[0].desired_model_arn #=> String
|
2181
2272
|
# resp.endpoint_properties_list[0].desired_inference_units #=> Integer
|
2182
2273
|
# resp.endpoint_properties_list[0].current_inference_units #=> Integer
|
2183
2274
|
# resp.endpoint_properties_list[0].creation_time #=> Time
|
2184
2275
|
# resp.endpoint_properties_list[0].last_modified_time #=> Time
|
2185
2276
|
# resp.endpoint_properties_list[0].data_access_role_arn #=> String
|
2277
|
+
# resp.endpoint_properties_list[0].desired_data_access_role_arn #=> String
|
2186
2278
|
# resp.next_token #=> String
|
2187
2279
|
#
|
2188
2280
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
|
@@ -2265,6 +2357,49 @@ module Aws::Comprehend
|
|
2265
2357
|
req.send_request(options)
|
2266
2358
|
end
|
2267
2359
|
|
2360
|
+
# Gets a list of summaries for the entity recognizers that you have
|
2361
|
+
# created.
|
2362
|
+
#
|
2363
|
+
# @option params [String] :next_token
|
2364
|
+
# Identifies the next page of results to return.
|
2365
|
+
#
|
2366
|
+
# @option params [Integer] :max_results
|
2367
|
+
# The maximum number of results to return on each page. The default is
|
2368
|
+
# 100.
|
2369
|
+
#
|
2370
|
+
# @return [Types::ListEntityRecognizerSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2371
|
+
#
|
2372
|
+
# * {Types::ListEntityRecognizerSummariesResponse#entity_recognizer_summaries_list #entity_recognizer_summaries_list} => Array<Types::EntityRecognizerSummary>
|
2373
|
+
# * {Types::ListEntityRecognizerSummariesResponse#next_token #next_token} => String
|
2374
|
+
#
|
2375
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2376
|
+
#
|
2377
|
+
# @example Request syntax with placeholder values
|
2378
|
+
#
|
2379
|
+
# resp = client.list_entity_recognizer_summaries({
|
2380
|
+
# next_token: "String",
|
2381
|
+
# max_results: 1,
|
2382
|
+
# })
|
2383
|
+
#
|
2384
|
+
# @example Response structure
|
2385
|
+
#
|
2386
|
+
# resp.entity_recognizer_summaries_list #=> Array
|
2387
|
+
# resp.entity_recognizer_summaries_list[0].recognizer_name #=> String
|
2388
|
+
# resp.entity_recognizer_summaries_list[0].number_of_versions #=> Integer
|
2389
|
+
# resp.entity_recognizer_summaries_list[0].latest_version_created_at #=> Time
|
2390
|
+
# resp.entity_recognizer_summaries_list[0].latest_version_name #=> String
|
2391
|
+
# resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
2392
|
+
# resp.next_token #=> String
|
2393
|
+
#
|
2394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries AWS API Documentation
|
2395
|
+
#
|
2396
|
+
# @overload list_entity_recognizer_summaries(params = {})
|
2397
|
+
# @param [Hash] params ({})
|
2398
|
+
def list_entity_recognizer_summaries(params = {}, options = {})
|
2399
|
+
req = build_request(:list_entity_recognizer_summaries, params)
|
2400
|
+
req.send_request(options)
|
2401
|
+
end
|
2402
|
+
|
2268
2403
|
# Gets a list of the properties of all entity recognizers that you
|
2269
2404
|
# created, including recognizers currently in training. Allows you to
|
2270
2405
|
# filter the list of recognizers based on criteria such as status and
|
@@ -2298,6 +2433,7 @@ module Aws::Comprehend
|
|
2298
2433
|
# resp = client.list_entity_recognizers({
|
2299
2434
|
# filter: {
|
2300
2435
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
2436
|
+
# recognizer_name: "ComprehendArnName",
|
2301
2437
|
# submit_time_before: Time.now,
|
2302
2438
|
# submit_time_after: Time.now,
|
2303
2439
|
# },
|
@@ -2320,10 +2456,14 @@ module Aws::Comprehend
|
|
2320
2456
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
|
2321
2457
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
|
2322
2458
|
# resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
|
2459
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.documents.test_s3_uri #=> String
|
2460
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.documents.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2323
2461
|
# resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
|
2462
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.annotations.test_s3_uri #=> String
|
2324
2463
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
|
2325
2464
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
|
2326
2465
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
|
2466
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].split #=> String, one of "TRAIN", "TEST"
|
2327
2467
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
|
2328
2468
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
2329
2469
|
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].annotation_data_s3_uri #=> String
|
@@ -2347,6 +2487,7 @@ module Aws::Comprehend
|
|
2347
2487
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets #=> Array
|
2348
2488
|
# resp.entity_recognizer_properties_list[0].vpc_config.subnets[0] #=> String
|
2349
2489
|
# resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
|
2490
|
+
# resp.entity_recognizer_properties_list[0].version_name #=> String
|
2350
2491
|
# resp.next_token #=> String
|
2351
2492
|
#
|
2352
2493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
|
@@ -3967,18 +4108,27 @@ module Aws::Comprehend
|
|
3967
4108
|
# @option params [required, String] :endpoint_arn
|
3968
4109
|
# The Amazon Resource Number (ARN) of the endpoint being updated.
|
3969
4110
|
#
|
3970
|
-
# @option params [
|
4111
|
+
# @option params [String] :desired_model_arn
|
4112
|
+
# The ARN of the new model to use when updating an existing endpoint.
|
4113
|
+
#
|
4114
|
+
# @option params [Integer] :desired_inference_units
|
3971
4115
|
# The desired number of inference units to be used by the model using
|
3972
4116
|
# this endpoint. Each inference unit represents of a throughput of 100
|
3973
4117
|
# characters per second.
|
3974
4118
|
#
|
4119
|
+
# @option params [String] :desired_data_access_role_arn
|
4120
|
+
# Data access role ARN to use in case the new model is encrypted with a
|
4121
|
+
# customer CMK.
|
4122
|
+
#
|
3975
4123
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3976
4124
|
#
|
3977
4125
|
# @example Request syntax with placeholder values
|
3978
4126
|
#
|
3979
4127
|
# resp = client.update_endpoint({
|
3980
4128
|
# endpoint_arn: "ComprehendEndpointArn", # required
|
3981
|
-
#
|
4129
|
+
# desired_model_arn: "ComprehendModelArn",
|
4130
|
+
# desired_inference_units: 1,
|
4131
|
+
# desired_data_access_role_arn: "IamRoleArn",
|
3982
4132
|
# })
|
3983
4133
|
#
|
3984
4134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint AWS API Documentation
|
@@ -4003,7 +4153,7 @@ module Aws::Comprehend
|
|
4003
4153
|
params: params,
|
4004
4154
|
config: config)
|
4005
4155
|
context[:gem_name] = 'aws-sdk-comprehend'
|
4006
|
-
context[:gem_version] = '1.
|
4156
|
+
context[:gem_version] = '1.55.0'
|
4007
4157
|
Seahorse::Client::Request.new(handlers, context)
|
4008
4158
|
end
|
4009
4159
|
|
@@ -111,6 +111,8 @@ module Aws::Comprehend
|
|
111
111
|
DocumentClassifierOutputDataConfig = Shapes::StructureShape.new(name: 'DocumentClassifierOutputDataConfig')
|
112
112
|
DocumentClassifierProperties = Shapes::StructureShape.new(name: 'DocumentClassifierProperties')
|
113
113
|
DocumentClassifierPropertiesList = Shapes::ListShape.new(name: 'DocumentClassifierPropertiesList')
|
114
|
+
DocumentClassifierSummariesList = Shapes::ListShape.new(name: 'DocumentClassifierSummariesList')
|
115
|
+
DocumentClassifierSummary = Shapes::StructureShape.new(name: 'DocumentClassifierSummary')
|
114
116
|
DocumentLabel = Shapes::StructureShape.new(name: 'DocumentLabel')
|
115
117
|
DocumentReadAction = Shapes::StringShape.new(name: 'DocumentReadAction')
|
116
118
|
DocumentReadFeatureTypes = Shapes::StringShape.new(name: 'DocumentReadFeatureTypes')
|
@@ -145,6 +147,8 @@ module Aws::Comprehend
|
|
145
147
|
EntityRecognizerMetadataEntityTypesListItem = Shapes::StructureShape.new(name: 'EntityRecognizerMetadataEntityTypesListItem')
|
146
148
|
EntityRecognizerProperties = Shapes::StructureShape.new(name: 'EntityRecognizerProperties')
|
147
149
|
EntityRecognizerPropertiesList = Shapes::ListShape.new(name: 'EntityRecognizerPropertiesList')
|
150
|
+
EntityRecognizerSummariesList = Shapes::ListShape.new(name: 'EntityRecognizerSummariesList')
|
151
|
+
EntityRecognizerSummary = Shapes::StructureShape.new(name: 'EntityRecognizerSummary')
|
148
152
|
EntityType = Shapes::StringShape.new(name: 'EntityType')
|
149
153
|
EntityTypeName = Shapes::StringShape.new(name: 'EntityTypeName')
|
150
154
|
EntityTypesEvaluationMetrics = Shapes::StructureShape.new(name: 'EntityTypesEvaluationMetrics')
|
@@ -177,6 +181,8 @@ module Aws::Comprehend
|
|
177
181
|
LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
|
178
182
|
ListDocumentClassificationJobsRequest = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsRequest')
|
179
183
|
ListDocumentClassificationJobsResponse = Shapes::StructureShape.new(name: 'ListDocumentClassificationJobsResponse')
|
184
|
+
ListDocumentClassifierSummariesRequest = Shapes::StructureShape.new(name: 'ListDocumentClassifierSummariesRequest')
|
185
|
+
ListDocumentClassifierSummariesResponse = Shapes::StructureShape.new(name: 'ListDocumentClassifierSummariesResponse')
|
180
186
|
ListDocumentClassifiersRequest = Shapes::StructureShape.new(name: 'ListDocumentClassifiersRequest')
|
181
187
|
ListDocumentClassifiersResponse = Shapes::StructureShape.new(name: 'ListDocumentClassifiersResponse')
|
182
188
|
ListDominantLanguageDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListDominantLanguageDetectionJobsRequest')
|
@@ -185,6 +191,8 @@ module Aws::Comprehend
|
|
185
191
|
ListEndpointsResponse = Shapes::StructureShape.new(name: 'ListEndpointsResponse')
|
186
192
|
ListEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListEntitiesDetectionJobsRequest')
|
187
193
|
ListEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListEntitiesDetectionJobsResponse')
|
194
|
+
ListEntityRecognizerSummariesRequest = Shapes::StructureShape.new(name: 'ListEntityRecognizerSummariesRequest')
|
195
|
+
ListEntityRecognizerSummariesResponse = Shapes::StructureShape.new(name: 'ListEntityRecognizerSummariesResponse')
|
188
196
|
ListEntityRecognizersRequest = Shapes::StructureShape.new(name: 'ListEntityRecognizersRequest')
|
189
197
|
ListEntityRecognizersResponse = Shapes::StructureShape.new(name: 'ListEntityRecognizersResponse')
|
190
198
|
ListEventsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListEventsDetectionJobsRequest')
|
@@ -242,6 +250,7 @@ module Aws::Comprehend
|
|
242
250
|
SentimentDetectionJobPropertiesList = Shapes::ListShape.new(name: 'SentimentDetectionJobPropertiesList')
|
243
251
|
SentimentScore = Shapes::StructureShape.new(name: 'SentimentScore')
|
244
252
|
SentimentType = Shapes::StringShape.new(name: 'SentimentType')
|
253
|
+
Split = Shapes::StringShape.new(name: 'Split')
|
245
254
|
StartDocumentClassificationJobRequest = Shapes::StructureShape.new(name: 'StartDocumentClassificationJobRequest')
|
246
255
|
StartDocumentClassificationJobResponse = Shapes::StructureShape.new(name: 'StartDocumentClassificationJobResponse')
|
247
256
|
StartDominantLanguageDetectionJobRequest = Shapes::StructureShape.new(name: 'StartDominantLanguageDetectionJobRequest')
|
@@ -300,11 +309,13 @@ module Aws::Comprehend
|
|
300
309
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
301
310
|
UpdateEndpointRequest = Shapes::StructureShape.new(name: 'UpdateEndpointRequest')
|
302
311
|
UpdateEndpointResponse = Shapes::StructureShape.new(name: 'UpdateEndpointResponse')
|
312
|
+
VersionName = Shapes::StringShape.new(name: 'VersionName')
|
303
313
|
VpcConfig = Shapes::StructureShape.new(name: 'VpcConfig')
|
304
314
|
|
305
315
|
AttributeNamesList.member = Shapes::ShapeRef.new(shape: AttributeNamesListItem)
|
306
316
|
|
307
317
|
AugmentedManifestsListItem.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
318
|
+
AugmentedManifestsListItem.add_member(:split, Shapes::ShapeRef.new(shape: Split, location_name: "Split"))
|
308
319
|
AugmentedManifestsListItem.add_member(:attribute_names, Shapes::ShapeRef.new(shape: AttributeNamesList, required: true, location_name: "AttributeNames"))
|
309
320
|
AugmentedManifestsListItem.add_member(:annotation_data_s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "AnnotationDataS3Uri"))
|
310
321
|
AugmentedManifestsListItem.add_member(:source_documents_s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "SourceDocumentsS3Uri"))
|
@@ -416,6 +427,7 @@ module Aws::Comprehend
|
|
416
427
|
ContainsPiiEntitiesResponse.struct_class = Types::ContainsPiiEntitiesResponse
|
417
428
|
|
418
429
|
CreateDocumentClassifierRequest.add_member(:document_classifier_name, Shapes::ShapeRef.new(shape: ComprehendArnName, required: true, location_name: "DocumentClassifierName"))
|
430
|
+
CreateDocumentClassifierRequest.add_member(:version_name, Shapes::ShapeRef.new(shape: VersionName, location_name: "VersionName"))
|
419
431
|
CreateDocumentClassifierRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
420
432
|
CreateDocumentClassifierRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
421
433
|
CreateDocumentClassifierRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: DocumentClassifierInputDataConfig, required: true, location_name: "InputDataConfig"))
|
@@ -443,6 +455,7 @@ module Aws::Comprehend
|
|
443
455
|
CreateEndpointResponse.struct_class = Types::CreateEndpointResponse
|
444
456
|
|
445
457
|
CreateEntityRecognizerRequest.add_member(:recognizer_name, Shapes::ShapeRef.new(shape: ComprehendArnName, required: true, location_name: "RecognizerName"))
|
458
|
+
CreateEntityRecognizerRequest.add_member(:version_name, Shapes::ShapeRef.new(shape: VersionName, location_name: "VersionName"))
|
446
459
|
CreateEntityRecognizerRequest.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "DataAccessRoleArn"))
|
447
460
|
CreateEntityRecognizerRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
448
461
|
CreateEntityRecognizerRequest.add_member(:input_data_config, Shapes::ShapeRef.new(shape: EntityRecognizerInputDataConfig, required: true, location_name: "InputDataConfig"))
|
@@ -612,12 +625,14 @@ module Aws::Comprehend
|
|
612
625
|
DocumentClassifierAugmentedManifestsList.member = Shapes::ShapeRef.new(shape: AugmentedManifestsListItem)
|
613
626
|
|
614
627
|
DocumentClassifierFilter.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
628
|
+
DocumentClassifierFilter.add_member(:document_classifier_name, Shapes::ShapeRef.new(shape: ComprehendArnName, location_name: "DocumentClassifierName"))
|
615
629
|
DocumentClassifierFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
616
630
|
DocumentClassifierFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
617
631
|
DocumentClassifierFilter.struct_class = Types::DocumentClassifierFilter
|
618
632
|
|
619
633
|
DocumentClassifierInputDataConfig.add_member(:data_format, Shapes::ShapeRef.new(shape: DocumentClassifierDataFormat, location_name: "DataFormat"))
|
620
634
|
DocumentClassifierInputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "S3Uri"))
|
635
|
+
DocumentClassifierInputDataConfig.add_member(:test_s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "TestS3Uri"))
|
621
636
|
DocumentClassifierInputDataConfig.add_member(:label_delimiter, Shapes::ShapeRef.new(shape: LabelDelimiter, location_name: "LabelDelimiter"))
|
622
637
|
DocumentClassifierInputDataConfig.add_member(:augmented_manifests, Shapes::ShapeRef.new(shape: DocumentClassifierAugmentedManifestsList, location_name: "AugmentedManifests"))
|
623
638
|
DocumentClassifierInputDataConfig.struct_class = Types::DocumentClassifierInputDataConfig
|
@@ -642,10 +657,20 @@ module Aws::Comprehend
|
|
642
657
|
DocumentClassifierProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
643
658
|
DocumentClassifierProperties.add_member(:mode, Shapes::ShapeRef.new(shape: DocumentClassifierMode, location_name: "Mode"))
|
644
659
|
DocumentClassifierProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
660
|
+
DocumentClassifierProperties.add_member(:version_name, Shapes::ShapeRef.new(shape: VersionName, location_name: "VersionName"))
|
645
661
|
DocumentClassifierProperties.struct_class = Types::DocumentClassifierProperties
|
646
662
|
|
647
663
|
DocumentClassifierPropertiesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierProperties)
|
648
664
|
|
665
|
+
DocumentClassifierSummariesList.member = Shapes::ShapeRef.new(shape: DocumentClassifierSummary)
|
666
|
+
|
667
|
+
DocumentClassifierSummary.add_member(:document_classifier_name, Shapes::ShapeRef.new(shape: ComprehendArnName, location_name: "DocumentClassifierName"))
|
668
|
+
DocumentClassifierSummary.add_member(:number_of_versions, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfVersions"))
|
669
|
+
DocumentClassifierSummary.add_member(:latest_version_created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LatestVersionCreatedAt"))
|
670
|
+
DocumentClassifierSummary.add_member(:latest_version_name, Shapes::ShapeRef.new(shape: VersionName, location_name: "LatestVersionName"))
|
671
|
+
DocumentClassifierSummary.add_member(:latest_version_status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "LatestVersionStatus"))
|
672
|
+
DocumentClassifierSummary.struct_class = Types::DocumentClassifierSummary
|
673
|
+
|
649
674
|
DocumentLabel.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
|
650
675
|
DocumentLabel.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
651
676
|
DocumentLabel.struct_class = Types::DocumentLabel
|
@@ -691,11 +716,13 @@ module Aws::Comprehend
|
|
691
716
|
EndpointProperties.add_member(:status, Shapes::ShapeRef.new(shape: EndpointStatus, location_name: "Status"))
|
692
717
|
EndpointProperties.add_member(:message, Shapes::ShapeRef.new(shape: AnyLengthString, location_name: "Message"))
|
693
718
|
EndpointProperties.add_member(:model_arn, Shapes::ShapeRef.new(shape: ComprehendModelArn, location_name: "ModelArn"))
|
719
|
+
EndpointProperties.add_member(:desired_model_arn, Shapes::ShapeRef.new(shape: ComprehendModelArn, location_name: "DesiredModelArn"))
|
694
720
|
EndpointProperties.add_member(:desired_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, location_name: "DesiredInferenceUnits"))
|
695
721
|
EndpointProperties.add_member(:current_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, location_name: "CurrentInferenceUnits"))
|
696
722
|
EndpointProperties.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
697
723
|
EndpointProperties.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModifiedTime"))
|
698
724
|
EndpointProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
725
|
+
EndpointProperties.add_member(:desired_data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DesiredDataAccessRoleArn"))
|
699
726
|
EndpointProperties.struct_class = Types::EndpointProperties
|
700
727
|
|
701
728
|
EndpointPropertiesList.member = Shapes::ShapeRef.new(shape: EndpointProperties)
|
@@ -736,11 +763,14 @@ module Aws::Comprehend
|
|
736
763
|
EntityLabel.struct_class = Types::EntityLabel
|
737
764
|
|
738
765
|
EntityRecognizerAnnotations.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
766
|
+
EntityRecognizerAnnotations.add_member(:test_s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "TestS3Uri"))
|
739
767
|
EntityRecognizerAnnotations.struct_class = Types::EntityRecognizerAnnotations
|
740
768
|
|
741
769
|
EntityRecognizerAugmentedManifestsList.member = Shapes::ShapeRef.new(shape: AugmentedManifestsListItem)
|
742
770
|
|
743
771
|
EntityRecognizerDocuments.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
772
|
+
EntityRecognizerDocuments.add_member(:test_s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "TestS3Uri"))
|
773
|
+
EntityRecognizerDocuments.add_member(:input_format, Shapes::ShapeRef.new(shape: InputFormat, location_name: "InputFormat"))
|
744
774
|
EntityRecognizerDocuments.struct_class = Types::EntityRecognizerDocuments
|
745
775
|
|
746
776
|
EntityRecognizerEntityList.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
@@ -752,6 +782,7 @@ module Aws::Comprehend
|
|
752
782
|
EntityRecognizerEvaluationMetrics.struct_class = Types::EntityRecognizerEvaluationMetrics
|
753
783
|
|
754
784
|
EntityRecognizerFilter.add_member(:status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "Status"))
|
785
|
+
EntityRecognizerFilter.add_member(:recognizer_name, Shapes::ShapeRef.new(shape: ComprehendArnName, location_name: "RecognizerName"))
|
755
786
|
EntityRecognizerFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
756
787
|
EntityRecognizerFilter.add_member(:submit_time_after, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeAfter"))
|
757
788
|
EntityRecognizerFilter.struct_class = Types::EntityRecognizerFilter
|
@@ -791,10 +822,20 @@ module Aws::Comprehend
|
|
791
822
|
EntityRecognizerProperties.add_member(:volume_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "VolumeKmsKeyId"))
|
792
823
|
EntityRecognizerProperties.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfig, location_name: "VpcConfig"))
|
793
824
|
EntityRecognizerProperties.add_member(:model_kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "ModelKmsKeyId"))
|
825
|
+
EntityRecognizerProperties.add_member(:version_name, Shapes::ShapeRef.new(shape: VersionName, location_name: "VersionName"))
|
794
826
|
EntityRecognizerProperties.struct_class = Types::EntityRecognizerProperties
|
795
827
|
|
796
828
|
EntityRecognizerPropertiesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerProperties)
|
797
829
|
|
830
|
+
EntityRecognizerSummariesList.member = Shapes::ShapeRef.new(shape: EntityRecognizerSummary)
|
831
|
+
|
832
|
+
EntityRecognizerSummary.add_member(:recognizer_name, Shapes::ShapeRef.new(shape: ComprehendArnName, location_name: "RecognizerName"))
|
833
|
+
EntityRecognizerSummary.add_member(:number_of_versions, Shapes::ShapeRef.new(shape: Integer, location_name: "NumberOfVersions"))
|
834
|
+
EntityRecognizerSummary.add_member(:latest_version_created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LatestVersionCreatedAt"))
|
835
|
+
EntityRecognizerSummary.add_member(:latest_version_name, Shapes::ShapeRef.new(shape: VersionName, location_name: "LatestVersionName"))
|
836
|
+
EntityRecognizerSummary.add_member(:latest_version_status, Shapes::ShapeRef.new(shape: ModelStatus, location_name: "LatestVersionStatus"))
|
837
|
+
EntityRecognizerSummary.struct_class = Types::EntityRecognizerSummary
|
838
|
+
|
798
839
|
EntityTypesEvaluationMetrics.add_member(:precision, Shapes::ShapeRef.new(shape: Double, location_name: "Precision"))
|
799
840
|
EntityTypesEvaluationMetrics.add_member(:recall, Shapes::ShapeRef.new(shape: Double, location_name: "Recall"))
|
800
841
|
EntityTypesEvaluationMetrics.add_member(:f1_score, Shapes::ShapeRef.new(shape: Double, location_name: "F1Score"))
|
@@ -885,6 +926,14 @@ module Aws::Comprehend
|
|
885
926
|
ListDocumentClassificationJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
886
927
|
ListDocumentClassificationJobsResponse.struct_class = Types::ListDocumentClassificationJobsResponse
|
887
928
|
|
929
|
+
ListDocumentClassifierSummariesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
930
|
+
ListDocumentClassifierSummariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
931
|
+
ListDocumentClassifierSummariesRequest.struct_class = Types::ListDocumentClassifierSummariesRequest
|
932
|
+
|
933
|
+
ListDocumentClassifierSummariesResponse.add_member(:document_classifier_summaries_list, Shapes::ShapeRef.new(shape: DocumentClassifierSummariesList, location_name: "DocumentClassifierSummariesList"))
|
934
|
+
ListDocumentClassifierSummariesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
935
|
+
ListDocumentClassifierSummariesResponse.struct_class = Types::ListDocumentClassifierSummariesResponse
|
936
|
+
|
888
937
|
ListDocumentClassifiersRequest.add_member(:filter, Shapes::ShapeRef.new(shape: DocumentClassifierFilter, location_name: "Filter"))
|
889
938
|
ListDocumentClassifiersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
890
939
|
ListDocumentClassifiersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -921,6 +970,14 @@ module Aws::Comprehend
|
|
921
970
|
ListEntitiesDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
922
971
|
ListEntitiesDetectionJobsResponse.struct_class = Types::ListEntitiesDetectionJobsResponse
|
923
972
|
|
973
|
+
ListEntityRecognizerSummariesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
974
|
+
ListEntityRecognizerSummariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
975
|
+
ListEntityRecognizerSummariesRequest.struct_class = Types::ListEntityRecognizerSummariesRequest
|
976
|
+
|
977
|
+
ListEntityRecognizerSummariesResponse.add_member(:entity_recognizer_summaries_list, Shapes::ShapeRef.new(shape: EntityRecognizerSummariesList, location_name: "EntityRecognizerSummariesList"))
|
978
|
+
ListEntityRecognizerSummariesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
979
|
+
ListEntityRecognizerSummariesResponse.struct_class = Types::ListEntityRecognizerSummariesResponse
|
980
|
+
|
924
981
|
ListEntityRecognizersRequest.add_member(:filter, Shapes::ShapeRef.new(shape: EntityRecognizerFilter, location_name: "Filter"))
|
925
982
|
ListEntityRecognizersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
926
983
|
ListEntityRecognizersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -1350,7 +1407,9 @@ module Aws::Comprehend
|
|
1350
1407
|
UntagResourceResponse.struct_class = Types::UntagResourceResponse
|
1351
1408
|
|
1352
1409
|
UpdateEndpointRequest.add_member(:endpoint_arn, Shapes::ShapeRef.new(shape: ComprehendEndpointArn, required: true, location_name: "EndpointArn"))
|
1353
|
-
UpdateEndpointRequest.add_member(:
|
1410
|
+
UpdateEndpointRequest.add_member(:desired_model_arn, Shapes::ShapeRef.new(shape: ComprehendModelArn, location_name: "DesiredModelArn"))
|
1411
|
+
UpdateEndpointRequest.add_member(:desired_inference_units, Shapes::ShapeRef.new(shape: InferenceUnitsInteger, location_name: "DesiredInferenceUnits"))
|
1412
|
+
UpdateEndpointRequest.add_member(:desired_data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DesiredDataAccessRoleArn"))
|
1354
1413
|
UpdateEndpointRequest.struct_class = Types::UpdateEndpointRequest
|
1355
1414
|
|
1356
1415
|
UpdateEndpointResponse.struct_class = Types::UpdateEndpointResponse
|
@@ -1777,6 +1836,23 @@ module Aws::Comprehend
|
|
1777
1836
|
)
|
1778
1837
|
end)
|
1779
1838
|
|
1839
|
+
api.add_operation(:list_document_classifier_summaries, Seahorse::Model::Operation.new.tap do |o|
|
1840
|
+
o.name = "ListDocumentClassifierSummaries"
|
1841
|
+
o.http_method = "POST"
|
1842
|
+
o.http_request_uri = "/"
|
1843
|
+
o.input = Shapes::ShapeRef.new(shape: ListDocumentClassifierSummariesRequest)
|
1844
|
+
o.output = Shapes::ShapeRef.new(shape: ListDocumentClassifierSummariesResponse)
|
1845
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1846
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1847
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1848
|
+
o[:pager] = Aws::Pager.new(
|
1849
|
+
limit_key: "max_results",
|
1850
|
+
tokens: {
|
1851
|
+
"next_token" => "next_token"
|
1852
|
+
}
|
1853
|
+
)
|
1854
|
+
end)
|
1855
|
+
|
1780
1856
|
api.add_operation(:list_document_classifiers, Seahorse::Model::Operation.new.tap do |o|
|
1781
1857
|
o.name = "ListDocumentClassifiers"
|
1782
1858
|
o.http_method = "POST"
|
@@ -1842,6 +1918,23 @@ module Aws::Comprehend
|
|
1842
1918
|
)
|
1843
1919
|
end)
|
1844
1920
|
|
1921
|
+
api.add_operation(:list_entity_recognizer_summaries, Seahorse::Model::Operation.new.tap do |o|
|
1922
|
+
o.name = "ListEntityRecognizerSummaries"
|
1923
|
+
o.http_method = "POST"
|
1924
|
+
o.http_request_uri = "/"
|
1925
|
+
o.input = Shapes::ShapeRef.new(shape: ListEntityRecognizerSummariesRequest)
|
1926
|
+
o.output = Shapes::ShapeRef.new(shape: ListEntityRecognizerSummariesResponse)
|
1927
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1928
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
1929
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1930
|
+
o[:pager] = Aws::Pager.new(
|
1931
|
+
limit_key: "max_results",
|
1932
|
+
tokens: {
|
1933
|
+
"next_token" => "next_token"
|
1934
|
+
}
|
1935
|
+
)
|
1936
|
+
end)
|
1937
|
+
|
1845
1938
|
api.add_operation(:list_entity_recognizers, Seahorse::Model::Operation.new.tap do |o|
|
1846
1939
|
o.name = "ListEntityRecognizers"
|
1847
1940
|
o.http_method = "POST"
|
@@ -19,6 +19,7 @@ module Aws::Comprehend
|
|
19
19
|
#
|
20
20
|
# {
|
21
21
|
# s3_uri: "S3Uri", # required
|
22
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
22
23
|
# attribute_names: ["AttributeNamesListItem"], # required
|
23
24
|
# annotation_data_s3_uri: "S3Uri",
|
24
25
|
# source_documents_s3_uri: "S3Uri",
|
@@ -29,6 +30,20 @@ module Aws::Comprehend
|
|
29
30
|
# The Amazon S3 location of the augmented manifest file.
|
30
31
|
# @return [String]
|
31
32
|
#
|
33
|
+
# @!attribute [rw] split
|
34
|
+
# The purpose of the data you've provided in the augmented manifest.
|
35
|
+
# You can either train or test this data. If you don't specify, the
|
36
|
+
# default is train.
|
37
|
+
#
|
38
|
+
# TRAIN - all of the documents in the manifest will be used for
|
39
|
+
# training. If no test documents are provided, Amazon Comprehend will
|
40
|
+
# automatically reserve a portion of the training documents for
|
41
|
+
# testing.
|
42
|
+
#
|
43
|
+
# TEST - all of the documents in the manifest will be used for
|
44
|
+
# testing.
|
45
|
+
# @return [String]
|
46
|
+
#
|
32
47
|
# @!attribute [rw] attribute_names
|
33
48
|
# The JSON attribute that contains the annotations for your training
|
34
49
|
# documents. The number of attribute names that you specify depends on
|
@@ -73,6 +88,7 @@ module Aws::Comprehend
|
|
73
88
|
#
|
74
89
|
class AugmentedManifestsListItem < Struct.new(
|
75
90
|
:s3_uri,
|
91
|
+
:split,
|
76
92
|
:attribute_names,
|
77
93
|
:annotation_data_s3_uri,
|
78
94
|
:source_documents_s3_uri,
|
@@ -707,6 +723,7 @@ module Aws::Comprehend
|
|
707
723
|
#
|
708
724
|
# {
|
709
725
|
# document_classifier_name: "ComprehendArnName", # required
|
726
|
+
# version_name: "VersionName",
|
710
727
|
# data_access_role_arn: "IamRoleArn", # required
|
711
728
|
# tags: [
|
712
729
|
# {
|
@@ -717,10 +734,12 @@ module Aws::Comprehend
|
|
717
734
|
# input_data_config: { # required
|
718
735
|
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
719
736
|
# s3_uri: "S3Uri",
|
737
|
+
# test_s3_uri: "S3Uri",
|
720
738
|
# label_delimiter: "LabelDelimiter",
|
721
739
|
# augmented_manifests: [
|
722
740
|
# {
|
723
741
|
# s3_uri: "S3Uri", # required
|
742
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
724
743
|
# attribute_names: ["AttributeNamesListItem"], # required
|
725
744
|
# annotation_data_s3_uri: "S3Uri",
|
726
745
|
# source_documents_s3_uri: "S3Uri",
|
@@ -747,6 +766,14 @@ module Aws::Comprehend
|
|
747
766
|
# The name of the document classifier.
|
748
767
|
# @return [String]
|
749
768
|
#
|
769
|
+
# @!attribute [rw] version_name
|
770
|
+
# The version name given to the newly created classifier. Version
|
771
|
+
# names can have a maximum of 256 characters. Alphanumeric characters,
|
772
|
+
# hyphens (-) and underscores (\_) are allowed. The version name must
|
773
|
+
# be unique among all models with the same classifier name in the
|
774
|
+
# account/AWS Region.
|
775
|
+
# @return [String]
|
776
|
+
#
|
750
777
|
# @!attribute [rw] data_access_role_arn
|
751
778
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
752
779
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -832,6 +859,7 @@ module Aws::Comprehend
|
|
832
859
|
#
|
833
860
|
class CreateDocumentClassifierRequest < Struct.new(
|
834
861
|
:document_classifier_name,
|
862
|
+
:version_name,
|
835
863
|
:data_access_role_arn,
|
836
864
|
:tags,
|
837
865
|
:input_data_config,
|
@@ -945,6 +973,7 @@ module Aws::Comprehend
|
|
945
973
|
#
|
946
974
|
# {
|
947
975
|
# recognizer_name: "ComprehendArnName", # required
|
976
|
+
# version_name: "VersionName",
|
948
977
|
# data_access_role_arn: "IamRoleArn", # required
|
949
978
|
# tags: [
|
950
979
|
# {
|
@@ -961,9 +990,12 @@ module Aws::Comprehend
|
|
961
990
|
# ],
|
962
991
|
# documents: {
|
963
992
|
# s3_uri: "S3Uri", # required
|
993
|
+
# test_s3_uri: "S3Uri",
|
994
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
964
995
|
# },
|
965
996
|
# annotations: {
|
966
997
|
# s3_uri: "S3Uri", # required
|
998
|
+
# test_s3_uri: "S3Uri",
|
967
999
|
# },
|
968
1000
|
# entity_list: {
|
969
1001
|
# s3_uri: "S3Uri", # required
|
@@ -971,6 +1003,7 @@ module Aws::Comprehend
|
|
971
1003
|
# augmented_manifests: [
|
972
1004
|
# {
|
973
1005
|
# s3_uri: "S3Uri", # required
|
1006
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
974
1007
|
# attribute_names: ["AttributeNamesListItem"], # required
|
975
1008
|
# annotation_data_s3_uri: "S3Uri",
|
976
1009
|
# source_documents_s3_uri: "S3Uri",
|
@@ -995,6 +1028,14 @@ module Aws::Comprehend
|
|
995
1028
|
# account/region.
|
996
1029
|
# @return [String]
|
997
1030
|
#
|
1031
|
+
# @!attribute [rw] version_name
|
1032
|
+
# The version name given to the newly created recognizer. Version
|
1033
|
+
# names can be a maximum of 256 characters. Alphanumeric characters,
|
1034
|
+
# hyphens (-) and underscores (\_) are allowed. The version name must
|
1035
|
+
# be unique among all models with the same recognizer name in the
|
1036
|
+
# account/ AWS Region.
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
998
1039
|
# @!attribute [rw] data_access_role_arn
|
999
1040
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
1000
1041
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -1067,6 +1108,7 @@ module Aws::Comprehend
|
|
1067
1108
|
#
|
1068
1109
|
class CreateEntityRecognizerRequest < Struct.new(
|
1069
1110
|
:recognizer_name,
|
1111
|
+
:version_name,
|
1070
1112
|
:data_access_role_arn,
|
1071
1113
|
:tags,
|
1072
1114
|
:input_data_config,
|
@@ -1984,6 +2026,7 @@ module Aws::Comprehend
|
|
1984
2026
|
#
|
1985
2027
|
# {
|
1986
2028
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
2029
|
+
# document_classifier_name: "ComprehendArnName",
|
1987
2030
|
# submit_time_before: Time.now,
|
1988
2031
|
# submit_time_after: Time.now,
|
1989
2032
|
# }
|
@@ -1992,6 +2035,10 @@ module Aws::Comprehend
|
|
1992
2035
|
# Filters the list of classifiers based on status.
|
1993
2036
|
# @return [String]
|
1994
2037
|
#
|
2038
|
+
# @!attribute [rw] document_classifier_name
|
2039
|
+
# The name that you assigned to the document classifier
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
1995
2042
|
# @!attribute [rw] submit_time_before
|
1996
2043
|
# Filters the list of classifiers based on the time that the
|
1997
2044
|
# classifier was submitted for processing. Returns only classifiers
|
@@ -2010,6 +2057,7 @@ module Aws::Comprehend
|
|
2010
2057
|
#
|
2011
2058
|
class DocumentClassifierFilter < Struct.new(
|
2012
2059
|
:status,
|
2060
|
+
:document_classifier_name,
|
2013
2061
|
:submit_time_before,
|
2014
2062
|
:submit_time_after)
|
2015
2063
|
SENSITIVE = []
|
@@ -2027,10 +2075,12 @@ module Aws::Comprehend
|
|
2027
2075
|
# {
|
2028
2076
|
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
2029
2077
|
# s3_uri: "S3Uri",
|
2078
|
+
# test_s3_uri: "S3Uri",
|
2030
2079
|
# label_delimiter: "LabelDelimiter",
|
2031
2080
|
# augmented_manifests: [
|
2032
2081
|
# {
|
2033
2082
|
# s3_uri: "S3Uri", # required
|
2083
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
2034
2084
|
# attribute_names: ["AttributeNamesListItem"], # required
|
2035
2085
|
# annotation_data_s3_uri: "S3Uri",
|
2036
2086
|
# source_documents_s3_uri: "S3Uri",
|
@@ -2074,6 +2124,13 @@ module Aws::Comprehend
|
|
2074
2124
|
# `COMPREHEND_CSV`.
|
2075
2125
|
# @return [String]
|
2076
2126
|
#
|
2127
|
+
# @!attribute [rw] test_s3_uri
|
2128
|
+
# The Amazon S3 URI for the input data. The Amazon S3 bucket must be
|
2129
|
+
# in the same AWS Region as the API endpoint that you are calling. The
|
2130
|
+
# URI can point to a single input file or it can provide the prefix
|
2131
|
+
# for a collection of input files.
|
2132
|
+
# @return [String]
|
2133
|
+
#
|
2077
2134
|
# @!attribute [rw] label_delimiter
|
2078
2135
|
# Indicates the delimiter used to separate each label for training a
|
2079
2136
|
# multi-label classifier. The default delimiter between labels is a
|
@@ -2098,6 +2155,7 @@ module Aws::Comprehend
|
|
2098
2155
|
class DocumentClassifierInputDataConfig < Struct.new(
|
2099
2156
|
:data_format,
|
2100
2157
|
:s3_uri,
|
2158
|
+
:test_s3_uri,
|
2101
2159
|
:label_delimiter,
|
2102
2160
|
:augmented_manifests)
|
2103
2161
|
SENSITIVE = []
|
@@ -2259,6 +2317,10 @@ module Aws::Comprehend
|
|
2259
2317
|
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2260
2318
|
# @return [String]
|
2261
2319
|
#
|
2320
|
+
# @!attribute [rw] version_name
|
2321
|
+
# The version name that you assigned to the document classifier.
|
2322
|
+
# @return [String]
|
2323
|
+
#
|
2262
2324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
|
2263
2325
|
#
|
2264
2326
|
class DocumentClassifierProperties < Struct.new(
|
@@ -2277,11 +2339,48 @@ module Aws::Comprehend
|
|
2277
2339
|
:volume_kms_key_id,
|
2278
2340
|
:vpc_config,
|
2279
2341
|
:mode,
|
2280
|
-
:model_kms_key_id
|
2342
|
+
:model_kms_key_id,
|
2343
|
+
:version_name)
|
2281
2344
|
SENSITIVE = [:classifier_metadata]
|
2282
2345
|
include Aws::Structure
|
2283
2346
|
end
|
2284
2347
|
|
2348
|
+
# Describes information about a document classifier and its versions.
|
2349
|
+
#
|
2350
|
+
# @!attribute [rw] document_classifier_name
|
2351
|
+
# The name that you assigned the document classifier.
|
2352
|
+
# @return [String]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] number_of_versions
|
2355
|
+
# The number of versions you created.
|
2356
|
+
# @return [Integer]
|
2357
|
+
#
|
2358
|
+
# @!attribute [rw] latest_version_created_at
|
2359
|
+
# The time that the latest document classifier version was submitted
|
2360
|
+
# for processing.
|
2361
|
+
# @return [Time]
|
2362
|
+
#
|
2363
|
+
# @!attribute [rw] latest_version_name
|
2364
|
+
# The version name you assigned to the latest document classifier
|
2365
|
+
# version.
|
2366
|
+
# @return [String]
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] latest_version_status
|
2369
|
+
# Provides the status of the latest document classifier version.
|
2370
|
+
# @return [String]
|
2371
|
+
#
|
2372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierSummary AWS API Documentation
|
2373
|
+
#
|
2374
|
+
class DocumentClassifierSummary < Struct.new(
|
2375
|
+
:document_classifier_name,
|
2376
|
+
:number_of_versions,
|
2377
|
+
:latest_version_created_at,
|
2378
|
+
:latest_version_name,
|
2379
|
+
:latest_version_status)
|
2380
|
+
SENSITIVE = []
|
2381
|
+
include Aws::Structure
|
2382
|
+
end
|
2383
|
+
|
2285
2384
|
# Specifies one of the label or labels that categorize the document
|
2286
2385
|
# being analyzed.
|
2287
2386
|
#
|
@@ -2588,6 +2687,12 @@ module Aws::Comprehend
|
|
2588
2687
|
# is attached.
|
2589
2688
|
# @return [String]
|
2590
2689
|
#
|
2690
|
+
# @!attribute [rw] desired_model_arn
|
2691
|
+
# ARN of the new model to use for updating an existing endpoint. This
|
2692
|
+
# ARN is going to be different from the model ARN when the update is
|
2693
|
+
# in progress
|
2694
|
+
# @return [String]
|
2695
|
+
#
|
2591
2696
|
# @!attribute [rw] desired_inference_units
|
2592
2697
|
# The desired number of inference units to be used by the model using
|
2593
2698
|
# this endpoint. Each inference unit represents of a throughput of 100
|
@@ -2614,6 +2719,11 @@ module Aws::Comprehend
|
|
2614
2719
|
# (ModelKmsKeyId).
|
2615
2720
|
# @return [String]
|
2616
2721
|
#
|
2722
|
+
# @!attribute [rw] desired_data_access_role_arn
|
2723
|
+
# Data access role ARN to use in case the new model is encrypted with
|
2724
|
+
# a customer KMS key.
|
2725
|
+
# @return [String]
|
2726
|
+
#
|
2617
2727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
|
2618
2728
|
#
|
2619
2729
|
class EndpointProperties < Struct.new(
|
@@ -2621,11 +2731,13 @@ module Aws::Comprehend
|
|
2621
2731
|
:status,
|
2622
2732
|
:message,
|
2623
2733
|
:model_arn,
|
2734
|
+
:desired_model_arn,
|
2624
2735
|
:desired_inference_units,
|
2625
2736
|
:current_inference_units,
|
2626
2737
|
:creation_time,
|
2627
2738
|
:last_modified_time,
|
2628
|
-
:data_access_role_arn
|
2739
|
+
:data_access_role_arn,
|
2740
|
+
:desired_data_access_role_arn)
|
2629
2741
|
SENSITIVE = []
|
2630
2742
|
include Aws::Structure
|
2631
2743
|
end
|
@@ -2857,6 +2969,7 @@ module Aws::Comprehend
|
|
2857
2969
|
#
|
2858
2970
|
# {
|
2859
2971
|
# s3_uri: "S3Uri", # required
|
2972
|
+
# test_s3_uri: "S3Uri",
|
2860
2973
|
# }
|
2861
2974
|
#
|
2862
2975
|
# @!attribute [rw] s3_uri
|
@@ -2865,10 +2978,17 @@ module Aws::Comprehend
|
|
2865
2978
|
# API endpoint that you are calling.
|
2866
2979
|
# @return [String]
|
2867
2980
|
#
|
2981
|
+
# @!attribute [rw] test_s3_uri
|
2982
|
+
# This specifies the Amazon S3 location where the test annotations for
|
2983
|
+
# an entity recognizer are located. The URI must be in the same AWS
|
2984
|
+
# Region as the API endpoint that you are calling.
|
2985
|
+
# @return [String]
|
2986
|
+
#
|
2868
2987
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerAnnotations AWS API Documentation
|
2869
2988
|
#
|
2870
2989
|
class EntityRecognizerAnnotations < Struct.new(
|
2871
|
-
:s3_uri
|
2990
|
+
:s3_uri,
|
2991
|
+
:test_s3_uri)
|
2872
2992
|
SENSITIVE = []
|
2873
2993
|
include Aws::Structure
|
2874
2994
|
end
|
@@ -2880,6 +3000,8 @@ module Aws::Comprehend
|
|
2880
3000
|
#
|
2881
3001
|
# {
|
2882
3002
|
# s3_uri: "S3Uri", # required
|
3003
|
+
# test_s3_uri: "S3Uri",
|
3004
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2883
3005
|
# }
|
2884
3006
|
#
|
2885
3007
|
# @!attribute [rw] s3_uri
|
@@ -2888,10 +3010,28 @@ module Aws::Comprehend
|
|
2888
3010
|
# the API endpoint that you are calling.
|
2889
3011
|
# @return [String]
|
2890
3012
|
#
|
3013
|
+
# @!attribute [rw] test_s3_uri
|
3014
|
+
# Specifies the Amazon S3 location where the test documents for an
|
3015
|
+
# entity recognizer are located. The URI must be in the same AWS
|
3016
|
+
# Region as the API endpoint that you are calling.
|
3017
|
+
# @return [String]
|
3018
|
+
#
|
3019
|
+
# @!attribute [rw] input_format
|
3020
|
+
# Specifies how the text in an input file should be processed. This is
|
3021
|
+
# optional, and the default is ONE\_DOC\_PER\_LINE.
|
3022
|
+
# ONE\_DOC\_PER\_FILE - Each file is considered a separate document.
|
3023
|
+
# Use this option when you are processing large documents, such as
|
3024
|
+
# newspaper articles or scientific papers. ONE\_DOC\_PER\_LINE - Each
|
3025
|
+
# line in a file is considered a separate document. Use this option
|
3026
|
+
# when you are processing many short documents, such as text messages.
|
3027
|
+
# @return [String]
|
3028
|
+
#
|
2891
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerDocuments AWS API Documentation
|
2892
3030
|
#
|
2893
3031
|
class EntityRecognizerDocuments < Struct.new(
|
2894
|
-
:s3_uri
|
3032
|
+
:s3_uri,
|
3033
|
+
:test_s3_uri,
|
3034
|
+
:input_format)
|
2895
3035
|
SENSITIVE = []
|
2896
3036
|
include Aws::Structure
|
2897
3037
|
end
|
@@ -2959,6 +3099,7 @@ module Aws::Comprehend
|
|
2959
3099
|
#
|
2960
3100
|
# {
|
2961
3101
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
3102
|
+
# recognizer_name: "ComprehendArnName",
|
2962
3103
|
# submit_time_before: Time.now,
|
2963
3104
|
# submit_time_after: Time.now,
|
2964
3105
|
# }
|
@@ -2967,6 +3108,10 @@ module Aws::Comprehend
|
|
2967
3108
|
# The status of an entity recognizer.
|
2968
3109
|
# @return [String]
|
2969
3110
|
#
|
3111
|
+
# @!attribute [rw] recognizer_name
|
3112
|
+
# The name that you assigned the entity recognizer.
|
3113
|
+
# @return [String]
|
3114
|
+
#
|
2970
3115
|
# @!attribute [rw] submit_time_before
|
2971
3116
|
# Filters the list of entities based on the time that the list was
|
2972
3117
|
# submitted for processing. Returns only jobs submitted before the
|
@@ -2985,6 +3130,7 @@ module Aws::Comprehend
|
|
2985
3130
|
#
|
2986
3131
|
class EntityRecognizerFilter < Struct.new(
|
2987
3132
|
:status,
|
3133
|
+
:recognizer_name,
|
2988
3134
|
:submit_time_before,
|
2989
3135
|
:submit_time_after)
|
2990
3136
|
SENSITIVE = []
|
@@ -3005,9 +3151,12 @@ module Aws::Comprehend
|
|
3005
3151
|
# ],
|
3006
3152
|
# documents: {
|
3007
3153
|
# s3_uri: "S3Uri", # required
|
3154
|
+
# test_s3_uri: "S3Uri",
|
3155
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3008
3156
|
# },
|
3009
3157
|
# annotations: {
|
3010
3158
|
# s3_uri: "S3Uri", # required
|
3159
|
+
# test_s3_uri: "S3Uri",
|
3011
3160
|
# },
|
3012
3161
|
# entity_list: {
|
3013
3162
|
# s3_uri: "S3Uri", # required
|
@@ -3015,6 +3164,7 @@ module Aws::Comprehend
|
|
3015
3164
|
# augmented_manifests: [
|
3016
3165
|
# {
|
3017
3166
|
# s3_uri: "S3Uri", # required
|
3167
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
3018
3168
|
# attribute_names: ["AttributeNamesListItem"], # required
|
3019
3169
|
# annotation_data_s3_uri: "S3Uri",
|
3020
3170
|
# source_documents_s3_uri: "S3Uri",
|
@@ -3246,6 +3396,10 @@ module Aws::Comprehend
|
|
3246
3396
|
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3247
3397
|
# @return [String]
|
3248
3398
|
#
|
3399
|
+
# @!attribute [rw] version_name
|
3400
|
+
# The version name you assigned to the entity recognizer.
|
3401
|
+
# @return [String]
|
3402
|
+
#
|
3249
3403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
|
3250
3404
|
#
|
3251
3405
|
class EntityRecognizerProperties < Struct.new(
|
@@ -3262,11 +3416,48 @@ module Aws::Comprehend
|
|
3262
3416
|
:data_access_role_arn,
|
3263
3417
|
:volume_kms_key_id,
|
3264
3418
|
:vpc_config,
|
3265
|
-
:model_kms_key_id
|
3419
|
+
:model_kms_key_id,
|
3420
|
+
:version_name)
|
3266
3421
|
SENSITIVE = [:recognizer_metadata]
|
3267
3422
|
include Aws::Structure
|
3268
3423
|
end
|
3269
3424
|
|
3425
|
+
# Describes the information about an entity recognizer and its versions.
|
3426
|
+
#
|
3427
|
+
# @!attribute [rw] recognizer_name
|
3428
|
+
# The name that you assigned the entity recognizer.
|
3429
|
+
# @return [String]
|
3430
|
+
#
|
3431
|
+
# @!attribute [rw] number_of_versions
|
3432
|
+
# The number of versions you created.
|
3433
|
+
# @return [Integer]
|
3434
|
+
#
|
3435
|
+
# @!attribute [rw] latest_version_created_at
|
3436
|
+
# The time that the latest entity recognizer version was submitted for
|
3437
|
+
# processing.
|
3438
|
+
# @return [Time]
|
3439
|
+
#
|
3440
|
+
# @!attribute [rw] latest_version_name
|
3441
|
+
# The version name you assigned to the latest entity recognizer
|
3442
|
+
# version.
|
3443
|
+
# @return [String]
|
3444
|
+
#
|
3445
|
+
# @!attribute [rw] latest_version_status
|
3446
|
+
# Provides the status of the latest entity recognizer version.
|
3447
|
+
# @return [String]
|
3448
|
+
#
|
3449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerSummary AWS API Documentation
|
3450
|
+
#
|
3451
|
+
class EntityRecognizerSummary < Struct.new(
|
3452
|
+
:recognizer_name,
|
3453
|
+
:number_of_versions,
|
3454
|
+
:latest_version_created_at,
|
3455
|
+
:latest_version_name,
|
3456
|
+
:latest_version_status)
|
3457
|
+
SENSITIVE = []
|
3458
|
+
include Aws::Structure
|
3459
|
+
end
|
3460
|
+
|
3270
3461
|
# Detailed information about the accuracy of an entity recognizer for a
|
3271
3462
|
# specific entity type.
|
3272
3463
|
#
|
@@ -3825,12 +4016,56 @@ module Aws::Comprehend
|
|
3825
4016
|
include Aws::Structure
|
3826
4017
|
end
|
3827
4018
|
|
4019
|
+
# @note When making an API call, you may pass ListDocumentClassifierSummariesRequest
|
4020
|
+
# data as a hash:
|
4021
|
+
#
|
4022
|
+
# {
|
4023
|
+
# next_token: "String",
|
4024
|
+
# max_results: 1,
|
4025
|
+
# }
|
4026
|
+
#
|
4027
|
+
# @!attribute [rw] next_token
|
4028
|
+
# Identifies the next page of results to return.
|
4029
|
+
# @return [String]
|
4030
|
+
#
|
4031
|
+
# @!attribute [rw] max_results
|
4032
|
+
# The maximum number of results to return on each page. The default is
|
4033
|
+
# 100.
|
4034
|
+
# @return [Integer]
|
4035
|
+
#
|
4036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummariesRequest AWS API Documentation
|
4037
|
+
#
|
4038
|
+
class ListDocumentClassifierSummariesRequest < Struct.new(
|
4039
|
+
:next_token,
|
4040
|
+
:max_results)
|
4041
|
+
SENSITIVE = []
|
4042
|
+
include Aws::Structure
|
4043
|
+
end
|
4044
|
+
|
4045
|
+
# @!attribute [rw] document_classifier_summaries_list
|
4046
|
+
# The list of summaries of document classifiers.
|
4047
|
+
# @return [Array<Types::DocumentClassifierSummary>]
|
4048
|
+
#
|
4049
|
+
# @!attribute [rw] next_token
|
4050
|
+
# Identifies the next page of results to return.
|
4051
|
+
# @return [String]
|
4052
|
+
#
|
4053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummariesResponse AWS API Documentation
|
4054
|
+
#
|
4055
|
+
class ListDocumentClassifierSummariesResponse < Struct.new(
|
4056
|
+
:document_classifier_summaries_list,
|
4057
|
+
:next_token)
|
4058
|
+
SENSITIVE = []
|
4059
|
+
include Aws::Structure
|
4060
|
+
end
|
4061
|
+
|
3828
4062
|
# @note When making an API call, you may pass ListDocumentClassifiersRequest
|
3829
4063
|
# data as a hash:
|
3830
4064
|
#
|
3831
4065
|
# {
|
3832
4066
|
# filter: {
|
3833
4067
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
4068
|
+
# document_classifier_name: "ComprehendArnName",
|
3834
4069
|
# submit_time_before: Time.now,
|
3835
4070
|
# submit_time_after: Time.now,
|
3836
4071
|
# },
|
@@ -4049,12 +4284,56 @@ module Aws::Comprehend
|
|
4049
4284
|
include Aws::Structure
|
4050
4285
|
end
|
4051
4286
|
|
4287
|
+
# @note When making an API call, you may pass ListEntityRecognizerSummariesRequest
|
4288
|
+
# data as a hash:
|
4289
|
+
#
|
4290
|
+
# {
|
4291
|
+
# next_token: "String",
|
4292
|
+
# max_results: 1,
|
4293
|
+
# }
|
4294
|
+
#
|
4295
|
+
# @!attribute [rw] next_token
|
4296
|
+
# Identifies the next page of results to return.
|
4297
|
+
# @return [String]
|
4298
|
+
#
|
4299
|
+
# @!attribute [rw] max_results
|
4300
|
+
# The maximum number of results to return on each page. The default is
|
4301
|
+
# 100.
|
4302
|
+
# @return [Integer]
|
4303
|
+
#
|
4304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummariesRequest AWS API Documentation
|
4305
|
+
#
|
4306
|
+
class ListEntityRecognizerSummariesRequest < Struct.new(
|
4307
|
+
:next_token,
|
4308
|
+
:max_results)
|
4309
|
+
SENSITIVE = []
|
4310
|
+
include Aws::Structure
|
4311
|
+
end
|
4312
|
+
|
4313
|
+
# @!attribute [rw] entity_recognizer_summaries_list
|
4314
|
+
# The list entity recognizer summaries.
|
4315
|
+
# @return [Array<Types::EntityRecognizerSummary>]
|
4316
|
+
#
|
4317
|
+
# @!attribute [rw] next_token
|
4318
|
+
# The list entity recognizer summaries.
|
4319
|
+
# @return [String]
|
4320
|
+
#
|
4321
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummariesResponse AWS API Documentation
|
4322
|
+
#
|
4323
|
+
class ListEntityRecognizerSummariesResponse < Struct.new(
|
4324
|
+
:entity_recognizer_summaries_list,
|
4325
|
+
:next_token)
|
4326
|
+
SENSITIVE = []
|
4327
|
+
include Aws::Structure
|
4328
|
+
end
|
4329
|
+
|
4052
4330
|
# @note When making an API call, you may pass ListEntityRecognizersRequest
|
4053
4331
|
# data as a hash:
|
4054
4332
|
#
|
4055
4333
|
# {
|
4056
4334
|
# filter: {
|
4057
4335
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
4336
|
+
# recognizer_name: "ComprehendArnName",
|
4058
4337
|
# submit_time_before: Time.now,
|
4059
4338
|
# submit_time_after: Time.now,
|
4060
4339
|
# },
|
@@ -6829,24 +7108,37 @@ module Aws::Comprehend
|
|
6829
7108
|
#
|
6830
7109
|
# {
|
6831
7110
|
# endpoint_arn: "ComprehendEndpointArn", # required
|
6832
|
-
#
|
7111
|
+
# desired_model_arn: "ComprehendModelArn",
|
7112
|
+
# desired_inference_units: 1,
|
7113
|
+
# desired_data_access_role_arn: "IamRoleArn",
|
6833
7114
|
# }
|
6834
7115
|
#
|
6835
7116
|
# @!attribute [rw] endpoint_arn
|
6836
7117
|
# The Amazon Resource Number (ARN) of the endpoint being updated.
|
6837
7118
|
# @return [String]
|
6838
7119
|
#
|
7120
|
+
# @!attribute [rw] desired_model_arn
|
7121
|
+
# The ARN of the new model to use when updating an existing endpoint.
|
7122
|
+
# @return [String]
|
7123
|
+
#
|
6839
7124
|
# @!attribute [rw] desired_inference_units
|
6840
7125
|
# The desired number of inference units to be used by the model using
|
6841
7126
|
# this endpoint. Each inference unit represents of a throughput of 100
|
6842
7127
|
# characters per second.
|
6843
7128
|
# @return [Integer]
|
6844
7129
|
#
|
7130
|
+
# @!attribute [rw] desired_data_access_role_arn
|
7131
|
+
# Data access role ARN to use in case the new model is encrypted with
|
7132
|
+
# a customer CMK.
|
7133
|
+
# @return [String]
|
7134
|
+
#
|
6845
7135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointRequest AWS API Documentation
|
6846
7136
|
#
|
6847
7137
|
class UpdateEndpointRequest < Struct.new(
|
6848
7138
|
:endpoint_arn,
|
6849
|
-
:
|
7139
|
+
:desired_model_arn,
|
7140
|
+
:desired_inference_units,
|
7141
|
+
:desired_data_access_role_arn)
|
6850
7142
|
SENSITIVE = []
|
6851
7143
|
include Aws::Structure
|
6852
7144
|
end
|
data/lib/aws-sdk-comprehend.rb
CHANGED
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.55.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: 2021-
|
11
|
+
date: 2021-11-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.122.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.122.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|