aws-sdk-comprehend 1.65.0 → 1.67.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehend/client.rb +912 -183
- data/lib/aws-sdk-comprehend/client_api.rb +479 -2
- data/lib/aws-sdk-comprehend/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-comprehend/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-comprehend/endpoints.rb +154 -0
- data/lib/aws-sdk-comprehend/plugins/endpoints.rb +22 -0
- data/lib/aws-sdk-comprehend/types.rb +1599 -356
- data/lib/aws-sdk-comprehend.rb +1 -1
- metadata +2 -2
@@ -542,12 +542,6 @@ module Aws::Comprehend
|
|
542
542
|
# list can contain a maximum of 25 documents. The maximum size of each
|
543
543
|
# document is 5 KB.
|
544
544
|
#
|
545
|
-
# <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
|
546
|
-
# 500 characters of the input text and ignores any additional text in
|
547
|
-
# the input.
|
548
|
-
#
|
549
|
-
# </note>
|
550
|
-
#
|
551
545
|
# @option params [required, String] :language_code
|
552
546
|
# The language of the input documents. You can specify any of the
|
553
547
|
# primary languages supported by Amazon Comprehend. All documents must
|
@@ -853,6 +847,104 @@ module Aws::Comprehend
|
|
853
847
|
req.send_request(options)
|
854
848
|
end
|
855
849
|
|
850
|
+
# Creates a dataset to upload training or test data for a model
|
851
|
+
# associated with a flywheel. For more information about datasets, see [
|
852
|
+
# Flywheel overview][1] in the *Amazon Comprehend Developer Guide*.
|
853
|
+
#
|
854
|
+
#
|
855
|
+
#
|
856
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
857
|
+
#
|
858
|
+
# @option params [required, String] :flywheel_arn
|
859
|
+
# The Amazon Resource Number (ARN) of the flywheel of the flywheel to
|
860
|
+
# receive the data.
|
861
|
+
#
|
862
|
+
# @option params [required, String] :dataset_name
|
863
|
+
# Name of the dataset.
|
864
|
+
#
|
865
|
+
# @option params [String] :dataset_type
|
866
|
+
# The dataset type. You can specify that the data in a dataset is for
|
867
|
+
# training the model or for testing the model.
|
868
|
+
#
|
869
|
+
# @option params [String] :description
|
870
|
+
# Description of the dataset.
|
871
|
+
#
|
872
|
+
# @option params [required, Types::DatasetInputDataConfig] :input_data_config
|
873
|
+
# Information about the input data configuration. The type of input data
|
874
|
+
# varies based on the format of the input and whether the data is for a
|
875
|
+
# classifier model or an entity recognition model.
|
876
|
+
#
|
877
|
+
# @option params [String] :client_request_token
|
878
|
+
# A unique identifier for the request. If you don't set the client
|
879
|
+
# request token, Amazon Comprehend generates one.
|
880
|
+
#
|
881
|
+
# **A suitable default value is auto-generated.** You should normally
|
882
|
+
# not need to pass this option.**
|
883
|
+
#
|
884
|
+
# @option params [Array<Types::Tag>] :tags
|
885
|
+
# Tags for the dataset.
|
886
|
+
#
|
887
|
+
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
888
|
+
#
|
889
|
+
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
890
|
+
#
|
891
|
+
# @example Request syntax with placeholder values
|
892
|
+
#
|
893
|
+
# resp = client.create_dataset({
|
894
|
+
# flywheel_arn: "ComprehendFlywheelArn", # required
|
895
|
+
# dataset_name: "ComprehendArnName", # required
|
896
|
+
# dataset_type: "TRAIN", # accepts TRAIN, TEST
|
897
|
+
# description: "Description",
|
898
|
+
# input_data_config: { # required
|
899
|
+
# augmented_manifests: [
|
900
|
+
# {
|
901
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
902
|
+
# s3_uri: "S3Uri", # required
|
903
|
+
# annotation_data_s3_uri: "S3Uri",
|
904
|
+
# source_documents_s3_uri: "S3Uri",
|
905
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
906
|
+
# },
|
907
|
+
# ],
|
908
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
909
|
+
# document_classifier_input_data_config: {
|
910
|
+
# s3_uri: "S3Uri", # required
|
911
|
+
# label_delimiter: "LabelDelimiter",
|
912
|
+
# },
|
913
|
+
# entity_recognizer_input_data_config: {
|
914
|
+
# annotations: {
|
915
|
+
# s3_uri: "S3Uri", # required
|
916
|
+
# },
|
917
|
+
# documents: { # required
|
918
|
+
# s3_uri: "S3Uri", # required
|
919
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
920
|
+
# },
|
921
|
+
# entity_list: {
|
922
|
+
# s3_uri: "S3Uri", # required
|
923
|
+
# },
|
924
|
+
# },
|
925
|
+
# },
|
926
|
+
# client_request_token: "ClientRequestTokenString",
|
927
|
+
# tags: [
|
928
|
+
# {
|
929
|
+
# key: "TagKey", # required
|
930
|
+
# value: "TagValue",
|
931
|
+
# },
|
932
|
+
# ],
|
933
|
+
# })
|
934
|
+
#
|
935
|
+
# @example Response structure
|
936
|
+
#
|
937
|
+
# resp.dataset_arn #=> String
|
938
|
+
#
|
939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateDataset AWS API Documentation
|
940
|
+
#
|
941
|
+
# @overload create_dataset(params = {})
|
942
|
+
# @param [Hash] params ({})
|
943
|
+
def create_dataset(params = {}, options = {})
|
944
|
+
req = build_request(:create_dataset, params)
|
945
|
+
req.send_request(options)
|
946
|
+
end
|
947
|
+
|
856
948
|
# Creates a new document classifier that you can use to categorize
|
857
949
|
# documents. To create a classifier, you provide a set of training
|
858
950
|
# documents that labeled with the categories that you want to use. After
|
@@ -871,19 +963,18 @@ module Aws::Comprehend
|
|
871
963
|
# The version name given to the newly created classifier. Version names
|
872
964
|
# can have a maximum of 256 characters. Alphanumeric characters, hyphens
|
873
965
|
# (-) and underscores (\_) are allowed. The version name must be unique
|
874
|
-
# among all models with the same classifier name in the
|
875
|
-
# Region.
|
966
|
+
# among all models with the same classifier name in the Amazon Web
|
967
|
+
# Services account/Amazon Web Services Region.
|
876
968
|
#
|
877
969
|
# @option params [required, String] :data_access_role_arn
|
878
|
-
# The Amazon Resource Name (ARN) of the
|
879
|
-
#
|
880
|
-
# data.
|
970
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
971
|
+
# Comprehend read access to your input data.
|
881
972
|
#
|
882
973
|
# @option params [Array<Types::Tag>] :tags
|
883
|
-
# Tags to
|
884
|
-
#
|
885
|
-
#
|
886
|
-
#
|
974
|
+
# Tags to associate with the document classifier. A tag is a key-value
|
975
|
+
# pair that adds as a metadata to a resource used by Amazon Comprehend.
|
976
|
+
# For example, a tag with "Sales" as the key might be added to a
|
977
|
+
# resource to indicate its use by the sales department.
|
887
978
|
#
|
888
979
|
# @option params [required, Types::DocumentClassifierInputDataConfig] :input_data_config
|
889
980
|
# Specifies the format and location of the input data for the job.
|
@@ -901,15 +992,14 @@ module Aws::Comprehend
|
|
901
992
|
#
|
902
993
|
# @option params [required, String] :language_code
|
903
994
|
# The language of the input documents. You can specify any of the
|
904
|
-
#
|
905
|
-
#
|
906
|
-
# or Portuguese ("pt"). All documents must be in the same language.
|
995
|
+
# languages supported by Amazon Comprehend. All documents must be in the
|
996
|
+
# same language.
|
907
997
|
#
|
908
998
|
# @option params [String] :volume_kms_key_id
|
909
|
-
# ID for the
|
910
|
-
# uses to encrypt data on the storage volume attached
|
911
|
-
# instance(s) that process the analysis job. The
|
912
|
-
# either of the following formats:
|
999
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
1000
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
1001
|
+
# to the ML compute instance(s) that process the analysis job. The
|
1002
|
+
# VolumeKmsKeyId can be either of the following formats:
|
913
1003
|
#
|
914
1004
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
915
1005
|
#
|
@@ -934,9 +1024,9 @@ module Aws::Comprehend
|
|
934
1024
|
# delimiter. The default delimiter between labels is a pipe (\|).
|
935
1025
|
#
|
936
1026
|
# @option params [String] :model_kms_key_id
|
937
|
-
# ID for the
|
938
|
-
#
|
939
|
-
#
|
1027
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
1028
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
1029
|
+
# formats:
|
940
1030
|
#
|
941
1031
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
942
1032
|
#
|
@@ -945,8 +1035,8 @@ module Aws::Comprehend
|
|
945
1035
|
#
|
946
1036
|
# @option params [String] :model_policy
|
947
1037
|
# The resource-based policy to attach to your custom document classifier
|
948
|
-
# model. You can use this policy to allow another
|
949
|
-
# your custom model.
|
1038
|
+
# model. You can use this policy to allow another Amazon Web Services
|
1039
|
+
# account to import your custom model.
|
950
1040
|
#
|
951
1041
|
# Provide your policy as a JSON body that you enter as a UTF-8 encoded
|
952
1042
|
# string without line breaks. To provide valid JSON, enclose the
|
@@ -996,6 +1086,7 @@ module Aws::Comprehend
|
|
996
1086
|
# output_data_config: {
|
997
1087
|
# s3_uri: "S3Uri",
|
998
1088
|
# kms_key_id: "KmsKeyId",
|
1089
|
+
# flywheel_stats_s3_prefix: "S3Uri",
|
999
1090
|
# },
|
1000
1091
|
# client_request_token: "ClientRequestTokenString",
|
1001
1092
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
@@ -1034,7 +1125,7 @@ module Aws::Comprehend
|
|
1034
1125
|
# This is the descriptive suffix that becomes part of the `EndpointArn`
|
1035
1126
|
# used for all subsequent requests to this resource.
|
1036
1127
|
#
|
1037
|
-
# @option params [
|
1128
|
+
# @option params [String] :model_arn
|
1038
1129
|
# The Amazon Resource Number (ARN) of the model to which the endpoint
|
1039
1130
|
# will be attached.
|
1040
1131
|
#
|
@@ -1052,26 +1143,30 @@ module Aws::Comprehend
|
|
1052
1143
|
# not need to pass this option.**
|
1053
1144
|
#
|
1054
1145
|
# @option params [Array<Types::Tag>] :tags
|
1055
|
-
# Tags
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1146
|
+
# Tags to associate with the endpoint. A tag is a key-value pair that
|
1147
|
+
# adds metadata to the endpoint. For example, a tag with "Sales" as
|
1148
|
+
# the key might be added to an endpoint to indicate its use by the sales
|
1149
|
+
# department.
|
1059
1150
|
#
|
1060
1151
|
# @option params [String] :data_access_role_arn
|
1061
|
-
# The Amazon Resource Name (ARN) of the
|
1062
|
-
#
|
1063
|
-
#
|
1064
|
-
#
|
1152
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
1153
|
+
# Comprehend read access to trained custom models encrypted with a
|
1154
|
+
# customer managed key (ModelKmsKeyId).
|
1155
|
+
#
|
1156
|
+
# @option params [String] :flywheel_arn
|
1157
|
+
# The Amazon Resource Number (ARN) of the flywheel to which the endpoint
|
1158
|
+
# will be attached.
|
1065
1159
|
#
|
1066
1160
|
# @return [Types::CreateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1067
1161
|
#
|
1068
1162
|
# * {Types::CreateEndpointResponse#endpoint_arn #endpoint_arn} => String
|
1163
|
+
# * {Types::CreateEndpointResponse#model_arn #model_arn} => String
|
1069
1164
|
#
|
1070
1165
|
# @example Request syntax with placeholder values
|
1071
1166
|
#
|
1072
1167
|
# resp = client.create_endpoint({
|
1073
1168
|
# endpoint_name: "ComprehendEndpointName", # required
|
1074
|
-
# model_arn: "ComprehendModelArn",
|
1169
|
+
# model_arn: "ComprehendModelArn",
|
1075
1170
|
# desired_inference_units: 1, # required
|
1076
1171
|
# client_request_token: "ClientRequestTokenString",
|
1077
1172
|
# tags: [
|
@@ -1081,11 +1176,13 @@ module Aws::Comprehend
|
|
1081
1176
|
# },
|
1082
1177
|
# ],
|
1083
1178
|
# data_access_role_arn: "IamRoleArn",
|
1179
|
+
# flywheel_arn: "ComprehendFlywheelArn",
|
1084
1180
|
# })
|
1085
1181
|
#
|
1086
1182
|
# @example Response structure
|
1087
1183
|
#
|
1088
1184
|
# resp.endpoint_arn #=> String
|
1185
|
+
# resp.model_arn #=> String
|
1089
1186
|
#
|
1090
1187
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateEndpoint AWS API Documentation
|
1091
1188
|
#
|
@@ -1098,35 +1195,33 @@ module Aws::Comprehend
|
|
1098
1195
|
|
1099
1196
|
# Creates an entity recognizer using submitted files. After your
|
1100
1197
|
# `CreateEntityRecognizer` request is submitted, you can check job
|
1101
|
-
# status using the API.
|
1198
|
+
# status using the `DescribeEntityRecognizer` API.
|
1102
1199
|
#
|
1103
1200
|
# @option params [required, String] :recognizer_name
|
1104
1201
|
# The name given to the newly created recognizer. Recognizer names can
|
1105
1202
|
# be a maximum of 256 characters. Alphanumeric characters, hyphens (-)
|
1106
1203
|
# and underscores (\_) are allowed. The name must be unique in the
|
1107
|
-
# account/
|
1204
|
+
# account/Region.
|
1108
1205
|
#
|
1109
1206
|
# @option params [String] :version_name
|
1110
1207
|
# The version name given to the newly created recognizer. Version names
|
1111
1208
|
# can be a maximum of 256 characters. Alphanumeric characters, hyphens
|
1112
1209
|
# (-) and underscores (\_) are allowed. The version name must be unique
|
1113
|
-
# among all models with the same recognizer name in the account/
|
1114
|
-
# Region.
|
1210
|
+
# among all models with the same recognizer name in the account/Region.
|
1115
1211
|
#
|
1116
1212
|
# @option params [required, String] :data_access_role_arn
|
1117
|
-
# The Amazon Resource Name (ARN) of the
|
1118
|
-
#
|
1119
|
-
# data.
|
1213
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
1214
|
+
# Comprehend read access to your input data.
|
1120
1215
|
#
|
1121
1216
|
# @option params [Array<Types::Tag>] :tags
|
1122
|
-
# Tags to
|
1123
|
-
#
|
1124
|
-
#
|
1125
|
-
#
|
1217
|
+
# Tags to associate with the entity recognizer. A tag is a key-value
|
1218
|
+
# pair that adds as a metadata to a resource used by Amazon Comprehend.
|
1219
|
+
# For example, a tag with "Sales" as the key might be added to a
|
1220
|
+
# resource to indicate its use by the sales department.
|
1126
1221
|
#
|
1127
1222
|
# @option params [required, Types::EntityRecognizerInputDataConfig] :input_data_config
|
1128
1223
|
# Specifies the format and location of the input data. The S3 bucket
|
1129
|
-
# containing the input data must be located in the same
|
1224
|
+
# containing the input data must be located in the same Region as the
|
1130
1225
|
# entity recognizer being created.
|
1131
1226
|
#
|
1132
1227
|
# @option params [String] :client_request_token
|
@@ -1144,10 +1239,10 @@ module Aws::Comprehend
|
|
1144
1239
|
# language. All training documents must be in the same language.
|
1145
1240
|
#
|
1146
1241
|
# @option params [String] :volume_kms_key_id
|
1147
|
-
# ID for the
|
1148
|
-
# uses to encrypt data on the storage volume attached
|
1149
|
-
# instance(s) that process the analysis job. The
|
1150
|
-
# either of the following formats:
|
1242
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
1243
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
1244
|
+
# to the ML compute instance(s) that process the analysis job. The
|
1245
|
+
# VolumeKmsKeyId can be either of the following formats:
|
1151
1246
|
#
|
1152
1247
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1153
1248
|
#
|
@@ -1164,9 +1259,9 @@ module Aws::Comprehend
|
|
1164
1259
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
1165
1260
|
#
|
1166
1261
|
# @option params [String] :model_kms_key_id
|
1167
|
-
# ID for the
|
1168
|
-
#
|
1169
|
-
#
|
1262
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
1263
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
1264
|
+
# formats:
|
1170
1265
|
#
|
1171
1266
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
1172
1267
|
#
|
@@ -1175,8 +1270,8 @@ module Aws::Comprehend
|
|
1175
1270
|
#
|
1176
1271
|
# @option params [String] :model_policy
|
1177
1272
|
# The JSON resource-based policy to attach to your custom entity
|
1178
|
-
# recognizer model. You can use this policy to allow another
|
1179
|
-
# to import your custom model.
|
1273
|
+
# recognizer model. You can use this policy to allow another Amazon Web
|
1274
|
+
# Services account to import your custom model.
|
1180
1275
|
#
|
1181
1276
|
# Provide your JSON as a UTF-8 encoded string without line breaks. To
|
1182
1277
|
# provide valid JSON for your policy, enclose the attribute names and
|
@@ -1261,6 +1356,126 @@ module Aws::Comprehend
|
|
1261
1356
|
req.send_request(options)
|
1262
1357
|
end
|
1263
1358
|
|
1359
|
+
# A flywheel is an Amazon Web Services resource that orchestrates the
|
1360
|
+
# ongoing training of a model for custom classification or custom entity
|
1361
|
+
# recognition. You can create a flywheel to start with an existing
|
1362
|
+
# trained model, or Comprehend can create and train a new model.
|
1363
|
+
#
|
1364
|
+
# When you create the flywheel, Comprehend creates a data lake in your
|
1365
|
+
# account. The data lake holds the training data and test data for all
|
1366
|
+
# versions of the model.
|
1367
|
+
#
|
1368
|
+
# To use a flywheel with an existing trained model, you specify the
|
1369
|
+
# active model version. Comprehend copies the model's training data and
|
1370
|
+
# test data into the flywheel's data lake.
|
1371
|
+
#
|
1372
|
+
# To use the flywheel with a new model, you need to provide a dataset
|
1373
|
+
# for training data (and optional test data) when you create the
|
1374
|
+
# flywheel.
|
1375
|
+
#
|
1376
|
+
# For more information about flywheels, see [ Flywheel overview][1] in
|
1377
|
+
# the *Amazon Comprehend Developer Guide*.
|
1378
|
+
#
|
1379
|
+
#
|
1380
|
+
#
|
1381
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
1382
|
+
#
|
1383
|
+
# @option params [required, String] :flywheel_name
|
1384
|
+
# Name for the flywheel.
|
1385
|
+
#
|
1386
|
+
# @option params [String] :active_model_arn
|
1387
|
+
# To associate an existing model with the flywheel, specify the Amazon
|
1388
|
+
# Resource Number (ARN) of the model version.
|
1389
|
+
#
|
1390
|
+
# @option params [required, String] :data_access_role_arn
|
1391
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
1392
|
+
# Comprehend the permissions required to access the flywheel data in the
|
1393
|
+
# data lake.
|
1394
|
+
#
|
1395
|
+
# @option params [Types::TaskConfig] :task_config
|
1396
|
+
# Configuration about the custom classifier associated with the
|
1397
|
+
# flywheel.
|
1398
|
+
#
|
1399
|
+
# @option params [String] :model_type
|
1400
|
+
# The model type.
|
1401
|
+
#
|
1402
|
+
# @option params [required, String] :data_lake_s3_uri
|
1403
|
+
# Enter the S3 location for the data lake. You can specify a new S3
|
1404
|
+
# bucket or a new folder of an existing S3 bucket. The flywheel creates
|
1405
|
+
# the data lake at this location.
|
1406
|
+
#
|
1407
|
+
# @option params [Types::DataSecurityConfig] :data_security_config
|
1408
|
+
# Data security configurations.
|
1409
|
+
#
|
1410
|
+
# @option params [String] :client_request_token
|
1411
|
+
# A unique identifier for the request. If you don't set the client
|
1412
|
+
# request token, Amazon Comprehend generates one.
|
1413
|
+
#
|
1414
|
+
# **A suitable default value is auto-generated.** You should normally
|
1415
|
+
# not need to pass this option.**
|
1416
|
+
#
|
1417
|
+
# @option params [Array<Types::Tag>] :tags
|
1418
|
+
# The tags to associate with this flywheel.
|
1419
|
+
#
|
1420
|
+
# @return [Types::CreateFlywheelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1421
|
+
#
|
1422
|
+
# * {Types::CreateFlywheelResponse#flywheel_arn #flywheel_arn} => String
|
1423
|
+
# * {Types::CreateFlywheelResponse#active_model_arn #active_model_arn} => String
|
1424
|
+
#
|
1425
|
+
# @example Request syntax with placeholder values
|
1426
|
+
#
|
1427
|
+
# resp = client.create_flywheel({
|
1428
|
+
# flywheel_name: "ComprehendArnName", # required
|
1429
|
+
# active_model_arn: "ComprehendModelArn",
|
1430
|
+
# data_access_role_arn: "IamRoleArn", # required
|
1431
|
+
# task_config: {
|
1432
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
1433
|
+
# document_classification_config: {
|
1434
|
+
# mode: "MULTI_CLASS", # required, accepts MULTI_CLASS, MULTI_LABEL
|
1435
|
+
# labels: ["LabelListItem"],
|
1436
|
+
# },
|
1437
|
+
# entity_recognition_config: {
|
1438
|
+
# entity_types: [ # required
|
1439
|
+
# {
|
1440
|
+
# type: "EntityTypeName", # required
|
1441
|
+
# },
|
1442
|
+
# ],
|
1443
|
+
# },
|
1444
|
+
# },
|
1445
|
+
# model_type: "DOCUMENT_CLASSIFIER", # accepts DOCUMENT_CLASSIFIER, ENTITY_RECOGNIZER
|
1446
|
+
# data_lake_s3_uri: "FlywheelS3Uri", # required
|
1447
|
+
# data_security_config: {
|
1448
|
+
# model_kms_key_id: "KmsKeyId",
|
1449
|
+
# volume_kms_key_id: "KmsKeyId",
|
1450
|
+
# data_lake_kms_key_id: "KmsKeyId",
|
1451
|
+
# vpc_config: {
|
1452
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
1453
|
+
# subnets: ["SubnetId"], # required
|
1454
|
+
# },
|
1455
|
+
# },
|
1456
|
+
# client_request_token: "ClientRequestTokenString",
|
1457
|
+
# tags: [
|
1458
|
+
# {
|
1459
|
+
# key: "TagKey", # required
|
1460
|
+
# value: "TagValue",
|
1461
|
+
# },
|
1462
|
+
# ],
|
1463
|
+
# })
|
1464
|
+
#
|
1465
|
+
# @example Response structure
|
1466
|
+
#
|
1467
|
+
# resp.flywheel_arn #=> String
|
1468
|
+
# resp.active_model_arn #=> String
|
1469
|
+
#
|
1470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/CreateFlywheel AWS API Documentation
|
1471
|
+
#
|
1472
|
+
# @overload create_flywheel(params = {})
|
1473
|
+
# @param [Hash] params ({})
|
1474
|
+
def create_flywheel(params = {}, options = {})
|
1475
|
+
req = build_request(:create_flywheel, params)
|
1476
|
+
req.send_request(options)
|
1477
|
+
end
|
1478
|
+
|
1264
1479
|
# Deletes a previously created document classifier
|
1265
1480
|
#
|
1266
1481
|
# Only those classifiers that are in terminated states (IN\_ERROR,
|
@@ -1352,6 +1567,37 @@ module Aws::Comprehend
|
|
1352
1567
|
req.send_request(options)
|
1353
1568
|
end
|
1354
1569
|
|
1570
|
+
# Deletes a flywheel. When you delete the flywheel, Amazon Comprehend
|
1571
|
+
# does not delete the data lake or the model associated with the
|
1572
|
+
# flywheel.
|
1573
|
+
#
|
1574
|
+
# For more information about flywheels, see [ Flywheel overview][1] in
|
1575
|
+
# the *Amazon Comprehend Developer Guide*.
|
1576
|
+
#
|
1577
|
+
#
|
1578
|
+
#
|
1579
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
1580
|
+
#
|
1581
|
+
# @option params [required, String] :flywheel_arn
|
1582
|
+
# The Amazon Resource Number (ARN) of the flywheel to delete.
|
1583
|
+
#
|
1584
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1585
|
+
#
|
1586
|
+
# @example Request syntax with placeholder values
|
1587
|
+
#
|
1588
|
+
# resp = client.delete_flywheel({
|
1589
|
+
# flywheel_arn: "ComprehendFlywheelArn", # required
|
1590
|
+
# })
|
1591
|
+
#
|
1592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DeleteFlywheel AWS API Documentation
|
1593
|
+
#
|
1594
|
+
# @overload delete_flywheel(params = {})
|
1595
|
+
# @param [Hash] params ({})
|
1596
|
+
def delete_flywheel(params = {}, options = {})
|
1597
|
+
req = build_request(:delete_flywheel, params)
|
1598
|
+
req.send_request(options)
|
1599
|
+
end
|
1600
|
+
|
1355
1601
|
# Deletes a resource-based policy that is attached to a custom model.
|
1356
1602
|
#
|
1357
1603
|
# @option params [required, String] :resource_arn
|
@@ -1379,12 +1625,56 @@ module Aws::Comprehend
|
|
1379
1625
|
req.send_request(options)
|
1380
1626
|
end
|
1381
1627
|
|
1628
|
+
# Returns information about the dataset that you specify. For more
|
1629
|
+
# information about datasets, see [ Flywheel overview][1] in the *Amazon
|
1630
|
+
# Comprehend Developer Guide*.
|
1631
|
+
#
|
1632
|
+
#
|
1633
|
+
#
|
1634
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
1635
|
+
#
|
1636
|
+
# @option params [required, String] :dataset_arn
|
1637
|
+
# The ARN of the dataset.
|
1638
|
+
#
|
1639
|
+
# @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1640
|
+
#
|
1641
|
+
# * {Types::DescribeDatasetResponse#dataset_properties #dataset_properties} => Types::DatasetProperties
|
1642
|
+
#
|
1643
|
+
# @example Request syntax with placeholder values
|
1644
|
+
#
|
1645
|
+
# resp = client.describe_dataset({
|
1646
|
+
# dataset_arn: "ComprehendDatasetArn", # required
|
1647
|
+
# })
|
1648
|
+
#
|
1649
|
+
# @example Response structure
|
1650
|
+
#
|
1651
|
+
# resp.dataset_properties.dataset_arn #=> String
|
1652
|
+
# resp.dataset_properties.dataset_name #=> String
|
1653
|
+
# resp.dataset_properties.dataset_type #=> String, one of "TRAIN", "TEST"
|
1654
|
+
# resp.dataset_properties.dataset_s3_uri #=> String
|
1655
|
+
# resp.dataset_properties.description #=> String
|
1656
|
+
# resp.dataset_properties.status #=> String, one of "CREATING", "COMPLETED", "FAILED"
|
1657
|
+
# resp.dataset_properties.message #=> String
|
1658
|
+
# resp.dataset_properties.number_of_documents #=> Integer
|
1659
|
+
# resp.dataset_properties.creation_time #=> Time
|
1660
|
+
# resp.dataset_properties.end_time #=> Time
|
1661
|
+
#
|
1662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDataset AWS API Documentation
|
1663
|
+
#
|
1664
|
+
# @overload describe_dataset(params = {})
|
1665
|
+
# @param [Hash] params ({})
|
1666
|
+
def describe_dataset(params = {}, options = {})
|
1667
|
+
req = build_request(:describe_dataset, params)
|
1668
|
+
req.send_request(options)
|
1669
|
+
end
|
1670
|
+
|
1382
1671
|
# Gets the properties associated with a document classification job. Use
|
1383
1672
|
# this operation to get the status of a classification job.
|
1384
1673
|
#
|
1385
1674
|
# @option params [required, String] :job_id
|
1386
1675
|
# The identifier that Amazon Comprehend generated for the job. The
|
1387
|
-
# operation returns this identifier in
|
1676
|
+
# `StartDocumentClassificationJob` operation returns this identifier in
|
1677
|
+
# its response.
|
1388
1678
|
#
|
1389
1679
|
# @return [Types::DescribeDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1390
1680
|
#
|
@@ -1420,6 +1710,7 @@ module Aws::Comprehend
|
|
1420
1710
|
# resp.document_classification_job_properties.vpc_config.security_group_ids[0] #=> String
|
1421
1711
|
# resp.document_classification_job_properties.vpc_config.subnets #=> Array
|
1422
1712
|
# resp.document_classification_job_properties.vpc_config.subnets[0] #=> String
|
1713
|
+
# resp.document_classification_job_properties.flywheel_arn #=> String
|
1423
1714
|
#
|
1424
1715
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassificationJob AWS API Documentation
|
1425
1716
|
#
|
@@ -1434,7 +1725,8 @@ module Aws::Comprehend
|
|
1434
1725
|
#
|
1435
1726
|
# @option params [required, String] :document_classifier_arn
|
1436
1727
|
# The Amazon Resource Name (ARN) that identifies the document
|
1437
|
-
# classifier. The operation returns this
|
1728
|
+
# classifier. The `CreateDocumentClassifier` operation returns this
|
1729
|
+
# identifier in its response.
|
1438
1730
|
#
|
1439
1731
|
# @return [Types::DescribeDocumentClassifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1440
1732
|
#
|
@@ -1450,7 +1742,7 @@ module Aws::Comprehend
|
|
1450
1742
|
#
|
1451
1743
|
# resp.document_classifier_properties.document_classifier_arn #=> String
|
1452
1744
|
# resp.document_classifier_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
1453
|
-
# resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
1745
|
+
# resp.document_classifier_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
|
1454
1746
|
# resp.document_classifier_properties.message #=> String
|
1455
1747
|
# resp.document_classifier_properties.submit_time #=> Time
|
1456
1748
|
# resp.document_classifier_properties.end_time #=> Time
|
@@ -1470,6 +1762,7 @@ module Aws::Comprehend
|
|
1470
1762
|
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
|
1471
1763
|
# resp.document_classifier_properties.output_data_config.s3_uri #=> String
|
1472
1764
|
# resp.document_classifier_properties.output_data_config.kms_key_id #=> String
|
1765
|
+
# resp.document_classifier_properties.output_data_config.flywheel_stats_s3_prefix #=> String
|
1473
1766
|
# resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
|
1474
1767
|
# resp.document_classifier_properties.classifier_metadata.number_of_trained_documents #=> Integer
|
1475
1768
|
# resp.document_classifier_properties.classifier_metadata.number_of_test_documents #=> Integer
|
@@ -1491,6 +1784,7 @@ module Aws::Comprehend
|
|
1491
1784
|
# resp.document_classifier_properties.model_kms_key_id #=> String
|
1492
1785
|
# resp.document_classifier_properties.version_name #=> String
|
1493
1786
|
# resp.document_classifier_properties.source_model_arn #=> String
|
1787
|
+
# resp.document_classifier_properties.flywheel_arn #=> String
|
1494
1788
|
#
|
1495
1789
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDocumentClassifier AWS API Documentation
|
1496
1790
|
#
|
@@ -1506,7 +1800,8 @@ module Aws::Comprehend
|
|
1506
1800
|
#
|
1507
1801
|
# @option params [required, String] :job_id
|
1508
1802
|
# The identifier that Amazon Comprehend generated for the job. The
|
1509
|
-
# operation returns this identifier
|
1803
|
+
# `StartDominantLanguageDetectionJob` operation returns this identifier
|
1804
|
+
# in its response.
|
1510
1805
|
#
|
1511
1806
|
# @return [Types::DescribeDominantLanguageDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1512
1807
|
#
|
@@ -1585,6 +1880,7 @@ module Aws::Comprehend
|
|
1585
1880
|
# resp.endpoint_properties.last_modified_time #=> Time
|
1586
1881
|
# resp.endpoint_properties.data_access_role_arn #=> String
|
1587
1882
|
# resp.endpoint_properties.desired_data_access_role_arn #=> String
|
1883
|
+
# resp.endpoint_properties.flywheel_arn #=> String
|
1588
1884
|
#
|
1589
1885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEndpoint AWS API Documentation
|
1590
1886
|
#
|
@@ -1600,7 +1896,8 @@ module Aws::Comprehend
|
|
1600
1896
|
#
|
1601
1897
|
# @option params [required, String] :job_id
|
1602
1898
|
# The identifier that Amazon Comprehend generated for the job. The
|
1603
|
-
# operation returns this identifier in its
|
1899
|
+
# `StartEntitiesDetectionJob` operation returns this identifier in its
|
1900
|
+
# response.
|
1604
1901
|
#
|
1605
1902
|
# @return [Types::DescribeEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1606
1903
|
#
|
@@ -1637,6 +1934,7 @@ module Aws::Comprehend
|
|
1637
1934
|
# resp.entities_detection_job_properties.vpc_config.security_group_ids[0] #=> String
|
1638
1935
|
# resp.entities_detection_job_properties.vpc_config.subnets #=> Array
|
1639
1936
|
# resp.entities_detection_job_properties.vpc_config.subnets[0] #=> String
|
1937
|
+
# resp.entities_detection_job_properties.flywheel_arn #=> String
|
1640
1938
|
#
|
1641
1939
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob AWS API Documentation
|
1642
1940
|
#
|
@@ -1668,7 +1966,7 @@ module Aws::Comprehend
|
|
1668
1966
|
#
|
1669
1967
|
# resp.entity_recognizer_properties.entity_recognizer_arn #=> String
|
1670
1968
|
# resp.entity_recognizer_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
1671
|
-
# resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
1969
|
+
# resp.entity_recognizer_properties.status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
|
1672
1970
|
# resp.entity_recognizer_properties.message #=> String
|
1673
1971
|
# resp.entity_recognizer_properties.submit_time #=> Time
|
1674
1972
|
# resp.entity_recognizer_properties.end_time #=> Time
|
@@ -1711,6 +2009,8 @@ module Aws::Comprehend
|
|
1711
2009
|
# resp.entity_recognizer_properties.model_kms_key_id #=> String
|
1712
2010
|
# resp.entity_recognizer_properties.version_name #=> String
|
1713
2011
|
# resp.entity_recognizer_properties.source_model_arn #=> String
|
2012
|
+
# resp.entity_recognizer_properties.flywheel_arn #=> String
|
2013
|
+
# resp.entity_recognizer_properties.output_data_config.flywheel_stats_s3_prefix #=> String
|
1714
2014
|
#
|
1715
2015
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntityRecognizer AWS API Documentation
|
1716
2016
|
#
|
@@ -1767,12 +2067,121 @@ module Aws::Comprehend
|
|
1767
2067
|
req.send_request(options)
|
1768
2068
|
end
|
1769
2069
|
|
2070
|
+
# Provides configuration information about the flywheel. For more
|
2071
|
+
# information about flywheels, see [ Flywheel overview][1] in the
|
2072
|
+
# *Amazon Comprehend Developer Guide*.
|
2073
|
+
#
|
2074
|
+
#
|
2075
|
+
#
|
2076
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
2077
|
+
#
|
2078
|
+
# @option params [required, String] :flywheel_arn
|
2079
|
+
# The Amazon Resource Number (ARN) of the flywheel.
|
2080
|
+
#
|
2081
|
+
# @return [Types::DescribeFlywheelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2082
|
+
#
|
2083
|
+
# * {Types::DescribeFlywheelResponse#flywheel_properties #flywheel_properties} => Types::FlywheelProperties
|
2084
|
+
#
|
2085
|
+
# @example Request syntax with placeholder values
|
2086
|
+
#
|
2087
|
+
# resp = client.describe_flywheel({
|
2088
|
+
# flywheel_arn: "ComprehendFlywheelArn", # required
|
2089
|
+
# })
|
2090
|
+
#
|
2091
|
+
# @example Response structure
|
2092
|
+
#
|
2093
|
+
# resp.flywheel_properties.flywheel_arn #=> String
|
2094
|
+
# resp.flywheel_properties.active_model_arn #=> String
|
2095
|
+
# resp.flywheel_properties.data_access_role_arn #=> String
|
2096
|
+
# resp.flywheel_properties.task_config.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
2097
|
+
# resp.flywheel_properties.task_config.document_classification_config.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
2098
|
+
# resp.flywheel_properties.task_config.document_classification_config.labels #=> Array
|
2099
|
+
# resp.flywheel_properties.task_config.document_classification_config.labels[0] #=> String
|
2100
|
+
# resp.flywheel_properties.task_config.entity_recognition_config.entity_types #=> Array
|
2101
|
+
# resp.flywheel_properties.task_config.entity_recognition_config.entity_types[0].type #=> String
|
2102
|
+
# resp.flywheel_properties.data_lake_s3_uri #=> String
|
2103
|
+
# resp.flywheel_properties.data_security_config.model_kms_key_id #=> String
|
2104
|
+
# resp.flywheel_properties.data_security_config.volume_kms_key_id #=> String
|
2105
|
+
# resp.flywheel_properties.data_security_config.data_lake_kms_key_id #=> String
|
2106
|
+
# resp.flywheel_properties.data_security_config.vpc_config.security_group_ids #=> Array
|
2107
|
+
# resp.flywheel_properties.data_security_config.vpc_config.security_group_ids[0] #=> String
|
2108
|
+
# resp.flywheel_properties.data_security_config.vpc_config.subnets #=> Array
|
2109
|
+
# resp.flywheel_properties.data_security_config.vpc_config.subnets[0] #=> String
|
2110
|
+
# resp.flywheel_properties.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
2111
|
+
# resp.flywheel_properties.model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
|
2112
|
+
# resp.flywheel_properties.message #=> String
|
2113
|
+
# resp.flywheel_properties.creation_time #=> Time
|
2114
|
+
# resp.flywheel_properties.last_modified_time #=> Time
|
2115
|
+
# resp.flywheel_properties.latest_flywheel_iteration #=> String
|
2116
|
+
#
|
2117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheel AWS API Documentation
|
2118
|
+
#
|
2119
|
+
# @overload describe_flywheel(params = {})
|
2120
|
+
# @param [Hash] params ({})
|
2121
|
+
def describe_flywheel(params = {}, options = {})
|
2122
|
+
req = build_request(:describe_flywheel, params)
|
2123
|
+
req.send_request(options)
|
2124
|
+
end
|
2125
|
+
|
2126
|
+
# Retrieve the configuration properties of a flywheel iteration. For
|
2127
|
+
# more information about flywheels, see [ Flywheel overview][1] in the
|
2128
|
+
# *Amazon Comprehend Developer Guide*.
|
2129
|
+
#
|
2130
|
+
#
|
2131
|
+
#
|
2132
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
2133
|
+
#
|
2134
|
+
# @option params [required, String] :flywheel_arn
|
2135
|
+
#
|
2136
|
+
# @option params [required, String] :flywheel_iteration_id
|
2137
|
+
#
|
2138
|
+
# @return [Types::DescribeFlywheelIterationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2139
|
+
#
|
2140
|
+
# * {Types::DescribeFlywheelIterationResponse#flywheel_iteration_properties #flywheel_iteration_properties} => Types::FlywheelIterationProperties
|
2141
|
+
#
|
2142
|
+
# @example Request syntax with placeholder values
|
2143
|
+
#
|
2144
|
+
# resp = client.describe_flywheel_iteration({
|
2145
|
+
# flywheel_arn: "ComprehendFlywheelArn", # required
|
2146
|
+
# flywheel_iteration_id: "FlywheelIterationId", # required
|
2147
|
+
# })
|
2148
|
+
#
|
2149
|
+
# @example Response structure
|
2150
|
+
#
|
2151
|
+
# resp.flywheel_iteration_properties.flywheel_arn #=> String
|
2152
|
+
# resp.flywheel_iteration_properties.flywheel_iteration_id #=> String
|
2153
|
+
# resp.flywheel_iteration_properties.creation_time #=> Time
|
2154
|
+
# resp.flywheel_iteration_properties.end_time #=> Time
|
2155
|
+
# resp.flywheel_iteration_properties.status #=> String, one of "TRAINING", "EVALUATING", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2156
|
+
# resp.flywheel_iteration_properties.message #=> String
|
2157
|
+
# resp.flywheel_iteration_properties.evaluated_model_arn #=> String
|
2158
|
+
# resp.flywheel_iteration_properties.evaluated_model_metrics.average_f1_score #=> Float
|
2159
|
+
# resp.flywheel_iteration_properties.evaluated_model_metrics.average_precision #=> Float
|
2160
|
+
# resp.flywheel_iteration_properties.evaluated_model_metrics.average_recall #=> Float
|
2161
|
+
# resp.flywheel_iteration_properties.evaluated_model_metrics.average_accuracy #=> Float
|
2162
|
+
# resp.flywheel_iteration_properties.trained_model_arn #=> String
|
2163
|
+
# resp.flywheel_iteration_properties.trained_model_metrics.average_f1_score #=> Float
|
2164
|
+
# resp.flywheel_iteration_properties.trained_model_metrics.average_precision #=> Float
|
2165
|
+
# resp.flywheel_iteration_properties.trained_model_metrics.average_recall #=> Float
|
2166
|
+
# resp.flywheel_iteration_properties.trained_model_metrics.average_accuracy #=> Float
|
2167
|
+
# resp.flywheel_iteration_properties.evaluation_manifest_s3_prefix #=> String
|
2168
|
+
#
|
2169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeFlywheelIteration AWS API Documentation
|
2170
|
+
#
|
2171
|
+
# @overload describe_flywheel_iteration(params = {})
|
2172
|
+
# @param [Hash] params ({})
|
2173
|
+
def describe_flywheel_iteration(params = {}, options = {})
|
2174
|
+
req = build_request(:describe_flywheel_iteration, params)
|
2175
|
+
req.send_request(options)
|
2176
|
+
end
|
2177
|
+
|
1770
2178
|
# Gets the properties associated with a key phrases detection job. Use
|
1771
2179
|
# this operation to get the status of a detection job.
|
1772
2180
|
#
|
1773
2181
|
# @option params [required, String] :job_id
|
1774
2182
|
# The identifier that Amazon Comprehend generated for the job. The
|
1775
|
-
# operation returns this identifier in its
|
2183
|
+
# `StartKeyPhrasesDetectionJob` operation returns this identifier in its
|
2184
|
+
# response.
|
1776
2185
|
#
|
1777
2186
|
# @return [Types::DescribeKeyPhrasesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1778
2187
|
#
|
@@ -1961,7 +2370,8 @@ module Aws::Comprehend
|
|
1961
2370
|
#
|
1962
2371
|
# @option params [required, String] :job_id
|
1963
2372
|
# The identifier that Amazon Comprehend generated for the job. The
|
1964
|
-
# operation returns this identifier
|
2373
|
+
# `StartTargetedSentimentDetectionJob` operation returns this identifier
|
2374
|
+
# in its response.
|
1965
2375
|
#
|
1966
2376
|
# @return [Types::DescribeTargetedSentimentDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1967
2377
|
#
|
@@ -2338,12 +2748,6 @@ module Aws::Comprehend
|
|
2338
2748
|
# @option params [required, String] :text
|
2339
2749
|
# A UTF-8 text string. The maximum string size is 5 KB.
|
2340
2750
|
#
|
2341
|
-
# <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
|
2342
|
-
# 500 characters of the input text and ignores any additional text in
|
2343
|
-
# the input.
|
2344
|
-
#
|
2345
|
-
# </note>
|
2346
|
-
#
|
2347
2751
|
# @option params [required, String] :language_code
|
2348
2752
|
# The language of the input documents. You can specify any of the
|
2349
2753
|
# primary languages supported by Amazon Comprehend. All documents must
|
@@ -2481,15 +2885,15 @@ module Aws::Comprehend
|
|
2481
2885
|
end
|
2482
2886
|
|
2483
2887
|
# Creates a new custom model that replicates a source custom model that
|
2484
|
-
# you import. The source model can be in your
|
2485
|
-
# one.
|
2888
|
+
# you import. The source model can be in your Amazon Web Services
|
2889
|
+
# account or another one.
|
2486
2890
|
#
|
2487
|
-
# If the source model is in another
|
2488
|
-
# resource-based policy that authorizes you to import it.
|
2891
|
+
# If the source model is in another Amazon Web Services account, then it
|
2892
|
+
# must have a resource-based policy that authorizes you to import it.
|
2489
2893
|
#
|
2490
|
-
# The source model must be in the same
|
2491
|
-
# when you import. You can't import a model that's in a
|
2492
|
-
#
|
2894
|
+
# The source model must be in the same Amazon Web Services Region that
|
2895
|
+
# you're using when you import. You can't import a model that's in a
|
2896
|
+
# different Region.
|
2493
2897
|
#
|
2494
2898
|
# @option params [required, String] :source_model_arn
|
2495
2899
|
# The Amazon Resource Name (ARN) of the custom model to import.
|
@@ -2503,12 +2907,12 @@ module Aws::Comprehend
|
|
2503
2907
|
# import. Version names can have a maximum of 256 characters.
|
2504
2908
|
# Alphanumeric characters, hyphens (-) and underscores (\_) are allowed.
|
2505
2909
|
# The version name must be unique among all models with the same
|
2506
|
-
# classifier name in the account/
|
2910
|
+
# classifier name in the account/Region.
|
2507
2911
|
#
|
2508
2912
|
# @option params [String] :model_kms_key_id
|
2509
|
-
# ID for the
|
2510
|
-
#
|
2511
|
-
#
|
2913
|
+
# ID for the KMS key that Amazon Comprehend uses to encrypt trained
|
2914
|
+
# custom models. The ModelKmsKeyId can be either of the following
|
2915
|
+
# formats:
|
2512
2916
|
#
|
2513
2917
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2514
2918
|
#
|
@@ -2516,12 +2920,12 @@ module Aws::Comprehend
|
|
2516
2920
|
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2517
2921
|
#
|
2518
2922
|
# @option params [String] :data_access_role_arn
|
2519
|
-
# The Amazon Resource Name (ARN) of the
|
2520
|
-
#
|
2521
|
-
#
|
2923
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
2924
|
+
# Comprehend permission to use Amazon Key Management Service (KMS) to
|
2925
|
+
# encrypt or decrypt the custom model.
|
2522
2926
|
#
|
2523
2927
|
# @option params [Array<Types::Tag>] :tags
|
2524
|
-
# Tags to
|
2928
|
+
# Tags to associate with the custom model that is created by this
|
2525
2929
|
# import. A tag is a key-value pair that adds as a metadata to a
|
2526
2930
|
# resource used by Amazon Comprehend. For example, a tag with "Sales"
|
2527
2931
|
# as the key might be added to a resource to indicate its use by the
|
@@ -2560,6 +2964,71 @@ module Aws::Comprehend
|
|
2560
2964
|
req.send_request(options)
|
2561
2965
|
end
|
2562
2966
|
|
2967
|
+
# List the datasets that you have configured in this Region. For more
|
2968
|
+
# information about datasets, see [ Flywheel overview][1] in the *Amazon
|
2969
|
+
# Comprehend Developer Guide*.
|
2970
|
+
#
|
2971
|
+
#
|
2972
|
+
#
|
2973
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
2974
|
+
#
|
2975
|
+
# @option params [String] :flywheel_arn
|
2976
|
+
# The Amazon Resource Number (ARN) of the flywheel.
|
2977
|
+
#
|
2978
|
+
# @option params [Types::DatasetFilter] :filter
|
2979
|
+
# Filters the datasets to be returned in the response.
|
2980
|
+
#
|
2981
|
+
# @option params [String] :next_token
|
2982
|
+
# Identifies the next page of results to return.
|
2983
|
+
#
|
2984
|
+
# @option params [Integer] :max_results
|
2985
|
+
# Maximum number of results to return in a response. The default is 100.
|
2986
|
+
#
|
2987
|
+
# @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2988
|
+
#
|
2989
|
+
# * {Types::ListDatasetsResponse#dataset_properties_list #dataset_properties_list} => Array<Types::DatasetProperties>
|
2990
|
+
# * {Types::ListDatasetsResponse#next_token #next_token} => String
|
2991
|
+
#
|
2992
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2993
|
+
#
|
2994
|
+
# @example Request syntax with placeholder values
|
2995
|
+
#
|
2996
|
+
# resp = client.list_datasets({
|
2997
|
+
# flywheel_arn: "ComprehendFlywheelArn",
|
2998
|
+
# filter: {
|
2999
|
+
# status: "CREATING", # accepts CREATING, COMPLETED, FAILED
|
3000
|
+
# dataset_type: "TRAIN", # accepts TRAIN, TEST
|
3001
|
+
# creation_time_after: Time.now,
|
3002
|
+
# creation_time_before: Time.now,
|
3003
|
+
# },
|
3004
|
+
# next_token: "String",
|
3005
|
+
# max_results: 1,
|
3006
|
+
# })
|
3007
|
+
#
|
3008
|
+
# @example Response structure
|
3009
|
+
#
|
3010
|
+
# resp.dataset_properties_list #=> Array
|
3011
|
+
# resp.dataset_properties_list[0].dataset_arn #=> String
|
3012
|
+
# resp.dataset_properties_list[0].dataset_name #=> String
|
3013
|
+
# resp.dataset_properties_list[0].dataset_type #=> String, one of "TRAIN", "TEST"
|
3014
|
+
# resp.dataset_properties_list[0].dataset_s3_uri #=> String
|
3015
|
+
# resp.dataset_properties_list[0].description #=> String
|
3016
|
+
# resp.dataset_properties_list[0].status #=> String, one of "CREATING", "COMPLETED", "FAILED"
|
3017
|
+
# resp.dataset_properties_list[0].message #=> String
|
3018
|
+
# resp.dataset_properties_list[0].number_of_documents #=> Integer
|
3019
|
+
# resp.dataset_properties_list[0].creation_time #=> Time
|
3020
|
+
# resp.dataset_properties_list[0].end_time #=> Time
|
3021
|
+
# resp.next_token #=> String
|
3022
|
+
#
|
3023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDatasets AWS API Documentation
|
3024
|
+
#
|
3025
|
+
# @overload list_datasets(params = {})
|
3026
|
+
# @param [Hash] params ({})
|
3027
|
+
def list_datasets(params = {}, options = {})
|
3028
|
+
req = build_request(:list_datasets, params)
|
3029
|
+
req.send_request(options)
|
3030
|
+
end
|
3031
|
+
|
2563
3032
|
# Gets a list of the documentation classification jobs that you have
|
2564
3033
|
# submitted.
|
2565
3034
|
#
|
@@ -2620,6 +3089,7 @@ module Aws::Comprehend
|
|
2620
3089
|
# resp.document_classification_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
|
2621
3090
|
# resp.document_classification_job_properties_list[0].vpc_config.subnets #=> Array
|
2622
3091
|
# resp.document_classification_job_properties_list[0].vpc_config.subnets[0] #=> String
|
3092
|
+
# resp.document_classification_job_properties_list[0].flywheel_arn #=> String
|
2623
3093
|
# resp.next_token #=> String
|
2624
3094
|
#
|
2625
3095
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassificationJobs AWS API Documentation
|
@@ -2662,7 +3132,7 @@ module Aws::Comprehend
|
|
2662
3132
|
# resp.document_classifier_summaries_list[0].number_of_versions #=> Integer
|
2663
3133
|
# resp.document_classifier_summaries_list[0].latest_version_created_at #=> Time
|
2664
3134
|
# resp.document_classifier_summaries_list[0].latest_version_name #=> String
|
2665
|
-
# resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
3135
|
+
# resp.document_classifier_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
|
2666
3136
|
# resp.next_token #=> String
|
2667
3137
|
#
|
2668
3138
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummaries AWS API Documentation
|
@@ -2699,7 +3169,7 @@ module Aws::Comprehend
|
|
2699
3169
|
#
|
2700
3170
|
# resp = client.list_document_classifiers({
|
2701
3171
|
# filter: {
|
2702
|
-
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
3172
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
|
2703
3173
|
# document_classifier_name: "ComprehendArnName",
|
2704
3174
|
# submit_time_before: Time.now,
|
2705
3175
|
# submit_time_after: Time.now,
|
@@ -2713,7 +3183,7 @@ module Aws::Comprehend
|
|
2713
3183
|
# resp.document_classifier_properties_list #=> Array
|
2714
3184
|
# resp.document_classifier_properties_list[0].document_classifier_arn #=> String
|
2715
3185
|
# resp.document_classifier_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
2716
|
-
# resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
3186
|
+
# resp.document_classifier_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
|
2717
3187
|
# resp.document_classifier_properties_list[0].message #=> String
|
2718
3188
|
# resp.document_classifier_properties_list[0].submit_time #=> Time
|
2719
3189
|
# resp.document_classifier_properties_list[0].end_time #=> Time
|
@@ -2733,6 +3203,7 @@ module Aws::Comprehend
|
|
2733
3203
|
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].document_type #=> String, one of "PLAIN_TEXT_DOCUMENT", "SEMI_STRUCTURED_DOCUMENT"
|
2734
3204
|
# resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
|
2735
3205
|
# resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
|
3206
|
+
# resp.document_classifier_properties_list[0].output_data_config.flywheel_stats_s3_prefix #=> String
|
2736
3207
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
|
2737
3208
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_trained_documents #=> Integer
|
2738
3209
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_test_documents #=> Integer
|
@@ -2754,6 +3225,7 @@ module Aws::Comprehend
|
|
2754
3225
|
# resp.document_classifier_properties_list[0].model_kms_key_id #=> String
|
2755
3226
|
# resp.document_classifier_properties_list[0].version_name #=> String
|
2756
3227
|
# resp.document_classifier_properties_list[0].source_model_arn #=> String
|
3228
|
+
# resp.document_classifier_properties_list[0].flywheel_arn #=> String
|
2757
3229
|
# resp.next_token #=> String
|
2758
3230
|
#
|
2759
3231
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifiers AWS API Documentation
|
@@ -2888,6 +3360,7 @@ module Aws::Comprehend
|
|
2888
3360
|
# resp.endpoint_properties_list[0].last_modified_time #=> Time
|
2889
3361
|
# resp.endpoint_properties_list[0].data_access_role_arn #=> String
|
2890
3362
|
# resp.endpoint_properties_list[0].desired_data_access_role_arn #=> String
|
3363
|
+
# resp.endpoint_properties_list[0].flywheel_arn #=> String
|
2891
3364
|
# resp.next_token #=> String
|
2892
3365
|
#
|
2893
3366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEndpoints AWS API Documentation
|
@@ -2959,6 +3432,7 @@ module Aws::Comprehend
|
|
2959
3432
|
# resp.entities_detection_job_properties_list[0].vpc_config.security_group_ids[0] #=> String
|
2960
3433
|
# resp.entities_detection_job_properties_list[0].vpc_config.subnets #=> Array
|
2961
3434
|
# resp.entities_detection_job_properties_list[0].vpc_config.subnets[0] #=> String
|
3435
|
+
# resp.entities_detection_job_properties_list[0].flywheel_arn #=> String
|
2962
3436
|
# resp.next_token #=> String
|
2963
3437
|
#
|
2964
3438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs AWS API Documentation
|
@@ -3001,7 +3475,7 @@ module Aws::Comprehend
|
|
3001
3475
|
# resp.entity_recognizer_summaries_list[0].number_of_versions #=> Integer
|
3002
3476
|
# resp.entity_recognizer_summaries_list[0].latest_version_created_at #=> Time
|
3003
3477
|
# resp.entity_recognizer_summaries_list[0].latest_version_name #=> String
|
3004
|
-
# resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
3478
|
+
# resp.entity_recognizer_summaries_list[0].latest_version_status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
|
3005
3479
|
# resp.next_token #=> String
|
3006
3480
|
#
|
3007
3481
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummaries AWS API Documentation
|
@@ -3045,7 +3519,7 @@ module Aws::Comprehend
|
|
3045
3519
|
#
|
3046
3520
|
# resp = client.list_entity_recognizers({
|
3047
3521
|
# filter: {
|
3048
|
-
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
3522
|
+
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
|
3049
3523
|
# recognizer_name: "ComprehendArnName",
|
3050
3524
|
# submit_time_before: Time.now,
|
3051
3525
|
# submit_time_after: Time.now,
|
@@ -3059,7 +3533,7 @@ module Aws::Comprehend
|
|
3059
3533
|
# resp.entity_recognizer_properties_list #=> Array
|
3060
3534
|
# resp.entity_recognizer_properties_list[0].entity_recognizer_arn #=> String
|
3061
3535
|
# resp.entity_recognizer_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
3062
|
-
# resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED"
|
3536
|
+
# resp.entity_recognizer_properties_list[0].status #=> String, one of "SUBMITTED", "TRAINING", "DELETING", "STOP_REQUESTED", "STOPPED", "IN_ERROR", "TRAINED", "TRAINED_WITH_WARNING"
|
3063
3537
|
# resp.entity_recognizer_properties_list[0].message #=> String
|
3064
3538
|
# resp.entity_recognizer_properties_list[0].submit_time #=> Time
|
3065
3539
|
# resp.entity_recognizer_properties_list[0].end_time #=> Time
|
@@ -3102,6 +3576,8 @@ module Aws::Comprehend
|
|
3102
3576
|
# resp.entity_recognizer_properties_list[0].model_kms_key_id #=> String
|
3103
3577
|
# resp.entity_recognizer_properties_list[0].version_name #=> String
|
3104
3578
|
# resp.entity_recognizer_properties_list[0].source_model_arn #=> String
|
3579
|
+
# resp.entity_recognizer_properties_list[0].flywheel_arn #=> String
|
3580
|
+
# resp.entity_recognizer_properties_list[0].output_data_config.flywheel_stats_s3_prefix #=> String
|
3105
3581
|
# resp.next_token #=> String
|
3106
3582
|
#
|
3107
3583
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizers AWS API Documentation
|
@@ -3179,6 +3655,131 @@ module Aws::Comprehend
|
|
3179
3655
|
req.send_request(options)
|
3180
3656
|
end
|
3181
3657
|
|
3658
|
+
# Information about the history of a flywheel iteration. For more
|
3659
|
+
# information about flywheels, see [ Flywheel overview][1] in the
|
3660
|
+
# *Amazon Comprehend Developer Guide*.
|
3661
|
+
#
|
3662
|
+
#
|
3663
|
+
#
|
3664
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
3665
|
+
#
|
3666
|
+
# @option params [required, String] :flywheel_arn
|
3667
|
+
# The ARN of the flywheel.
|
3668
|
+
#
|
3669
|
+
# @option params [Types::FlywheelIterationFilter] :filter
|
3670
|
+
# Filter the flywheel iteration history based on creation time.
|
3671
|
+
#
|
3672
|
+
# @option params [String] :next_token
|
3673
|
+
# Next token
|
3674
|
+
#
|
3675
|
+
# @option params [Integer] :max_results
|
3676
|
+
# Maximum number of iteration history results to return
|
3677
|
+
#
|
3678
|
+
# @return [Types::ListFlywheelIterationHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3679
|
+
#
|
3680
|
+
# * {Types::ListFlywheelIterationHistoryResponse#flywheel_iteration_properties_list #flywheel_iteration_properties_list} => Array<Types::FlywheelIterationProperties>
|
3681
|
+
# * {Types::ListFlywheelIterationHistoryResponse#next_token #next_token} => String
|
3682
|
+
#
|
3683
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3684
|
+
#
|
3685
|
+
# @example Request syntax with placeholder values
|
3686
|
+
#
|
3687
|
+
# resp = client.list_flywheel_iteration_history({
|
3688
|
+
# flywheel_arn: "ComprehendFlywheelArn", # required
|
3689
|
+
# filter: {
|
3690
|
+
# creation_time_after: Time.now,
|
3691
|
+
# creation_time_before: Time.now,
|
3692
|
+
# },
|
3693
|
+
# next_token: "String",
|
3694
|
+
# max_results: 1,
|
3695
|
+
# })
|
3696
|
+
#
|
3697
|
+
# @example Response structure
|
3698
|
+
#
|
3699
|
+
# resp.flywheel_iteration_properties_list #=> Array
|
3700
|
+
# resp.flywheel_iteration_properties_list[0].flywheel_arn #=> String
|
3701
|
+
# resp.flywheel_iteration_properties_list[0].flywheel_iteration_id #=> String
|
3702
|
+
# resp.flywheel_iteration_properties_list[0].creation_time #=> Time
|
3703
|
+
# resp.flywheel_iteration_properties_list[0].end_time #=> Time
|
3704
|
+
# resp.flywheel_iteration_properties_list[0].status #=> String, one of "TRAINING", "EVALUATING", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3705
|
+
# resp.flywheel_iteration_properties_list[0].message #=> String
|
3706
|
+
# resp.flywheel_iteration_properties_list[0].evaluated_model_arn #=> String
|
3707
|
+
# resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_f1_score #=> Float
|
3708
|
+
# resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_precision #=> Float
|
3709
|
+
# resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_recall #=> Float
|
3710
|
+
# resp.flywheel_iteration_properties_list[0].evaluated_model_metrics.average_accuracy #=> Float
|
3711
|
+
# resp.flywheel_iteration_properties_list[0].trained_model_arn #=> String
|
3712
|
+
# resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_f1_score #=> Float
|
3713
|
+
# resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_precision #=> Float
|
3714
|
+
# resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_recall #=> Float
|
3715
|
+
# resp.flywheel_iteration_properties_list[0].trained_model_metrics.average_accuracy #=> Float
|
3716
|
+
# resp.flywheel_iteration_properties_list[0].evaluation_manifest_s3_prefix #=> String
|
3717
|
+
# resp.next_token #=> String
|
3718
|
+
#
|
3719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheelIterationHistory AWS API Documentation
|
3720
|
+
#
|
3721
|
+
# @overload list_flywheel_iteration_history(params = {})
|
3722
|
+
# @param [Hash] params ({})
|
3723
|
+
def list_flywheel_iteration_history(params = {}, options = {})
|
3724
|
+
req = build_request(:list_flywheel_iteration_history, params)
|
3725
|
+
req.send_request(options)
|
3726
|
+
end
|
3727
|
+
|
3728
|
+
# Gets a list of the flywheels that you have created.
|
3729
|
+
#
|
3730
|
+
# @option params [Types::FlywheelFilter] :filter
|
3731
|
+
# Filters the flywheels that are returned. You can filter flywheels on
|
3732
|
+
# their status, or the date and time that they were submitted. You can
|
3733
|
+
# only set one filter at a time.
|
3734
|
+
#
|
3735
|
+
# @option params [String] :next_token
|
3736
|
+
# Identifies the next page of results to return.
|
3737
|
+
#
|
3738
|
+
# @option params [Integer] :max_results
|
3739
|
+
# Maximum number of results to return in a response. The default is 100.
|
3740
|
+
#
|
3741
|
+
# @return [Types::ListFlywheelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3742
|
+
#
|
3743
|
+
# * {Types::ListFlywheelsResponse#flywheel_summary_list #flywheel_summary_list} => Array<Types::FlywheelSummary>
|
3744
|
+
# * {Types::ListFlywheelsResponse#next_token #next_token} => String
|
3745
|
+
#
|
3746
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3747
|
+
#
|
3748
|
+
# @example Request syntax with placeholder values
|
3749
|
+
#
|
3750
|
+
# resp = client.list_flywheels({
|
3751
|
+
# filter: {
|
3752
|
+
# status: "CREATING", # accepts CREATING, ACTIVE, UPDATING, DELETING, FAILED
|
3753
|
+
# creation_time_after: Time.now,
|
3754
|
+
# creation_time_before: Time.now,
|
3755
|
+
# },
|
3756
|
+
# next_token: "String",
|
3757
|
+
# max_results: 1,
|
3758
|
+
# })
|
3759
|
+
#
|
3760
|
+
# @example Response structure
|
3761
|
+
#
|
3762
|
+
# resp.flywheel_summary_list #=> Array
|
3763
|
+
# resp.flywheel_summary_list[0].flywheel_arn #=> String
|
3764
|
+
# resp.flywheel_summary_list[0].active_model_arn #=> String
|
3765
|
+
# resp.flywheel_summary_list[0].data_lake_s3_uri #=> String
|
3766
|
+
# resp.flywheel_summary_list[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
3767
|
+
# resp.flywheel_summary_list[0].model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
|
3768
|
+
# resp.flywheel_summary_list[0].message #=> String
|
3769
|
+
# resp.flywheel_summary_list[0].creation_time #=> Time
|
3770
|
+
# resp.flywheel_summary_list[0].last_modified_time #=> Time
|
3771
|
+
# resp.flywheel_summary_list[0].latest_flywheel_iteration #=> String
|
3772
|
+
# resp.next_token #=> String
|
3773
|
+
#
|
3774
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheels AWS API Documentation
|
3775
|
+
#
|
3776
|
+
# @overload list_flywheels(params = {})
|
3777
|
+
# @param [Hash] params ({})
|
3778
|
+
def list_flywheels(params = {}, options = {})
|
3779
|
+
req = build_request(:list_flywheels, params)
|
3780
|
+
req.send_request(options)
|
3781
|
+
end
|
3782
|
+
|
3182
3783
|
# Get a list of key phrase detection jobs that you have submitted.
|
3183
3784
|
#
|
3184
3785
|
# @option params [Types::KeyPhrasesDetectionJobFilter] :filter
|
@@ -3563,9 +4164,9 @@ module Aws::Comprehend
|
|
3563
4164
|
end
|
3564
4165
|
|
3565
4166
|
# Attaches a resource-based policy to a custom model. You can use this
|
3566
|
-
# policy to authorize an entity in another
|
3567
|
-
# custom model, which replicates it in Amazon Comprehend
|
3568
|
-
# account.
|
4167
|
+
# policy to authorize an entity in another Amazon Web Services account
|
4168
|
+
# to import the custom model, which replicates it in Amazon Comprehend
|
4169
|
+
# in their account.
|
3569
4170
|
#
|
3570
4171
|
# @option params [required, String] :resource_arn
|
3571
4172
|
# The Amazon Resource Name (ARN) of the custom model to attach the
|
@@ -3616,13 +4217,14 @@ module Aws::Comprehend
|
|
3616
4217
|
req.send_request(options)
|
3617
4218
|
end
|
3618
4219
|
|
3619
|
-
# Starts an asynchronous document classification job. Use the
|
3620
|
-
# to track the progress of
|
4220
|
+
# Starts an asynchronous document classification job. Use the
|
4221
|
+
# `DescribeDocumentClassificationJob` operation to track the progress of
|
4222
|
+
# the job.
|
3621
4223
|
#
|
3622
4224
|
# @option params [String] :job_name
|
3623
4225
|
# The identifier of the job.
|
3624
4226
|
#
|
3625
|
-
# @option params [
|
4227
|
+
# @option params [String] :document_classifier_arn
|
3626
4228
|
# The Amazon Resource Name (ARN) of the document classifier to use to
|
3627
4229
|
# process the job.
|
3628
4230
|
#
|
@@ -3633,9 +4235,8 @@ module Aws::Comprehend
|
|
3633
4235
|
# Specifies where to send the output files.
|
3634
4236
|
#
|
3635
4237
|
# @option params [required, String] :data_access_role_arn
|
3636
|
-
# The Amazon Resource Name (ARN) of the
|
3637
|
-
#
|
3638
|
-
# your input data.
|
4238
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4239
|
+
# Comprehend read access to your input data.
|
3639
4240
|
#
|
3640
4241
|
# @option params [String] :client_request_token
|
3641
4242
|
# A unique identifier for the request. If you do not set the client
|
@@ -3645,10 +4246,10 @@ module Aws::Comprehend
|
|
3645
4246
|
# not need to pass this option.**
|
3646
4247
|
#
|
3647
4248
|
# @option params [String] :volume_kms_key_id
|
3648
|
-
# ID for the
|
3649
|
-
# uses to encrypt data on the storage volume attached
|
3650
|
-
# instance(s) that process the analysis job. The
|
3651
|
-
# either of the following formats:
|
4249
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
4250
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
4251
|
+
# to the ML compute instance(s) that process the analysis job. The
|
4252
|
+
# VolumeKmsKeyId can be either of the following formats:
|
3652
4253
|
#
|
3653
4254
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3654
4255
|
#
|
@@ -3665,22 +4266,27 @@ module Aws::Comprehend
|
|
3665
4266
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3666
4267
|
#
|
3667
4268
|
# @option params [Array<Types::Tag>] :tags
|
3668
|
-
# Tags to
|
4269
|
+
# Tags to associate with the document classification job. A tag is a
|
3669
4270
|
# key-value pair that adds metadata to a resource used by Amazon
|
3670
4271
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
3671
4272
|
# added to a resource to indicate its use by the sales department.
|
3672
4273
|
#
|
4274
|
+
# @option params [String] :flywheel_arn
|
4275
|
+
# The Amazon Resource Number (ARN) of the flywheel associated with the
|
4276
|
+
# model to use.
|
4277
|
+
#
|
3673
4278
|
# @return [Types::StartDocumentClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3674
4279
|
#
|
3675
4280
|
# * {Types::StartDocumentClassificationJobResponse#job_id #job_id} => String
|
3676
4281
|
# * {Types::StartDocumentClassificationJobResponse#job_arn #job_arn} => String
|
3677
4282
|
# * {Types::StartDocumentClassificationJobResponse#job_status #job_status} => String
|
4283
|
+
# * {Types::StartDocumentClassificationJobResponse#document_classifier_arn #document_classifier_arn} => String
|
3678
4284
|
#
|
3679
4285
|
# @example Request syntax with placeholder values
|
3680
4286
|
#
|
3681
4287
|
# resp = client.start_document_classification_job({
|
3682
4288
|
# job_name: "JobName",
|
3683
|
-
# document_classifier_arn: "DocumentClassifierArn",
|
4289
|
+
# document_classifier_arn: "DocumentClassifierArn",
|
3684
4290
|
# input_data_config: { # required
|
3685
4291
|
# s3_uri: "S3Uri", # required
|
3686
4292
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
@@ -3707,6 +4313,7 @@ module Aws::Comprehend
|
|
3707
4313
|
# value: "TagValue",
|
3708
4314
|
# },
|
3709
4315
|
# ],
|
4316
|
+
# flywheel_arn: "ComprehendFlywheelArn",
|
3710
4317
|
# })
|
3711
4318
|
#
|
3712
4319
|
# @example Response structure
|
@@ -3714,6 +4321,7 @@ module Aws::Comprehend
|
|
3714
4321
|
# resp.job_id #=> String
|
3715
4322
|
# resp.job_arn #=> String
|
3716
4323
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
4324
|
+
# resp.document_classifier_arn #=> String
|
3717
4325
|
#
|
3718
4326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJob AWS API Documentation
|
3719
4327
|
#
|
@@ -3735,14 +4343,13 @@ module Aws::Comprehend
|
|
3735
4343
|
# Specifies where to send the output files.
|
3736
4344
|
#
|
3737
4345
|
# @option params [required, String] :data_access_role_arn
|
3738
|
-
# The Amazon Resource Name (ARN) of the
|
3739
|
-
#
|
3740
|
-
#
|
3741
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
4346
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4347
|
+
# Comprehend read access to your input data. For more information, see
|
4348
|
+
# [Role-based permissions][1].
|
3742
4349
|
#
|
3743
4350
|
#
|
3744
4351
|
#
|
3745
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
4352
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
3746
4353
|
#
|
3747
4354
|
# @option params [String] :job_name
|
3748
4355
|
# An identifier for the job.
|
@@ -3755,10 +4362,10 @@ module Aws::Comprehend
|
|
3755
4362
|
# not need to pass this option.**
|
3756
4363
|
#
|
3757
4364
|
# @option params [String] :volume_kms_key_id
|
3758
|
-
# ID for the
|
3759
|
-
# uses to encrypt data on the storage volume attached
|
3760
|
-
# instance(s) that process the analysis job. The
|
3761
|
-
# either of the following formats:
|
4365
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
4366
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
4367
|
+
# to the ML compute instance(s) that process the analysis job. The
|
4368
|
+
# VolumeKmsKeyId can be either of the following formats:
|
3762
4369
|
#
|
3763
4370
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3764
4371
|
#
|
@@ -3775,8 +4382,8 @@ module Aws::Comprehend
|
|
3775
4382
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3776
4383
|
#
|
3777
4384
|
# @option params [Array<Types::Tag>] :tags
|
3778
|
-
# Tags to
|
3779
|
-
#
|
4385
|
+
# Tags to associate with the dominant language detection job. A tag is a
|
4386
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
3780
4387
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
3781
4388
|
# added to a resource to indicate its use by the sales department.
|
3782
4389
|
#
|
@@ -3848,14 +4455,13 @@ module Aws::Comprehend
|
|
3848
4455
|
# Specifies where to send the output files.
|
3849
4456
|
#
|
3850
4457
|
# @option params [required, String] :data_access_role_arn
|
3851
|
-
# The Amazon Resource Name (ARN) of the
|
3852
|
-
#
|
3853
|
-
#
|
3854
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
4458
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4459
|
+
# Comprehend read access to your input data. For more information, see
|
4460
|
+
# [Role-based permissions][1].
|
3855
4461
|
#
|
3856
4462
|
#
|
3857
4463
|
#
|
3858
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
4464
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
3859
4465
|
#
|
3860
4466
|
# @option params [String] :job_name
|
3861
4467
|
# The identifier of the job.
|
@@ -3879,10 +4485,10 @@ module Aws::Comprehend
|
|
3879
4485
|
# not need to pass this option.**
|
3880
4486
|
#
|
3881
4487
|
# @option params [String] :volume_kms_key_id
|
3882
|
-
# ID for the
|
3883
|
-
# uses to encrypt data on the storage volume attached
|
3884
|
-
# instance(s) that process the analysis job. The
|
3885
|
-
# either of the following formats:
|
4488
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
4489
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
4490
|
+
# to the ML compute instance(s) that process the analysis job. The
|
4491
|
+
# VolumeKmsKeyId can be either of the following formats:
|
3886
4492
|
#
|
3887
4493
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3888
4494
|
#
|
@@ -3899,16 +4505,21 @@ module Aws::Comprehend
|
|
3899
4505
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
3900
4506
|
#
|
3901
4507
|
# @option params [Array<Types::Tag>] :tags
|
3902
|
-
# Tags to
|
4508
|
+
# Tags to associate with the entities detection job. A tag is a
|
3903
4509
|
# key-value pair that adds metadata to a resource used by Amazon
|
3904
4510
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
3905
4511
|
# added to a resource to indicate its use by the sales department.
|
3906
4512
|
#
|
4513
|
+
# @option params [String] :flywheel_arn
|
4514
|
+
# The Amazon Resource Number (ARN) of the flywheel associated with the
|
4515
|
+
# model to use.
|
4516
|
+
#
|
3907
4517
|
# @return [Types::StartEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3908
4518
|
#
|
3909
4519
|
# * {Types::StartEntitiesDetectionJobResponse#job_id #job_id} => String
|
3910
4520
|
# * {Types::StartEntitiesDetectionJobResponse#job_arn #job_arn} => String
|
3911
4521
|
# * {Types::StartEntitiesDetectionJobResponse#job_status #job_status} => String
|
4522
|
+
# * {Types::StartEntitiesDetectionJobResponse#entity_recognizer_arn #entity_recognizer_arn} => String
|
3912
4523
|
#
|
3913
4524
|
# @example Request syntax with placeholder values
|
3914
4525
|
#
|
@@ -3942,6 +4553,7 @@ module Aws::Comprehend
|
|
3942
4553
|
# value: "TagValue",
|
3943
4554
|
# },
|
3944
4555
|
# ],
|
4556
|
+
# flywheel_arn: "ComprehendFlywheelArn",
|
3945
4557
|
# })
|
3946
4558
|
#
|
3947
4559
|
# @example Response structure
|
@@ -3949,6 +4561,7 @@ module Aws::Comprehend
|
|
3949
4561
|
# resp.job_id #=> String
|
3950
4562
|
# resp.job_arn #=> String
|
3951
4563
|
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
4564
|
+
# resp.entity_recognizer_arn #=> String
|
3952
4565
|
#
|
3953
4566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJob AWS API Documentation
|
3954
4567
|
#
|
@@ -3969,9 +4582,8 @@ module Aws::Comprehend
|
|
3969
4582
|
# Specifies where to send the output files.
|
3970
4583
|
#
|
3971
4584
|
# @option params [required, String] :data_access_role_arn
|
3972
|
-
# The Amazon Resource Name (ARN) of the
|
3973
|
-
#
|
3974
|
-
# your input data.
|
4585
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4586
|
+
# Comprehend read access to your input data.
|
3975
4587
|
#
|
3976
4588
|
# @option params [String] :job_name
|
3977
4589
|
# The identifier of the events detection job.
|
@@ -3990,10 +4602,10 @@ module Aws::Comprehend
|
|
3990
4602
|
# The types of events to detect in the input documents.
|
3991
4603
|
#
|
3992
4604
|
# @option params [Array<Types::Tag>] :tags
|
3993
|
-
# Tags to
|
3994
|
-
#
|
3995
|
-
#
|
3996
|
-
#
|
4605
|
+
# Tags to associate with the events detection job. A tag is a key-value
|
4606
|
+
# pair that adds metadata to a resource used by Amazon Comprehend. For
|
4607
|
+
# example, a tag with "Sales" as the key might be added to a resource
|
4608
|
+
# to indicate its use by the sales department.
|
3997
4609
|
#
|
3998
4610
|
# @return [Types::StartEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3999
4611
|
#
|
@@ -4045,6 +4657,47 @@ module Aws::Comprehend
|
|
4045
4657
|
req.send_request(options)
|
4046
4658
|
end
|
4047
4659
|
|
4660
|
+
# Start the flywheel iteration.This operation uses any new datasets to
|
4661
|
+
# train a new model version. For more information about flywheels, see [
|
4662
|
+
# Flywheel overview][1] in the *Amazon Comprehend Developer Guide*.
|
4663
|
+
#
|
4664
|
+
#
|
4665
|
+
#
|
4666
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html
|
4667
|
+
#
|
4668
|
+
# @option params [required, String] :flywheel_arn
|
4669
|
+
# The ARN of the flywheel.
|
4670
|
+
#
|
4671
|
+
# @option params [String] :client_request_token
|
4672
|
+
# A unique identifier for the request. If you don't set the client
|
4673
|
+
# request token, Amazon Comprehend generates one.
|
4674
|
+
#
|
4675
|
+
# @return [Types::StartFlywheelIterationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4676
|
+
#
|
4677
|
+
# * {Types::StartFlywheelIterationResponse#flywheel_arn #flywheel_arn} => String
|
4678
|
+
# * {Types::StartFlywheelIterationResponse#flywheel_iteration_id #flywheel_iteration_id} => String
|
4679
|
+
#
|
4680
|
+
# @example Request syntax with placeholder values
|
4681
|
+
#
|
4682
|
+
# resp = client.start_flywheel_iteration({
|
4683
|
+
# flywheel_arn: "ComprehendFlywheelArn", # required
|
4684
|
+
# client_request_token: "ClientRequestTokenString",
|
4685
|
+
# })
|
4686
|
+
#
|
4687
|
+
# @example Response structure
|
4688
|
+
#
|
4689
|
+
# resp.flywheel_arn #=> String
|
4690
|
+
# resp.flywheel_iteration_id #=> String
|
4691
|
+
#
|
4692
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartFlywheelIteration AWS API Documentation
|
4693
|
+
#
|
4694
|
+
# @overload start_flywheel_iteration(params = {})
|
4695
|
+
# @param [Hash] params ({})
|
4696
|
+
def start_flywheel_iteration(params = {}, options = {})
|
4697
|
+
req = build_request(:start_flywheel_iteration, params)
|
4698
|
+
req.send_request(options)
|
4699
|
+
end
|
4700
|
+
|
4048
4701
|
# Starts an asynchronous key phrase detection job for a collection of
|
4049
4702
|
# documents. Use the operation to track the status of a job.
|
4050
4703
|
#
|
@@ -4055,14 +4708,13 @@ module Aws::Comprehend
|
|
4055
4708
|
# Specifies where to send the output files.
|
4056
4709
|
#
|
4057
4710
|
# @option params [required, String] :data_access_role_arn
|
4058
|
-
# The Amazon Resource Name (ARN) of the
|
4059
|
-
#
|
4060
|
-
#
|
4061
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
4711
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4712
|
+
# Comprehend read access to your input data. For more information, see
|
4713
|
+
# [Role-based permissions][1].
|
4062
4714
|
#
|
4063
4715
|
#
|
4064
4716
|
#
|
4065
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
4717
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
4066
4718
|
#
|
4067
4719
|
# @option params [String] :job_name
|
4068
4720
|
# The identifier of the job.
|
@@ -4080,10 +4732,10 @@ module Aws::Comprehend
|
|
4080
4732
|
# not need to pass this option.**
|
4081
4733
|
#
|
4082
4734
|
# @option params [String] :volume_kms_key_id
|
4083
|
-
# ID for the
|
4084
|
-
# uses to encrypt data on the storage volume attached
|
4085
|
-
# instance(s) that process the analysis job. The
|
4086
|
-
# either of the following formats:
|
4735
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
4736
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
4737
|
+
# to the ML compute instance(s) that process the analysis job. The
|
4738
|
+
# VolumeKmsKeyId can be either of the following formats:
|
4087
4739
|
#
|
4088
4740
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
4089
4741
|
#
|
@@ -4100,7 +4752,7 @@ module Aws::Comprehend
|
|
4100
4752
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4101
4753
|
#
|
4102
4754
|
# @option params [Array<Types::Tag>] :tags
|
4103
|
-
# Tags to
|
4755
|
+
# Tags to associate with the key phrases detection job. A tag is a
|
4104
4756
|
# key-value pair that adds metadata to a resource used by Amazon
|
4105
4757
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
4106
4758
|
# added to a resource to indicate its use by the sales department.
|
@@ -4181,9 +4833,8 @@ module Aws::Comprehend
|
|
4181
4833
|
# definition that includes the `PiiEntityTypes` parameter.
|
4182
4834
|
#
|
4183
4835
|
# @option params [required, String] :data_access_role_arn
|
4184
|
-
# The Amazon Resource Name (ARN) of the
|
4185
|
-
#
|
4186
|
-
# your input data.
|
4836
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4837
|
+
# Comprehend read access to your input data.
|
4187
4838
|
#
|
4188
4839
|
# @option params [String] :job_name
|
4189
4840
|
# The identifier of the job.
|
@@ -4200,7 +4851,7 @@ module Aws::Comprehend
|
|
4200
4851
|
# not need to pass this option.**
|
4201
4852
|
#
|
4202
4853
|
# @option params [Array<Types::Tag>] :tags
|
4203
|
-
# Tags to
|
4854
|
+
# Tags to associate with the PII entities detection job. A tag is a
|
4204
4855
|
# key-value pair that adds metadata to a resource used by Amazon
|
4205
4856
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
4206
4857
|
# added to a resource to indicate its use by the sales department.
|
@@ -4270,14 +4921,13 @@ module Aws::Comprehend
|
|
4270
4921
|
# Specifies where to send the output files.
|
4271
4922
|
#
|
4272
4923
|
# @option params [required, String] :data_access_role_arn
|
4273
|
-
# The Amazon Resource Name (ARN) of the
|
4274
|
-
#
|
4275
|
-
#
|
4276
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
4924
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
4925
|
+
# Comprehend read access to your input data. For more information, see
|
4926
|
+
# [Role-based permissions][1].
|
4277
4927
|
#
|
4278
4928
|
#
|
4279
4929
|
#
|
4280
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
4930
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
4281
4931
|
#
|
4282
4932
|
# @option params [String] :job_name
|
4283
4933
|
# The identifier of the job.
|
@@ -4295,10 +4945,10 @@ module Aws::Comprehend
|
|
4295
4945
|
# not need to pass this option.**
|
4296
4946
|
#
|
4297
4947
|
# @option params [String] :volume_kms_key_id
|
4298
|
-
# ID for the
|
4299
|
-
# uses to encrypt data on the storage volume attached
|
4300
|
-
# instance(s) that process the analysis job. The
|
4301
|
-
# either of the following formats:
|
4948
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
4949
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
4950
|
+
# to the ML compute instance(s) that process the analysis job. The
|
4951
|
+
# VolumeKmsKeyId can be either of the following formats:
|
4302
4952
|
#
|
4303
4953
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
4304
4954
|
#
|
@@ -4315,7 +4965,7 @@ module Aws::Comprehend
|
|
4315
4965
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4316
4966
|
#
|
4317
4967
|
# @option params [Array<Types::Tag>] :tags
|
4318
|
-
# Tags to
|
4968
|
+
# Tags to associate with the sentiment detection job. A tag is a
|
4319
4969
|
# key-value pair that adds metadata to a resource used by Amazon
|
4320
4970
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
4321
4971
|
# added to a resource to indicate its use by the sales department.
|
@@ -4375,8 +5025,9 @@ module Aws::Comprehend
|
|
4375
5025
|
end
|
4376
5026
|
|
4377
5027
|
# Starts an asynchronous targeted sentiment detection job for a
|
4378
|
-
# collection of documents. Use the
|
4379
|
-
#
|
5028
|
+
# collection of documents. Use the
|
5029
|
+
# `DescribeTargetedSentimentDetectionJob` operation to track the status
|
5030
|
+
# of a job.
|
4380
5031
|
#
|
4381
5032
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
4382
5033
|
# The input properties for an inference job. The document reader config
|
@@ -4386,10 +5037,9 @@ module Aws::Comprehend
|
|
4386
5037
|
# Specifies where to send the output files.
|
4387
5038
|
#
|
4388
5039
|
# @option params [required, String] :data_access_role_arn
|
4389
|
-
# The Amazon Resource Name (ARN) of the
|
4390
|
-
#
|
4391
|
-
#
|
4392
|
-
# permissions][1].
|
5040
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
5041
|
+
# Comprehend read access to your input data. For more information, see
|
5042
|
+
# [Role-based permissions][1].
|
4393
5043
|
#
|
4394
5044
|
#
|
4395
5045
|
#
|
@@ -4430,8 +5080,8 @@ module Aws::Comprehend
|
|
4430
5080
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4431
5081
|
#
|
4432
5082
|
# @option params [Array<Types::Tag>] :tags
|
4433
|
-
# Tags to
|
4434
|
-
#
|
5083
|
+
# Tags to associate with the targeted sentiment detection job. A tag is
|
5084
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
4435
5085
|
# Comprehend. For example, a tag with "Sales" as the key might be
|
4436
5086
|
# added to a resource to indicate its use by the sales department.
|
4437
5087
|
#
|
@@ -4502,14 +5152,13 @@ module Aws::Comprehend
|
|
4502
5152
|
# documents associated with each topic
|
4503
5153
|
#
|
4504
5154
|
# @option params [required, String] :data_access_role_arn
|
4505
|
-
# The Amazon Resource Name (ARN) of the
|
4506
|
-
#
|
4507
|
-
#
|
4508
|
-
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
5155
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
5156
|
+
# Comprehend read access to your input data. For more information, see
|
5157
|
+
# [Role-based permissions][1].
|
4509
5158
|
#
|
4510
5159
|
#
|
4511
5160
|
#
|
4512
|
-
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/
|
5161
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions
|
4513
5162
|
#
|
4514
5163
|
# @option params [String] :job_name
|
4515
5164
|
# The identifier of the job.
|
@@ -4525,10 +5174,10 @@ module Aws::Comprehend
|
|
4525
5174
|
# not need to pass this option.**
|
4526
5175
|
#
|
4527
5176
|
# @option params [String] :volume_kms_key_id
|
4528
|
-
# ID for the
|
4529
|
-
# uses to encrypt data on the storage volume attached
|
4530
|
-
# instance(s) that process the analysis job. The
|
4531
|
-
# either of the following formats:
|
5177
|
+
# ID for the Amazon Web Services Key Management Service (KMS) key that
|
5178
|
+
# Amazon Comprehend uses to encrypt data on the storage volume attached
|
5179
|
+
# to the ML compute instance(s) that process the analysis job. The
|
5180
|
+
# VolumeKmsKeyId can be either of the following formats:
|
4532
5181
|
#
|
4533
5182
|
# * KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"`
|
4534
5183
|
#
|
@@ -4545,10 +5194,10 @@ module Aws::Comprehend
|
|
4545
5194
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4546
5195
|
#
|
4547
5196
|
# @option params [Array<Types::Tag>] :tags
|
4548
|
-
# Tags to
|
4549
|
-
#
|
4550
|
-
#
|
4551
|
-
#
|
5197
|
+
# Tags to associate with the topics detection job. A tag is a key-value
|
5198
|
+
# pair that adds metadata to a resource used by Amazon Comprehend. For
|
5199
|
+
# example, a tag with "Sales" as the key might be added to a resource
|
5200
|
+
# to indicate its use by the sales department.
|
4552
5201
|
#
|
4553
5202
|
# @return [Types::StartTopicsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4554
5203
|
#
|
@@ -5024,7 +5673,12 @@ module Aws::Comprehend
|
|
5024
5673
|
# Data access role ARN to use in case the new model is encrypted with a
|
5025
5674
|
# customer CMK.
|
5026
5675
|
#
|
5027
|
-
# @
|
5676
|
+
# @option params [String] :flywheel_arn
|
5677
|
+
# The Amazon Resource Number (ARN) of the flywheel
|
5678
|
+
#
|
5679
|
+
# @return [Types::UpdateEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5680
|
+
#
|
5681
|
+
# * {Types::UpdateEndpointResponse#desired_model_arn #desired_model_arn} => String
|
5028
5682
|
#
|
5029
5683
|
# @example Request syntax with placeholder values
|
5030
5684
|
#
|
@@ -5033,8 +5687,13 @@ module Aws::Comprehend
|
|
5033
5687
|
# desired_model_arn: "ComprehendModelArn",
|
5034
5688
|
# desired_inference_units: 1,
|
5035
5689
|
# desired_data_access_role_arn: "IamRoleArn",
|
5690
|
+
# flywheel_arn: "ComprehendFlywheelArn",
|
5036
5691
|
# })
|
5037
5692
|
#
|
5693
|
+
# @example Response structure
|
5694
|
+
#
|
5695
|
+
# resp.desired_model_arn #=> String
|
5696
|
+
#
|
5038
5697
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpoint AWS API Documentation
|
5039
5698
|
#
|
5040
5699
|
# @overload update_endpoint(params = {})
|
@@ -5044,6 +5703,76 @@ module Aws::Comprehend
|
|
5044
5703
|
req.send_request(options)
|
5045
5704
|
end
|
5046
5705
|
|
5706
|
+
# Update the configuration information for an existing flywheel.
|
5707
|
+
#
|
5708
|
+
# @option params [required, String] :flywheel_arn
|
5709
|
+
# The Amazon Resource Number (ARN) of the flywheel to update.
|
5710
|
+
#
|
5711
|
+
# @option params [String] :active_model_arn
|
5712
|
+
# The Amazon Resource Number (ARN) of the active model version.
|
5713
|
+
#
|
5714
|
+
# @option params [String] :data_access_role_arn
|
5715
|
+
# The Amazon Resource Name (ARN) of the IAM role that grants Amazon
|
5716
|
+
# Comprehend permission to access the flywheel data.
|
5717
|
+
#
|
5718
|
+
# @option params [Types::UpdateDataSecurityConfig] :data_security_config
|
5719
|
+
# Flywheel data security configuration.
|
5720
|
+
#
|
5721
|
+
# @return [Types::UpdateFlywheelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5722
|
+
#
|
5723
|
+
# * {Types::UpdateFlywheelResponse#flywheel_properties #flywheel_properties} => Types::FlywheelProperties
|
5724
|
+
#
|
5725
|
+
# @example Request syntax with placeholder values
|
5726
|
+
#
|
5727
|
+
# resp = client.update_flywheel({
|
5728
|
+
# flywheel_arn: "ComprehendFlywheelArn", # required
|
5729
|
+
# active_model_arn: "ComprehendModelArn",
|
5730
|
+
# data_access_role_arn: "IamRoleArn",
|
5731
|
+
# data_security_config: {
|
5732
|
+
# model_kms_key_id: "KmsKeyId",
|
5733
|
+
# volume_kms_key_id: "KmsKeyId",
|
5734
|
+
# vpc_config: {
|
5735
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
5736
|
+
# subnets: ["SubnetId"], # required
|
5737
|
+
# },
|
5738
|
+
# },
|
5739
|
+
# })
|
5740
|
+
#
|
5741
|
+
# @example Response structure
|
5742
|
+
#
|
5743
|
+
# resp.flywheel_properties.flywheel_arn #=> String
|
5744
|
+
# resp.flywheel_properties.active_model_arn #=> String
|
5745
|
+
# resp.flywheel_properties.data_access_role_arn #=> String
|
5746
|
+
# resp.flywheel_properties.task_config.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
5747
|
+
# resp.flywheel_properties.task_config.document_classification_config.mode #=> String, one of "MULTI_CLASS", "MULTI_LABEL"
|
5748
|
+
# resp.flywheel_properties.task_config.document_classification_config.labels #=> Array
|
5749
|
+
# resp.flywheel_properties.task_config.document_classification_config.labels[0] #=> String
|
5750
|
+
# resp.flywheel_properties.task_config.entity_recognition_config.entity_types #=> Array
|
5751
|
+
# resp.flywheel_properties.task_config.entity_recognition_config.entity_types[0].type #=> String
|
5752
|
+
# resp.flywheel_properties.data_lake_s3_uri #=> String
|
5753
|
+
# resp.flywheel_properties.data_security_config.model_kms_key_id #=> String
|
5754
|
+
# resp.flywheel_properties.data_security_config.volume_kms_key_id #=> String
|
5755
|
+
# resp.flywheel_properties.data_security_config.data_lake_kms_key_id #=> String
|
5756
|
+
# resp.flywheel_properties.data_security_config.vpc_config.security_group_ids #=> Array
|
5757
|
+
# resp.flywheel_properties.data_security_config.vpc_config.security_group_ids[0] #=> String
|
5758
|
+
# resp.flywheel_properties.data_security_config.vpc_config.subnets #=> Array
|
5759
|
+
# resp.flywheel_properties.data_security_config.vpc_config.subnets[0] #=> String
|
5760
|
+
# resp.flywheel_properties.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
5761
|
+
# resp.flywheel_properties.model_type #=> String, one of "DOCUMENT_CLASSIFIER", "ENTITY_RECOGNIZER"
|
5762
|
+
# resp.flywheel_properties.message #=> String
|
5763
|
+
# resp.flywheel_properties.creation_time #=> Time
|
5764
|
+
# resp.flywheel_properties.last_modified_time #=> Time
|
5765
|
+
# resp.flywheel_properties.latest_flywheel_iteration #=> String
|
5766
|
+
#
|
5767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateFlywheel AWS API Documentation
|
5768
|
+
#
|
5769
|
+
# @overload update_flywheel(params = {})
|
5770
|
+
# @param [Hash] params ({})
|
5771
|
+
def update_flywheel(params = {}, options = {})
|
5772
|
+
req = build_request(:update_flywheel, params)
|
5773
|
+
req.send_request(options)
|
5774
|
+
end
|
5775
|
+
|
5047
5776
|
# @!endgroup
|
5048
5777
|
|
5049
5778
|
# @param params ({})
|
@@ -5057,7 +5786,7 @@ module Aws::Comprehend
|
|
5057
5786
|
params: params,
|
5058
5787
|
config: config)
|
5059
5788
|
context[:gem_name] = 'aws-sdk-comprehend'
|
5060
|
-
context[:gem_version] = '1.
|
5789
|
+
context[:gem_version] = '1.67.0'
|
5061
5790
|
Seahorse::Client::Request.new(handlers, context)
|
5062
5791
|
end
|
5063
5792
|
|