aws-sdk-comprehend 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +170 -38
- data/lib/aws-sdk-comprehend/client_api.rb +74 -0
- data/lib/aws-sdk-comprehend/types.rb +249 -28
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e6243fbc46cb9e0c72014235552b48bc5e026caa
|
4
|
+
data.tar.gz: c4b7fec266967d0e503f067a33cee7a8feabe839
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 23a99bd3620ce077fa6c98fc78b53592f7a2bca66c722ec6f500bdbc3421026936d4895fbfbcb9ac7f5f7cb579b482d82835843921845a41a9b4922c3f8ef08c
|
7
|
+
data.tar.gz: 87a493248dde6073c459f3d8ff1a9457f579c20ef7501b91d9e1ca26ff8416357b2dab2929e23a4a9c0e59d8c4a019d546024f459978fdcbb558e5218027cd1b
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -355,6 +355,56 @@ module Aws::Comprehend
|
|
355
355
|
req.send_request(options)
|
356
356
|
end
|
357
357
|
|
358
|
+
# Inspects the text of a batch of documents for the syntax and part of
|
359
|
+
# speech of the words in the document and returns information about
|
360
|
+
# them. For more information, see how-syntax.
|
361
|
+
#
|
362
|
+
# @option params [required, Array<String>] :text_list
|
363
|
+
# A list containing the text of the input documents. The list can
|
364
|
+
# contain a maximum of 25 documents. Each document must contain fewer
|
365
|
+
# that 5,000 bytes of UTF-8 encoded characters.
|
366
|
+
#
|
367
|
+
# @option params [required, String] :language_code
|
368
|
+
# The language of the input documents. You can specify English ("en")
|
369
|
+
# or Spanish ("es"). All documents must be in the same language.
|
370
|
+
#
|
371
|
+
# @return [Types::BatchDetectSyntaxResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
372
|
+
#
|
373
|
+
# * {Types::BatchDetectSyntaxResponse#result_list #result_list} => Array<Types::BatchDetectSyntaxItemResult>
|
374
|
+
# * {Types::BatchDetectSyntaxResponse#error_list #error_list} => Array<Types::BatchItemError>
|
375
|
+
#
|
376
|
+
# @example Request syntax with placeholder values
|
377
|
+
#
|
378
|
+
# resp = client.batch_detect_syntax({
|
379
|
+
# text_list: ["String"], # required
|
380
|
+
# language_code: "en", # required, accepts en
|
381
|
+
# })
|
382
|
+
#
|
383
|
+
# @example Response structure
|
384
|
+
#
|
385
|
+
# resp.result_list #=> Array
|
386
|
+
# resp.result_list[0].index #=> Integer
|
387
|
+
# resp.result_list[0].syntax_tokens #=> Array
|
388
|
+
# resp.result_list[0].syntax_tokens[0].token_id #=> Integer
|
389
|
+
# resp.result_list[0].syntax_tokens[0].text #=> String
|
390
|
+
# resp.result_list[0].syntax_tokens[0].begin_offset #=> Integer
|
391
|
+
# resp.result_list[0].syntax_tokens[0].end_offset #=> Integer
|
392
|
+
# resp.result_list[0].syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
|
393
|
+
# resp.result_list[0].syntax_tokens[0].part_of_speech.score #=> Float
|
394
|
+
# resp.error_list #=> Array
|
395
|
+
# resp.error_list[0].index #=> Integer
|
396
|
+
# resp.error_list[0].error_code #=> String
|
397
|
+
# resp.error_list[0].error_message #=> String
|
398
|
+
#
|
399
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntax AWS API Documentation
|
400
|
+
#
|
401
|
+
# @overload batch_detect_syntax(params = {})
|
402
|
+
# @param [Hash] params ({})
|
403
|
+
def batch_detect_syntax(params = {}, options = {})
|
404
|
+
req = build_request(:batch_detect_syntax, params)
|
405
|
+
req.send_request(options)
|
406
|
+
end
|
407
|
+
|
358
408
|
# Gets the properties associated with a dominant language detection job.
|
359
409
|
# Use this operation to get the status of a detection job.
|
360
410
|
#
|
@@ -383,6 +433,7 @@ module Aws::Comprehend
|
|
383
433
|
# resp.dominant_language_detection_job_properties.input_data_config.s3_uri #=> String
|
384
434
|
# resp.dominant_language_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
385
435
|
# resp.dominant_language_detection_job_properties.output_data_config.s3_uri #=> String
|
436
|
+
# resp.dominant_language_detection_job_properties.data_access_role_arn #=> String
|
386
437
|
#
|
387
438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeDominantLanguageDetectionJob AWS API Documentation
|
388
439
|
#
|
@@ -422,6 +473,7 @@ module Aws::Comprehend
|
|
422
473
|
# resp.entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
423
474
|
# resp.entities_detection_job_properties.output_data_config.s3_uri #=> String
|
424
475
|
# resp.entities_detection_job_properties.language_code #=> String, one of "en", "es"
|
476
|
+
# resp.entities_detection_job_properties.data_access_role_arn #=> String
|
425
477
|
#
|
426
478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEntitiesDetectionJob AWS API Documentation
|
427
479
|
#
|
@@ -461,6 +513,7 @@ module Aws::Comprehend
|
|
461
513
|
# resp.key_phrases_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
462
514
|
# resp.key_phrases_detection_job_properties.output_data_config.s3_uri #=> String
|
463
515
|
# resp.key_phrases_detection_job_properties.language_code #=> String, one of "en", "es"
|
516
|
+
# resp.key_phrases_detection_job_properties.data_access_role_arn #=> String
|
464
517
|
#
|
465
518
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeKeyPhrasesDetectionJob AWS API Documentation
|
466
519
|
#
|
@@ -500,6 +553,7 @@ module Aws::Comprehend
|
|
500
553
|
# resp.sentiment_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
501
554
|
# resp.sentiment_detection_job_properties.output_data_config.s3_uri #=> String
|
502
555
|
# resp.sentiment_detection_job_properties.language_code #=> String, one of "en", "es"
|
556
|
+
# resp.sentiment_detection_job_properties.data_access_role_arn #=> String
|
503
557
|
#
|
504
558
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeSentimentDetectionJob AWS API Documentation
|
505
559
|
#
|
@@ -703,6 +757,47 @@ module Aws::Comprehend
|
|
703
757
|
req.send_request(options)
|
704
758
|
end
|
705
759
|
|
760
|
+
# Inspects text for syntax and the part of speech of words in the
|
761
|
+
# document. For more information, how-syntax.
|
762
|
+
#
|
763
|
+
# @option params [required, String] :text
|
764
|
+
# A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF
|
765
|
+
# encoded characters.
|
766
|
+
#
|
767
|
+
# @option params [required, String] :language_code
|
768
|
+
# The language code of the input documents. You can specify English
|
769
|
+
# ("en") or Spanish ("es").
|
770
|
+
#
|
771
|
+
# @return [Types::DetectSyntaxResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
772
|
+
#
|
773
|
+
# * {Types::DetectSyntaxResponse#syntax_tokens #syntax_tokens} => Array<Types::SyntaxToken>
|
774
|
+
#
|
775
|
+
# @example Request syntax with placeholder values
|
776
|
+
#
|
777
|
+
# resp = client.detect_syntax({
|
778
|
+
# text: "String", # required
|
779
|
+
# language_code: "en", # required, accepts en
|
780
|
+
# })
|
781
|
+
#
|
782
|
+
# @example Response structure
|
783
|
+
#
|
784
|
+
# resp.syntax_tokens #=> Array
|
785
|
+
# resp.syntax_tokens[0].token_id #=> Integer
|
786
|
+
# resp.syntax_tokens[0].text #=> String
|
787
|
+
# resp.syntax_tokens[0].begin_offset #=> Integer
|
788
|
+
# resp.syntax_tokens[0].end_offset #=> Integer
|
789
|
+
# resp.syntax_tokens[0].part_of_speech.tag #=> String, one of "ADJ", "ADP", "ADV", "AUX", "CONJ", "DET", "INTJ", "NOUN", "NUM", "O", "PART", "PRON", "PROPN", "PUNCT", "SCONJ", "SYM", "VERB"
|
790
|
+
# resp.syntax_tokens[0].part_of_speech.score #=> Float
|
791
|
+
#
|
792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntax AWS API Documentation
|
793
|
+
#
|
794
|
+
# @overload detect_syntax(params = {})
|
795
|
+
# @param [Hash] params ({})
|
796
|
+
def detect_syntax(params = {}, options = {})
|
797
|
+
req = build_request(:detect_syntax, params)
|
798
|
+
req.send_request(options)
|
799
|
+
end
|
800
|
+
|
706
801
|
# Gets a list of the dominant language detection jobs that you have
|
707
802
|
# submitted.
|
708
803
|
#
|
@@ -748,6 +843,7 @@ module Aws::Comprehend
|
|
748
843
|
# resp.dominant_language_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
749
844
|
# resp.dominant_language_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
750
845
|
# resp.dominant_language_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
846
|
+
# resp.dominant_language_detection_job_properties_list[0].data_access_role_arn #=> String
|
751
847
|
# resp.next_token #=> String
|
752
848
|
#
|
753
849
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDominantLanguageDetectionJobs AWS API Documentation
|
@@ -804,6 +900,7 @@ module Aws::Comprehend
|
|
804
900
|
# resp.entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
805
901
|
# resp.entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
806
902
|
# resp.entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es"
|
903
|
+
# resp.entities_detection_job_properties_list[0].data_access_role_arn #=> String
|
807
904
|
# resp.next_token #=> String
|
808
905
|
#
|
809
906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntitiesDetectionJobs AWS API Documentation
|
@@ -860,6 +957,7 @@ module Aws::Comprehend
|
|
860
957
|
# resp.key_phrases_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
861
958
|
# resp.key_phrases_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
862
959
|
# resp.key_phrases_detection_job_properties_list[0].language_code #=> String, one of "en", "es"
|
960
|
+
# resp.key_phrases_detection_job_properties_list[0].data_access_role_arn #=> String
|
863
961
|
# resp.next_token #=> String
|
864
962
|
#
|
865
963
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobs AWS API Documentation
|
@@ -916,6 +1014,7 @@ module Aws::Comprehend
|
|
916
1014
|
# resp.sentiment_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
917
1015
|
# resp.sentiment_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
918
1016
|
# resp.sentiment_detection_job_properties_list[0].language_code #=> String, one of "en", "es"
|
1017
|
+
# resp.sentiment_detection_job_properties_list[0].data_access_role_arn #=> String
|
919
1018
|
# resp.next_token #=> String
|
920
1019
|
#
|
921
1020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobs AWS API Documentation
|
@@ -994,9 +1093,14 @@ module Aws::Comprehend
|
|
994
1093
|
# Specifies where to send the output files.
|
995
1094
|
#
|
996
1095
|
# @option params [required, String] :data_access_role_arn
|
997
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
998
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
999
|
-
# data.
|
1096
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1097
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1098
|
+
# your input data. For more information, see
|
1099
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1100
|
+
#
|
1101
|
+
#
|
1102
|
+
#
|
1103
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1000
1104
|
#
|
1001
1105
|
# @option params [String] :job_name
|
1002
1106
|
# An identifier for the job.
|
@@ -1052,9 +1156,14 @@ module Aws::Comprehend
|
|
1052
1156
|
# Specifies where to send the output files.
|
1053
1157
|
#
|
1054
1158
|
# @option params [required, String] :data_access_role_arn
|
1055
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
1056
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
1057
|
-
# data.
|
1159
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1160
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1161
|
+
# your input data. For more information, see
|
1162
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1163
|
+
#
|
1164
|
+
#
|
1165
|
+
#
|
1166
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1058
1167
|
#
|
1059
1168
|
# @option params [String] :job_name
|
1060
1169
|
# The identifier of the job.
|
@@ -1115,9 +1224,14 @@ module Aws::Comprehend
|
|
1115
1224
|
# Specifies where to send the output files.
|
1116
1225
|
#
|
1117
1226
|
# @option params [required, String] :data_access_role_arn
|
1118
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
1119
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
1120
|
-
# data.
|
1227
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1228
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1229
|
+
# your input data. For more information, see
|
1230
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1231
|
+
#
|
1232
|
+
#
|
1233
|
+
#
|
1234
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1121
1235
|
#
|
1122
1236
|
# @option params [String] :job_name
|
1123
1237
|
# The identifier of the job.
|
@@ -1178,9 +1292,14 @@ module Aws::Comprehend
|
|
1178
1292
|
# Specifies where to send the output files.
|
1179
1293
|
#
|
1180
1294
|
# @option params [required, String] :data_access_role_arn
|
1181
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
1182
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
1183
|
-
# data.
|
1295
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1296
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1297
|
+
# your input data. For more information, see
|
1298
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1299
|
+
#
|
1300
|
+
#
|
1301
|
+
#
|
1302
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1184
1303
|
#
|
1185
1304
|
# @option params [String] :job_name
|
1186
1305
|
# The identifier of the job.
|
@@ -1246,7 +1365,12 @@ module Aws::Comprehend
|
|
1246
1365
|
# @option params [required, String] :data_access_role_arn
|
1247
1366
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1248
1367
|
# Management (IAM) role that grants Amazon Comprehend read access to
|
1249
|
-
# your input data.
|
1368
|
+
# your input data. For more information, see
|
1369
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1370
|
+
#
|
1371
|
+
#
|
1372
|
+
#
|
1373
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1250
1374
|
#
|
1251
1375
|
# @option params [String] :job_name
|
1252
1376
|
# The identifier of the job.
|
@@ -1298,15 +1422,17 @@ module Aws::Comprehend
|
|
1298
1422
|
|
1299
1423
|
# Stops a dominant language detection job in progress.
|
1300
1424
|
#
|
1301
|
-
# If the job state is `IN_PROGRESS` the job
|
1302
|
-
#
|
1425
|
+
# If the job state is `IN_PROGRESS` the job is marked for termination
|
1426
|
+
# and put into the `STOP_REQUESTED` state. If the job completes before
|
1427
|
+
# it can be stopped, it is put into the `COMPLETED` state; otherwise the
|
1428
|
+
# job is stopped and put into the `STOPPED` state.
|
1303
1429
|
#
|
1304
1430
|
# If the job is in the `COMPLETED` or `FAILED` state when you call the
|
1305
|
-
# `StopDominantLanguageDetectionJob` operation, the operation
|
1306
|
-
#
|
1431
|
+
# `StopDominantLanguageDetectionJob` operation, the operation returns a
|
1432
|
+
# 400 Internal Request Exception.
|
1307
1433
|
#
|
1308
|
-
# When a job is stopped, any
|
1309
|
-
#
|
1434
|
+
# When a job is stopped, any documents already processed are written to
|
1435
|
+
# the output location.
|
1310
1436
|
#
|
1311
1437
|
# @option params [required, String] :job_id
|
1312
1438
|
# The identifier of the dominant language detection job to stop.
|
@@ -1338,15 +1464,17 @@ module Aws::Comprehend
|
|
1338
1464
|
|
1339
1465
|
# Stops an entities detection job in progress.
|
1340
1466
|
#
|
1341
|
-
# If the job state is `IN_PROGRESS` the job
|
1342
|
-
#
|
1467
|
+
# If the job state is `IN_PROGRESS` the job is marked for termination
|
1468
|
+
# and put into the `STOP_REQUESTED` state. If the job completes before
|
1469
|
+
# it can be stopped, it is put into the `COMPLETED` state; otherwise the
|
1470
|
+
# job is stopped and put into the `STOPPED` state.
|
1343
1471
|
#
|
1344
1472
|
# If the job is in the `COMPLETED` or `FAILED` state when you call the
|
1345
|
-
# `StopDominantLanguageDetectionJob` operation, the operation
|
1346
|
-
#
|
1473
|
+
# `StopDominantLanguageDetectionJob` operation, the operation returns a
|
1474
|
+
# 400 Internal Request Exception.
|
1347
1475
|
#
|
1348
|
-
# When a job is stopped, any
|
1349
|
-
#
|
1476
|
+
# When a job is stopped, any documents already processed are written to
|
1477
|
+
# the output location.
|
1350
1478
|
#
|
1351
1479
|
# @option params [required, String] :job_id
|
1352
1480
|
# The identifier of the entities detection job to stop.
|
@@ -1378,15 +1506,17 @@ module Aws::Comprehend
|
|
1378
1506
|
|
1379
1507
|
# Stops a key phrases detection job in progress.
|
1380
1508
|
#
|
1381
|
-
# If the job state is `IN_PROGRESS` the job
|
1382
|
-
#
|
1509
|
+
# If the job state is `IN_PROGRESS` the job is marked for termination
|
1510
|
+
# and put into the `STOP_REQUESTED` state. If the job completes before
|
1511
|
+
# it can be stopped, it is put into the `COMPLETED` state; otherwise the
|
1512
|
+
# job is stopped and put into the `STOPPED` state.
|
1383
1513
|
#
|
1384
1514
|
# If the job is in the `COMPLETED` or `FAILED` state when you call the
|
1385
|
-
# `StopDominantLanguageDetectionJob` operation, the operation
|
1386
|
-
#
|
1515
|
+
# `StopDominantLanguageDetectionJob` operation, the operation returns a
|
1516
|
+
# 400 Internal Request Exception.
|
1387
1517
|
#
|
1388
|
-
# When a job is stopped, any
|
1389
|
-
#
|
1518
|
+
# When a job is stopped, any documents already processed are written to
|
1519
|
+
# the output location.
|
1390
1520
|
#
|
1391
1521
|
# @option params [required, String] :job_id
|
1392
1522
|
# The identifier of the key phrases detection job to stop.
|
@@ -1418,15 +1548,17 @@ module Aws::Comprehend
|
|
1418
1548
|
|
1419
1549
|
# Stops a sentiment detection job in progress.
|
1420
1550
|
#
|
1421
|
-
# If the job state is `IN_PROGRESS` the job
|
1422
|
-
#
|
1551
|
+
# If the job state is `IN_PROGRESS` the job is marked for termination
|
1552
|
+
# and put into the `STOP_REQUESTED` state. If the job completes before
|
1553
|
+
# it can be stopped, it is put into the `COMPLETED` state; otherwise the
|
1554
|
+
# job is be stopped and put into the `STOPPED` state.
|
1423
1555
|
#
|
1424
1556
|
# If the job is in the `COMPLETED` or `FAILED` state when you call the
|
1425
|
-
# `StopDominantLanguageDetectionJob` operation, the operation
|
1426
|
-
#
|
1557
|
+
# `StopDominantLanguageDetectionJob` operation, the operation returns a
|
1558
|
+
# 400 Internal Request Exception.
|
1427
1559
|
#
|
1428
|
-
# When a job is stopped, any
|
1429
|
-
#
|
1560
|
+
# When a job is stopped, any documents already processed are written to
|
1561
|
+
# the output location.
|
1430
1562
|
#
|
1431
1563
|
# @option params [required, String] :job_id
|
1432
1564
|
# The identifier of the sentiment detection job to stop.
|
@@ -1469,7 +1601,7 @@ module Aws::Comprehend
|
|
1469
1601
|
params: params,
|
1470
1602
|
config: config)
|
1471
1603
|
context[:gem_name] = 'aws-sdk-comprehend'
|
1472
|
-
context[:gem_version] = '1.
|
1604
|
+
context[:gem_version] = '1.3.0'
|
1473
1605
|
Seahorse::Client::Request.new(handlers, context)
|
1474
1606
|
end
|
1475
1607
|
|
@@ -24,6 +24,9 @@ module Aws::Comprehend
|
|
24
24
|
BatchDetectSentimentItemResult = Shapes::StructureShape.new(name: 'BatchDetectSentimentItemResult')
|
25
25
|
BatchDetectSentimentRequest = Shapes::StructureShape.new(name: 'BatchDetectSentimentRequest')
|
26
26
|
BatchDetectSentimentResponse = Shapes::StructureShape.new(name: 'BatchDetectSentimentResponse')
|
27
|
+
BatchDetectSyntaxItemResult = Shapes::StructureShape.new(name: 'BatchDetectSyntaxItemResult')
|
28
|
+
BatchDetectSyntaxRequest = Shapes::StructureShape.new(name: 'BatchDetectSyntaxRequest')
|
29
|
+
BatchDetectSyntaxResponse = Shapes::StructureShape.new(name: 'BatchDetectSyntaxResponse')
|
27
30
|
BatchItemError = Shapes::StructureShape.new(name: 'BatchItemError')
|
28
31
|
BatchItemErrorList = Shapes::ListShape.new(name: 'BatchItemErrorList')
|
29
32
|
BatchSizeLimitExceededException = Shapes::StructureShape.new(name: 'BatchSizeLimitExceededException')
|
@@ -46,6 +49,8 @@ module Aws::Comprehend
|
|
46
49
|
DetectKeyPhrasesResponse = Shapes::StructureShape.new(name: 'DetectKeyPhrasesResponse')
|
47
50
|
DetectSentimentRequest = Shapes::StructureShape.new(name: 'DetectSentimentRequest')
|
48
51
|
DetectSentimentResponse = Shapes::StructureShape.new(name: 'DetectSentimentResponse')
|
52
|
+
DetectSyntaxRequest = Shapes::StructureShape.new(name: 'DetectSyntaxRequest')
|
53
|
+
DetectSyntaxResponse = Shapes::StructureShape.new(name: 'DetectSyntaxResponse')
|
49
54
|
DominantLanguage = Shapes::StructureShape.new(name: 'DominantLanguage')
|
50
55
|
DominantLanguageDetectionJobFilter = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobFilter')
|
51
56
|
DominantLanguageDetectionJobProperties = Shapes::StructureShape.new(name: 'DominantLanguageDetectionJobProperties')
|
@@ -82,9 +87,11 @@ module Aws::Comprehend
|
|
82
87
|
ListOfDetectEntitiesResult = Shapes::ListShape.new(name: 'ListOfDetectEntitiesResult')
|
83
88
|
ListOfDetectKeyPhrasesResult = Shapes::ListShape.new(name: 'ListOfDetectKeyPhrasesResult')
|
84
89
|
ListOfDetectSentimentResult = Shapes::ListShape.new(name: 'ListOfDetectSentimentResult')
|
90
|
+
ListOfDetectSyntaxResult = Shapes::ListShape.new(name: 'ListOfDetectSyntaxResult')
|
85
91
|
ListOfDominantLanguages = Shapes::ListShape.new(name: 'ListOfDominantLanguages')
|
86
92
|
ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
|
87
93
|
ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
|
94
|
+
ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
|
88
95
|
ListSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsRequest')
|
89
96
|
ListSentimentDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsResponse')
|
90
97
|
ListTopicsDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsRequest')
|
@@ -92,6 +99,8 @@ module Aws::Comprehend
|
|
92
99
|
MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
|
93
100
|
NumberOfTopicsInteger = Shapes::IntegerShape.new(name: 'NumberOfTopicsInteger')
|
94
101
|
OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
|
102
|
+
PartOfSpeechTag = Shapes::StructureShape.new(name: 'PartOfSpeechTag')
|
103
|
+
PartOfSpeechTagType = Shapes::StringShape.new(name: 'PartOfSpeechTagType')
|
95
104
|
S3Uri = Shapes::StringShape.new(name: 'S3Uri')
|
96
105
|
SentimentDetectionJobFilter = Shapes::StructureShape.new(name: 'SentimentDetectionJobFilter')
|
97
106
|
SentimentDetectionJobProperties = Shapes::StructureShape.new(name: 'SentimentDetectionJobProperties')
|
@@ -118,6 +127,8 @@ module Aws::Comprehend
|
|
118
127
|
StopSentimentDetectionJobResponse = Shapes::StructureShape.new(name: 'StopSentimentDetectionJobResponse')
|
119
128
|
String = Shapes::StringShape.new(name: 'String')
|
120
129
|
StringList = Shapes::ListShape.new(name: 'StringList')
|
130
|
+
SyntaxLanguageCode = Shapes::StringShape.new(name: 'SyntaxLanguageCode')
|
131
|
+
SyntaxToken = Shapes::StructureShape.new(name: 'SyntaxToken')
|
121
132
|
TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
|
122
133
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
123
134
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
@@ -174,6 +185,18 @@ module Aws::Comprehend
|
|
174
185
|
BatchDetectSentimentResponse.add_member(:error_list, Shapes::ShapeRef.new(shape: BatchItemErrorList, required: true, location_name: "ErrorList"))
|
175
186
|
BatchDetectSentimentResponse.struct_class = Types::BatchDetectSentimentResponse
|
176
187
|
|
188
|
+
BatchDetectSyntaxItemResult.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "Index"))
|
189
|
+
BatchDetectSyntaxItemResult.add_member(:syntax_tokens, Shapes::ShapeRef.new(shape: ListOfSyntaxTokens, location_name: "SyntaxTokens"))
|
190
|
+
BatchDetectSyntaxItemResult.struct_class = Types::BatchDetectSyntaxItemResult
|
191
|
+
|
192
|
+
BatchDetectSyntaxRequest.add_member(:text_list, Shapes::ShapeRef.new(shape: StringList, required: true, location_name: "TextList"))
|
193
|
+
BatchDetectSyntaxRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: SyntaxLanguageCode, required: true, location_name: "LanguageCode"))
|
194
|
+
BatchDetectSyntaxRequest.struct_class = Types::BatchDetectSyntaxRequest
|
195
|
+
|
196
|
+
BatchDetectSyntaxResponse.add_member(:result_list, Shapes::ShapeRef.new(shape: ListOfDetectSyntaxResult, required: true, location_name: "ResultList"))
|
197
|
+
BatchDetectSyntaxResponse.add_member(:error_list, Shapes::ShapeRef.new(shape: BatchItemErrorList, required: true, location_name: "ErrorList"))
|
198
|
+
BatchDetectSyntaxResponse.struct_class = Types::BatchDetectSyntaxResponse
|
199
|
+
|
177
200
|
BatchItemError.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "Index"))
|
178
201
|
BatchItemError.add_member(:error_code, Shapes::ShapeRef.new(shape: String, location_name: "ErrorCode"))
|
179
202
|
BatchItemError.add_member(:error_message, Shapes::ShapeRef.new(shape: String, location_name: "ErrorMessage"))
|
@@ -239,6 +262,13 @@ module Aws::Comprehend
|
|
239
262
|
DetectSentimentResponse.add_member(:sentiment_score, Shapes::ShapeRef.new(shape: SentimentScore, location_name: "SentimentScore"))
|
240
263
|
DetectSentimentResponse.struct_class = Types::DetectSentimentResponse
|
241
264
|
|
265
|
+
DetectSyntaxRequest.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Text"))
|
266
|
+
DetectSyntaxRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: SyntaxLanguageCode, required: true, location_name: "LanguageCode"))
|
267
|
+
DetectSyntaxRequest.struct_class = Types::DetectSyntaxRequest
|
268
|
+
|
269
|
+
DetectSyntaxResponse.add_member(:syntax_tokens, Shapes::ShapeRef.new(shape: ListOfSyntaxTokens, location_name: "SyntaxTokens"))
|
270
|
+
DetectSyntaxResponse.struct_class = Types::DetectSyntaxResponse
|
271
|
+
|
242
272
|
DominantLanguage.add_member(:language_code, Shapes::ShapeRef.new(shape: String, location_name: "LanguageCode"))
|
243
273
|
DominantLanguage.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
244
274
|
DominantLanguage.struct_class = Types::DominantLanguage
|
@@ -257,6 +287,7 @@ module Aws::Comprehend
|
|
257
287
|
DominantLanguageDetectionJobProperties.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
258
288
|
DominantLanguageDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
259
289
|
DominantLanguageDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
290
|
+
DominantLanguageDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
260
291
|
DominantLanguageDetectionJobProperties.struct_class = Types::DominantLanguageDetectionJobProperties
|
261
292
|
|
262
293
|
DominantLanguageDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: DominantLanguageDetectionJobProperties)
|
@@ -276,6 +307,7 @@ module Aws::Comprehend
|
|
276
307
|
EntitiesDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
277
308
|
EntitiesDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
278
309
|
EntitiesDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
310
|
+
EntitiesDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
279
311
|
EntitiesDetectionJobProperties.struct_class = Types::EntitiesDetectionJobProperties
|
280
312
|
|
281
313
|
EntitiesDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: EntitiesDetectionJobProperties)
|
@@ -312,6 +344,7 @@ module Aws::Comprehend
|
|
312
344
|
KeyPhrasesDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
313
345
|
KeyPhrasesDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
314
346
|
KeyPhrasesDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
347
|
+
KeyPhrasesDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
315
348
|
KeyPhrasesDetectionJobProperties.struct_class = Types::KeyPhrasesDetectionJobProperties
|
316
349
|
|
317
350
|
KeyPhrasesDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: KeyPhrasesDetectionJobProperties)
|
@@ -351,12 +384,16 @@ module Aws::Comprehend
|
|
351
384
|
|
352
385
|
ListOfDetectSentimentResult.member = Shapes::ShapeRef.new(shape: BatchDetectSentimentItemResult)
|
353
386
|
|
387
|
+
ListOfDetectSyntaxResult.member = Shapes::ShapeRef.new(shape: BatchDetectSyntaxItemResult)
|
388
|
+
|
354
389
|
ListOfDominantLanguages.member = Shapes::ShapeRef.new(shape: DominantLanguage)
|
355
390
|
|
356
391
|
ListOfEntities.member = Shapes::ShapeRef.new(shape: Entity)
|
357
392
|
|
358
393
|
ListOfKeyPhrases.member = Shapes::ShapeRef.new(shape: KeyPhrase)
|
359
394
|
|
395
|
+
ListOfSyntaxTokens.member = Shapes::ShapeRef.new(shape: SyntaxToken)
|
396
|
+
|
360
397
|
ListSentimentDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: SentimentDetectionJobFilter, location_name: "Filter"))
|
361
398
|
ListSentimentDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
362
399
|
ListSentimentDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
|
@@ -378,6 +415,10 @@ module Aws::Comprehend
|
|
378
415
|
OutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
|
379
416
|
OutputDataConfig.struct_class = Types::OutputDataConfig
|
380
417
|
|
418
|
+
PartOfSpeechTag.add_member(:tag, Shapes::ShapeRef.new(shape: PartOfSpeechTagType, location_name: "Tag"))
|
419
|
+
PartOfSpeechTag.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
|
420
|
+
PartOfSpeechTag.struct_class = Types::PartOfSpeechTag
|
421
|
+
|
381
422
|
SentimentDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
382
423
|
SentimentDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
383
424
|
SentimentDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
@@ -393,6 +434,7 @@ module Aws::Comprehend
|
|
393
434
|
SentimentDetectionJobProperties.add_member(:input_data_config, Shapes::ShapeRef.new(shape: InputDataConfig, location_name: "InputDataConfig"))
|
394
435
|
SentimentDetectionJobProperties.add_member(:output_data_config, Shapes::ShapeRef.new(shape: OutputDataConfig, location_name: "OutputDataConfig"))
|
395
436
|
SentimentDetectionJobProperties.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
437
|
+
SentimentDetectionJobProperties.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "DataAccessRoleArn"))
|
396
438
|
SentimentDetectionJobProperties.struct_class = Types::SentimentDetectionJobProperties
|
397
439
|
|
398
440
|
SentimentDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: SentimentDetectionJobProperties)
|
@@ -492,6 +534,13 @@ module Aws::Comprehend
|
|
492
534
|
|
493
535
|
StringList.member = Shapes::ShapeRef.new(shape: String)
|
494
536
|
|
537
|
+
SyntaxToken.add_member(:token_id, Shapes::ShapeRef.new(shape: Integer, location_name: "TokenId"))
|
538
|
+
SyntaxToken.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
|
539
|
+
SyntaxToken.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
|
540
|
+
SyntaxToken.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
|
541
|
+
SyntaxToken.add_member(:part_of_speech, Shapes::ShapeRef.new(shape: PartOfSpeechTag, location_name: "PartOfSpeech"))
|
542
|
+
SyntaxToken.struct_class = Types::SyntaxToken
|
543
|
+
|
495
544
|
TopicsDetectionJobFilter.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
496
545
|
TopicsDetectionJobFilter.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
497
546
|
TopicsDetectionJobFilter.add_member(:submit_time_before, Shapes::ShapeRef.new(shape: Timestamp, location_name: "SubmitTimeBefore"))
|
@@ -578,6 +627,19 @@ module Aws::Comprehend
|
|
578
627
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
579
628
|
end)
|
580
629
|
|
630
|
+
api.add_operation(:batch_detect_syntax, Seahorse::Model::Operation.new.tap do |o|
|
631
|
+
o.name = "BatchDetectSyntax"
|
632
|
+
o.http_method = "POST"
|
633
|
+
o.http_request_uri = "/"
|
634
|
+
o.input = Shapes::ShapeRef.new(shape: BatchDetectSyntaxRequest)
|
635
|
+
o.output = Shapes::ShapeRef.new(shape: BatchDetectSyntaxResponse)
|
636
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
637
|
+
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
638
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
639
|
+
o.errors << Shapes::ShapeRef.new(shape: BatchSizeLimitExceededException)
|
640
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
641
|
+
end)
|
642
|
+
|
581
643
|
api.add_operation(:describe_dominant_language_detection_job, Seahorse::Model::Operation.new.tap do |o|
|
582
644
|
o.name = "DescribeDominantLanguageDetectionJob"
|
583
645
|
o.http_method = "POST"
|
@@ -685,6 +747,18 @@ module Aws::Comprehend
|
|
685
747
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
686
748
|
end)
|
687
749
|
|
750
|
+
api.add_operation(:detect_syntax, Seahorse::Model::Operation.new.tap do |o|
|
751
|
+
o.name = "DetectSyntax"
|
752
|
+
o.http_method = "POST"
|
753
|
+
o.http_request_uri = "/"
|
754
|
+
o.input = Shapes::ShapeRef.new(shape: DetectSyntaxRequest)
|
755
|
+
o.output = Shapes::ShapeRef.new(shape: DetectSyntaxResponse)
|
756
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
757
|
+
o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
|
758
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
|
759
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
760
|
+
end)
|
761
|
+
|
688
762
|
api.add_operation(:list_dominant_language_detection_jobs, Seahorse::Model::Operation.new.tap do |o|
|
689
763
|
o.name = "ListDominantLanguageDetectionJobs"
|
690
764
|
o.http_method = "POST"
|
@@ -286,6 +286,76 @@ module Aws::Comprehend
|
|
286
286
|
include Aws::Structure
|
287
287
|
end
|
288
288
|
|
289
|
+
# The result of calling the operation. The operation returns one object
|
290
|
+
# that is successfully processed by the operation.
|
291
|
+
#
|
292
|
+
# @!attribute [rw] index
|
293
|
+
# The zero-based index of the document in the input list.
|
294
|
+
# @return [Integer]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] syntax_tokens
|
297
|
+
# The syntax tokens for the words in the document, one token for each
|
298
|
+
# word.
|
299
|
+
# @return [Array<Types::SyntaxToken>]
|
300
|
+
#
|
301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntaxItemResult AWS API Documentation
|
302
|
+
#
|
303
|
+
class BatchDetectSyntaxItemResult < Struct.new(
|
304
|
+
:index,
|
305
|
+
:syntax_tokens)
|
306
|
+
include Aws::Structure
|
307
|
+
end
|
308
|
+
|
309
|
+
# @note When making an API call, you may pass BatchDetectSyntaxRequest
|
310
|
+
# data as a hash:
|
311
|
+
#
|
312
|
+
# {
|
313
|
+
# text_list: ["String"], # required
|
314
|
+
# language_code: "en", # required, accepts en
|
315
|
+
# }
|
316
|
+
#
|
317
|
+
# @!attribute [rw] text_list
|
318
|
+
# A list containing the text of the input documents. The list can
|
319
|
+
# contain a maximum of 25 documents. Each document must contain fewer
|
320
|
+
# that 5,000 bytes of UTF-8 encoded characters.
|
321
|
+
# @return [Array<String>]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] language_code
|
324
|
+
# The language of the input documents. You can specify English
|
325
|
+
# ("en") or Spanish ("es"). All documents must be in the same
|
326
|
+
# language.
|
327
|
+
# @return [String]
|
328
|
+
#
|
329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntaxRequest AWS API Documentation
|
330
|
+
#
|
331
|
+
class BatchDetectSyntaxRequest < Struct.new(
|
332
|
+
:text_list,
|
333
|
+
:language_code)
|
334
|
+
include Aws::Structure
|
335
|
+
end
|
336
|
+
|
337
|
+
# @!attribute [rw] result_list
|
338
|
+
# A list of objects containing the results of the operation. The
|
339
|
+
# results are sorted in ascending order by the `Index` field and match
|
340
|
+
# the order of the documents in the input list. If all of the
|
341
|
+
# documents contain an error, the `ResultList` is empty.
|
342
|
+
# @return [Array<Types::BatchDetectSyntaxItemResult>]
|
343
|
+
#
|
344
|
+
# @!attribute [rw] error_list
|
345
|
+
# A list containing one object for each document that contained an
|
346
|
+
# error. The results are sorted in ascending order by the `Index`
|
347
|
+
# field and match the order of the documents in the input list. If
|
348
|
+
# there are no errors in the batch, the `ErrorList` is empty.
|
349
|
+
# @return [Array<Types::BatchItemError>]
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectSyntaxResponse AWS API Documentation
|
352
|
+
#
|
353
|
+
class BatchDetectSyntaxResponse < Struct.new(
|
354
|
+
:result_list,
|
355
|
+
:error_list)
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
289
359
|
# Describes an error that occurred while processing a document in a
|
290
360
|
# batch. The operation returns on `BatchItemError` object for each
|
291
361
|
# document that contained an error.
|
@@ -632,6 +702,47 @@ module Aws::Comprehend
|
|
632
702
|
include Aws::Structure
|
633
703
|
end
|
634
704
|
|
705
|
+
# @note When making an API call, you may pass DetectSyntaxRequest
|
706
|
+
# data as a hash:
|
707
|
+
#
|
708
|
+
# {
|
709
|
+
# text: "String", # required
|
710
|
+
# language_code: "en", # required, accepts en
|
711
|
+
# }
|
712
|
+
#
|
713
|
+
# @!attribute [rw] text
|
714
|
+
# A UTF-8 string. Each string must contain fewer that 5,000 bytes of
|
715
|
+
# UTF encoded characters.
|
716
|
+
# @return [String]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] language_code
|
719
|
+
# The language code of the input documents. You can specify English
|
720
|
+
# ("en") or Spanish ("es").
|
721
|
+
# @return [String]
|
722
|
+
#
|
723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntaxRequest AWS API Documentation
|
724
|
+
#
|
725
|
+
class DetectSyntaxRequest < Struct.new(
|
726
|
+
:text,
|
727
|
+
:language_code)
|
728
|
+
include Aws::Structure
|
729
|
+
end
|
730
|
+
|
731
|
+
# @!attribute [rw] syntax_tokens
|
732
|
+
# A collection of syntax tokens describing the text. For each token,
|
733
|
+
# the response provides the text, the token type, where the text
|
734
|
+
# begins and ends, and the level of confidence that Amazon Comprehend
|
735
|
+
# has that the token is correct. For a list of token types, see
|
736
|
+
# how-syntax.
|
737
|
+
# @return [Array<Types::SyntaxToken>]
|
738
|
+
#
|
739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntaxResponse AWS API Documentation
|
740
|
+
#
|
741
|
+
class DetectSyntaxResponse < Struct.new(
|
742
|
+
:syntax_tokens)
|
743
|
+
include Aws::Structure
|
744
|
+
end
|
745
|
+
|
635
746
|
# Returns the code for the dominant language in the input text and the
|
636
747
|
# level of confidence that Amazon Comprehend has in the accuracy of the
|
637
748
|
# detection.
|
@@ -744,6 +855,11 @@ module Aws::Comprehend
|
|
744
855
|
# dominant language detection job.
|
745
856
|
# @return [Types::OutputDataConfig]
|
746
857
|
#
|
858
|
+
# @!attribute [rw] data_access_role_arn
|
859
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend read
|
860
|
+
# access to your input data.
|
861
|
+
# @return [String]
|
862
|
+
#
|
747
863
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DominantLanguageDetectionJobProperties AWS API Documentation
|
748
864
|
#
|
749
865
|
class DominantLanguageDetectionJobProperties < Struct.new(
|
@@ -754,7 +870,8 @@ module Aws::Comprehend
|
|
754
870
|
:submit_time,
|
755
871
|
:end_time,
|
756
872
|
:input_data_config,
|
757
|
-
:output_data_config
|
873
|
+
:output_data_config,
|
874
|
+
:data_access_role_arn)
|
758
875
|
include Aws::Structure
|
759
876
|
end
|
760
877
|
|
@@ -846,6 +963,11 @@ module Aws::Comprehend
|
|
846
963
|
# The language code of the input documents.
|
847
964
|
# @return [String]
|
848
965
|
#
|
966
|
+
# @!attribute [rw] data_access_role_arn
|
967
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend read
|
968
|
+
# access to your input data.
|
969
|
+
# @return [String]
|
970
|
+
#
|
849
971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntitiesDetectionJobProperties AWS API Documentation
|
850
972
|
#
|
851
973
|
class EntitiesDetectionJobProperties < Struct.new(
|
@@ -857,7 +979,8 @@ module Aws::Comprehend
|
|
857
979
|
:end_time,
|
858
980
|
:input_data_config,
|
859
981
|
:output_data_config,
|
860
|
-
:language_code
|
982
|
+
:language_code,
|
983
|
+
:data_access_role_arn)
|
861
984
|
include Aws::Structure
|
862
985
|
end
|
863
986
|
|
@@ -1072,6 +1195,11 @@ module Aws::Comprehend
|
|
1072
1195
|
# The language code of the input documents.
|
1073
1196
|
# @return [String]
|
1074
1197
|
#
|
1198
|
+
# @!attribute [rw] data_access_role_arn
|
1199
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend read
|
1200
|
+
# access to your input data.
|
1201
|
+
# @return [String]
|
1202
|
+
#
|
1075
1203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrasesDetectionJobProperties AWS API Documentation
|
1076
1204
|
#
|
1077
1205
|
class KeyPhrasesDetectionJobProperties < Struct.new(
|
@@ -1083,7 +1211,8 @@ module Aws::Comprehend
|
|
1083
1211
|
:end_time,
|
1084
1212
|
:input_data_config,
|
1085
1213
|
:output_data_config,
|
1086
|
-
:language_code
|
1214
|
+
:language_code,
|
1215
|
+
:data_access_role_arn)
|
1087
1216
|
include Aws::Structure
|
1088
1217
|
end
|
1089
1218
|
|
@@ -1387,6 +1516,28 @@ module Aws::Comprehend
|
|
1387
1516
|
include Aws::Structure
|
1388
1517
|
end
|
1389
1518
|
|
1519
|
+
# Identifies the part of speech represented by the token and gives the
|
1520
|
+
# confidence that Amazon Comprehend has that the part of speech was
|
1521
|
+
# correctly identified. For more information about the parts of speech
|
1522
|
+
# that Amazon Comprehend can identify, see how-syntax.
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] tag
|
1525
|
+
# Identifies the part of speech that the token represents.
|
1526
|
+
# @return [String]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] score
|
1529
|
+
# The confidence that Amazon Comprehend has that the part of speech
|
1530
|
+
# was correctly identified.
|
1531
|
+
# @return [Float]
|
1532
|
+
#
|
1533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PartOfSpeechTag AWS API Documentation
|
1534
|
+
#
|
1535
|
+
class PartOfSpeechTag < Struct.new(
|
1536
|
+
:tag,
|
1537
|
+
:score)
|
1538
|
+
include Aws::Structure
|
1539
|
+
end
|
1540
|
+
|
1390
1541
|
# Provides information for filtering a list of dominant language
|
1391
1542
|
# detection jobs. For more information, see the operation.
|
1392
1543
|
#
|
@@ -1475,6 +1626,11 @@ module Aws::Comprehend
|
|
1475
1626
|
# The language code of the input documents.
|
1476
1627
|
# @return [String]
|
1477
1628
|
#
|
1629
|
+
# @!attribute [rw] data_access_role_arn
|
1630
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend read
|
1631
|
+
# access to your input data.
|
1632
|
+
# @return [String]
|
1633
|
+
#
|
1478
1634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SentimentDetectionJobProperties AWS API Documentation
|
1479
1635
|
#
|
1480
1636
|
class SentimentDetectionJobProperties < Struct.new(
|
@@ -1486,7 +1642,8 @@ module Aws::Comprehend
|
|
1486
1642
|
:end_time,
|
1487
1643
|
:input_data_config,
|
1488
1644
|
:output_data_config,
|
1489
|
-
:language_code
|
1645
|
+
:language_code,
|
1646
|
+
:data_access_role_arn)
|
1490
1647
|
include Aws::Structure
|
1491
1648
|
end
|
1492
1649
|
|
@@ -1548,9 +1705,14 @@ module Aws::Comprehend
|
|
1548
1705
|
# @return [Types::OutputDataConfig]
|
1549
1706
|
#
|
1550
1707
|
# @!attribute [rw] data_access_role_arn
|
1551
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
1552
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
1553
|
-
# data.
|
1708
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1709
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1710
|
+
# your input data. For more information, see
|
1711
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1712
|
+
#
|
1713
|
+
#
|
1714
|
+
#
|
1715
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1554
1716
|
# @return [String]
|
1555
1717
|
#
|
1556
1718
|
# @!attribute [rw] job_name
|
@@ -1630,9 +1792,14 @@ module Aws::Comprehend
|
|
1630
1792
|
# @return [Types::OutputDataConfig]
|
1631
1793
|
#
|
1632
1794
|
# @!attribute [rw] data_access_role_arn
|
1633
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
1634
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
1635
|
-
# data.
|
1795
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1796
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1797
|
+
# your input data. For more information, see
|
1798
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1799
|
+
#
|
1800
|
+
#
|
1801
|
+
#
|
1802
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1636
1803
|
# @return [String]
|
1637
1804
|
#
|
1638
1805
|
# @!attribute [rw] job_name
|
@@ -1719,9 +1886,14 @@ module Aws::Comprehend
|
|
1719
1886
|
# @return [Types::OutputDataConfig]
|
1720
1887
|
#
|
1721
1888
|
# @!attribute [rw] data_access_role_arn
|
1722
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
1723
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
1724
|
-
# data.
|
1889
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1890
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1891
|
+
# your input data. For more information, see
|
1892
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1893
|
+
#
|
1894
|
+
#
|
1895
|
+
#
|
1896
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1725
1897
|
# @return [String]
|
1726
1898
|
#
|
1727
1899
|
# @!attribute [rw] job_name
|
@@ -1808,9 +1980,14 @@ module Aws::Comprehend
|
|
1808
1980
|
# @return [Types::OutputDataConfig]
|
1809
1981
|
#
|
1810
1982
|
# @!attribute [rw] data_access_role_arn
|
1811
|
-
# The Amazon Resource Name (ARN) of the AWS Identity and
|
1812
|
-
# (IAM) role that grants Amazon Comprehend read access to
|
1813
|
-
# data.
|
1983
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1984
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
1985
|
+
# your input data. For more information, see
|
1986
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
1987
|
+
#
|
1988
|
+
#
|
1989
|
+
#
|
1990
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1814
1991
|
# @return [String]
|
1815
1992
|
#
|
1816
1993
|
# @!attribute [rw] job_name
|
@@ -1902,7 +2079,12 @@ module Aws::Comprehend
|
|
1902
2079
|
# @!attribute [rw] data_access_role_arn
|
1903
2080
|
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
1904
2081
|
# Management (IAM) role that grants Amazon Comprehend read access to
|
1905
|
-
# your input data.
|
2082
|
+
# your input data. For more information, see
|
2083
|
+
# [https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions][1].
|
2084
|
+
#
|
2085
|
+
#
|
2086
|
+
#
|
2087
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions
|
1906
2088
|
# @return [String]
|
1907
2089
|
#
|
1908
2090
|
# @!attribute [rw] job_name
|
@@ -1984,8 +2166,8 @@ module Aws::Comprehend
|
|
1984
2166
|
# @return [String]
|
1985
2167
|
#
|
1986
2168
|
# @!attribute [rw] job_status
|
1987
|
-
# Either `
|
1988
|
-
# the job was previously stopped with the
|
2169
|
+
# Either `STOP_REQUESTED` if the job is currently running, or
|
2170
|
+
# `STOPPED` if the job was previously stopped with the
|
1989
2171
|
# `StopDominantLanguageDetectionJob` operation.
|
1990
2172
|
# @return [String]
|
1991
2173
|
#
|
@@ -2020,9 +2202,9 @@ module Aws::Comprehend
|
|
2020
2202
|
# @return [String]
|
2021
2203
|
#
|
2022
2204
|
# @!attribute [rw] job_status
|
2023
|
-
# Either `
|
2024
|
-
# the job was previously stopped with the
|
2025
|
-
# operation.
|
2205
|
+
# Either `STOP_REQUESTED` if the job is currently running, or
|
2206
|
+
# `STOPPED` if the job was previously stopped with the
|
2207
|
+
# `StopEntitiesDetectionJob` operation.
|
2026
2208
|
# @return [String]
|
2027
2209
|
#
|
2028
2210
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEntitiesDetectionJobResponse AWS API Documentation
|
@@ -2056,9 +2238,9 @@ module Aws::Comprehend
|
|
2056
2238
|
# @return [String]
|
2057
2239
|
#
|
2058
2240
|
# @!attribute [rw] job_status
|
2059
|
-
# Either `
|
2060
|
-
# the job was previously stopped with the
|
2061
|
-
# operation.
|
2241
|
+
# Either `STOP_REQUESTED` if the job is currently running, or
|
2242
|
+
# `STOPPED` if the job was previously stopped with the
|
2243
|
+
# `StopKeyPhrasesDetectionJob` operation.
|
2062
2244
|
# @return [String]
|
2063
2245
|
#
|
2064
2246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopKeyPhrasesDetectionJobResponse AWS API Documentation
|
@@ -2092,9 +2274,9 @@ module Aws::Comprehend
|
|
2092
2274
|
# @return [String]
|
2093
2275
|
#
|
2094
2276
|
# @!attribute [rw] job_status
|
2095
|
-
# Either `
|
2096
|
-
# the job was previously stopped with the
|
2097
|
-
# operation.
|
2277
|
+
# Either `STOP_REQUESTED` if the job is currently running, or
|
2278
|
+
# `STOPPED` if the job was previously stopped with the
|
2279
|
+
# `StopSentimentDetectionJob` operation.
|
2098
2280
|
# @return [String]
|
2099
2281
|
#
|
2100
2282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopSentimentDetectionJobResponse AWS API Documentation
|
@@ -2105,6 +2287,45 @@ module Aws::Comprehend
|
|
2105
2287
|
include Aws::Structure
|
2106
2288
|
end
|
2107
2289
|
|
2290
|
+
# Represents a work in the input text that was recognized and assigned a
|
2291
|
+
# part of speech. There is one syntax token record for each word in the
|
2292
|
+
# source text.
|
2293
|
+
#
|
2294
|
+
# @!attribute [rw] token_id
|
2295
|
+
# A unique identifier for a token.
|
2296
|
+
# @return [Integer]
|
2297
|
+
#
|
2298
|
+
# @!attribute [rw] text
|
2299
|
+
# The word that was recognized in the source text.
|
2300
|
+
# @return [String]
|
2301
|
+
#
|
2302
|
+
# @!attribute [rw] begin_offset
|
2303
|
+
# The zero-based offset from the beginning of the source text to the
|
2304
|
+
# first character in the word.
|
2305
|
+
# @return [Integer]
|
2306
|
+
#
|
2307
|
+
# @!attribute [rw] end_offset
|
2308
|
+
# The zero-based offset from the beginning of the source text to the
|
2309
|
+
# last character in the word.
|
2310
|
+
# @return [Integer]
|
2311
|
+
#
|
2312
|
+
# @!attribute [rw] part_of_speech
|
2313
|
+
# Provides the part of speech label and the confidence level that
|
2314
|
+
# Amazon Comprehend has that the part of speech was correctly
|
2315
|
+
# identified. For more information, see how-syntax.
|
2316
|
+
# @return [Types::PartOfSpeechTag]
|
2317
|
+
#
|
2318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SyntaxToken AWS API Documentation
|
2319
|
+
#
|
2320
|
+
class SyntaxToken < Struct.new(
|
2321
|
+
:token_id,
|
2322
|
+
:text,
|
2323
|
+
:begin_offset,
|
2324
|
+
:end_offset,
|
2325
|
+
:part_of_speech)
|
2326
|
+
include Aws::Structure
|
2327
|
+
end
|
2328
|
+
|
2108
2329
|
# Provides information for filtering topic detection jobs. For more
|
2109
2330
|
# information, see .
|
2110
2331
|
#
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-comprehend
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-07-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|