aws-sdk-comprehend 1.60.0 → 1.62.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehend/client.rb +241 -56
- data/lib/aws-sdk-comprehend/client_api.rb +82 -0
- data/lib/aws-sdk-comprehend/types.rb +346 -90
- data/lib/aws-sdk-comprehend.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b2b0ff29417aa35c35084fa9357970b72b02f674261ec69b68401baffccedd3d
|
4
|
+
data.tar.gz: 284edfaefd2215cd9783ab96c6535b0e50c1b6f763067f51a32ef2ac501e9952
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1433313b3641640353668d8e0f6f9f007ca8d7b7ef645bb210b9c05ebdf7f8172d4a545bf27179c8bd5ab7b3a33eefacfff093b57f10113b5bc0a06e1ec70ddb
|
7
|
+
data.tar.gz: 48864026f184295c7e9c9945286ea283dee6eb418dee073595c9a40113fc90201324089751874f8b1a72bca52a8e6c9dcb31b07ac29a39698c9f9911e26f07d7
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.62.0 (2022-09-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Comprehend now supports synchronous mode for targeted sentiment API operations.
|
8
|
+
|
9
|
+
1.61.0 (2022-05-20)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Comprehend releases 14 new entity types for DetectPiiEntities and ContainsPiiEntities APIs.
|
13
|
+
|
4
14
|
1.60.0 (2022-03-09)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.62.0
|
@@ -370,10 +370,10 @@ module Aws::Comprehend
|
|
370
370
|
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html
|
371
371
|
#
|
372
372
|
# @option params [required, Array<String>] :text_list
|
373
|
-
# A list containing the text of the input documents. The
|
374
|
-
# contain a maximum of 25 documents. Each document should
|
375
|
-
# least 20 characters
|
376
|
-
#
|
373
|
+
# A list containing the UTF-8 encoded text of the input documents. The
|
374
|
+
# list can contain a maximum of 25 documents. Each document should
|
375
|
+
# contain at least 20 characters. The maximum size of each document is 5
|
376
|
+
# KB.
|
377
377
|
#
|
378
378
|
# @return [Types::BatchDetectDominantLanguageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
379
379
|
#
|
@@ -409,12 +409,16 @@ module Aws::Comprehend
|
|
409
409
|
|
410
410
|
# Inspects the text of a batch of documents for named entities and
|
411
411
|
# returns information about them. For more information about named
|
412
|
-
# entities, see
|
412
|
+
# entities, see [Entities][1] in the Comprehend Developer Guide.
|
413
|
+
#
|
414
|
+
#
|
415
|
+
#
|
416
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html
|
413
417
|
#
|
414
418
|
# @option params [required, Array<String>] :text_list
|
415
|
-
# A list containing the text of the input documents. The
|
416
|
-
# contain a maximum of 25 documents.
|
417
|
-
#
|
419
|
+
# A list containing the UTF-8 encoded text of the input documents. The
|
420
|
+
# list can contain a maximum of 25 documents. The maximum size of each
|
421
|
+
# document is 5 KB.
|
418
422
|
#
|
419
423
|
# @option params [required, String] :language_code
|
420
424
|
# The language of the input documents. You can specify any of the
|
@@ -460,9 +464,9 @@ module Aws::Comprehend
|
|
460
464
|
# Detects the key noun phrases found in a batch of documents.
|
461
465
|
#
|
462
466
|
# @option params [required, Array<String>] :text_list
|
463
|
-
# A list containing the text of the input documents. The
|
464
|
-
# contain a maximum of 25 documents.
|
465
|
-
#
|
467
|
+
# A list containing the UTF-8 encoded text of the input documents. The
|
468
|
+
# list can contain a maximum of 25 documents. The maximum size of each
|
469
|
+
# document is 5 KB.
|
466
470
|
#
|
467
471
|
# @option params [required, String] :language_code
|
468
472
|
# The language of the input documents. You can specify any of the
|
@@ -509,9 +513,15 @@ module Aws::Comprehend
|
|
509
513
|
# in each one.
|
510
514
|
#
|
511
515
|
# @option params [required, Array<String>] :text_list
|
512
|
-
# A list containing the text of the input documents. The
|
513
|
-
# contain a maximum of 25 documents.
|
514
|
-
#
|
516
|
+
# A list containing the UTF-8 encoded text of the input documents. The
|
517
|
+
# list can contain a maximum of 25 documents. The maximum size of each
|
518
|
+
# document is 5 KB.
|
519
|
+
#
|
520
|
+
# <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
|
521
|
+
# 500 characters of the input text and ignores any additional text in
|
522
|
+
# the input.
|
523
|
+
#
|
524
|
+
# </note>
|
515
525
|
#
|
516
526
|
# @option params [required, String] :language_code
|
517
527
|
# The language of the input documents. You can specify any of the
|
@@ -555,12 +565,17 @@ module Aws::Comprehend
|
|
555
565
|
|
556
566
|
# Inspects the text of a batch of documents for the syntax and part of
|
557
567
|
# speech of the words in the document and returns information about
|
558
|
-
# them. For more information, see
|
568
|
+
# them. For more information, see [Syntax][1] in the Comprehend
|
569
|
+
# Developer Guide.
|
570
|
+
#
|
571
|
+
#
|
572
|
+
#
|
573
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
|
559
574
|
#
|
560
575
|
# @option params [required, Array<String>] :text_list
|
561
|
-
# A list containing the text of the input documents. The
|
562
|
-
# contain a maximum of 25 documents.
|
563
|
-
#
|
576
|
+
# A list containing the UTF-8 encoded text of the input documents. The
|
577
|
+
# list can contain a maximum of 25 documents. The maximum size for each
|
578
|
+
# document is 5 KB.
|
564
579
|
#
|
565
580
|
# @option params [required, String] :language_code
|
566
581
|
# The language of the input documents. You can specify any of the
|
@@ -605,6 +620,70 @@ module Aws::Comprehend
|
|
605
620
|
req.send_request(options)
|
606
621
|
end
|
607
622
|
|
623
|
+
# Inspects a batch of documents and returns a sentiment analysis for
|
624
|
+
# each entity identified in the documents.
|
625
|
+
#
|
626
|
+
# For more information about targeted sentiment, see [Targeted
|
627
|
+
# sentiment][1].
|
628
|
+
#
|
629
|
+
#
|
630
|
+
#
|
631
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html
|
632
|
+
#
|
633
|
+
# @option params [required, Array<String>] :text_list
|
634
|
+
# A list containing the UTF-8 encoded text of the input documents. The
|
635
|
+
# list can contain a maximum of 25 documents. The maximum size of each
|
636
|
+
# document is 5 KB.
|
637
|
+
#
|
638
|
+
# @option params [required, String] :language_code
|
639
|
+
# The language of the input documents. Currently, English is the only
|
640
|
+
# supported language.
|
641
|
+
#
|
642
|
+
# @return [Types::BatchDetectTargetedSentimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
643
|
+
#
|
644
|
+
# * {Types::BatchDetectTargetedSentimentResponse#result_list #result_list} => Array<Types::BatchDetectTargetedSentimentItemResult>
|
645
|
+
# * {Types::BatchDetectTargetedSentimentResponse#error_list #error_list} => Array<Types::BatchItemError>
|
646
|
+
#
|
647
|
+
# @example Request syntax with placeholder values
|
648
|
+
#
|
649
|
+
# resp = client.batch_detect_targeted_sentiment({
|
650
|
+
# text_list: ["CustomerInputString"], # required
|
651
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
652
|
+
# })
|
653
|
+
#
|
654
|
+
# @example Response structure
|
655
|
+
#
|
656
|
+
# resp.result_list #=> Array
|
657
|
+
# resp.result_list[0].index #=> Integer
|
658
|
+
# resp.result_list[0].entities #=> Array
|
659
|
+
# resp.result_list[0].entities[0].descriptive_mention_index #=> Array
|
660
|
+
# resp.result_list[0].entities[0].descriptive_mention_index[0] #=> Integer
|
661
|
+
# resp.result_list[0].entities[0].mentions #=> Array
|
662
|
+
# resp.result_list[0].entities[0].mentions[0].score #=> Float
|
663
|
+
# resp.result_list[0].entities[0].mentions[0].group_score #=> Float
|
664
|
+
# resp.result_list[0].entities[0].mentions[0].text #=> String
|
665
|
+
# resp.result_list[0].entities[0].mentions[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "FACILITY", "BRAND", "COMMERCIAL_ITEM", "MOVIE", "MUSIC", "BOOK", "SOFTWARE", "GAME", "PERSONAL_TITLE", "EVENT", "DATE", "QUANTITY", "ATTRIBUTE", "OTHER"
|
666
|
+
# resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
|
667
|
+
# resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.positive #=> Float
|
668
|
+
# resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.negative #=> Float
|
669
|
+
# resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.neutral #=> Float
|
670
|
+
# resp.result_list[0].entities[0].mentions[0].mention_sentiment.sentiment_score.mixed #=> Float
|
671
|
+
# resp.result_list[0].entities[0].mentions[0].begin_offset #=> Integer
|
672
|
+
# resp.result_list[0].entities[0].mentions[0].end_offset #=> Integer
|
673
|
+
# resp.error_list #=> Array
|
674
|
+
# resp.error_list[0].index #=> Integer
|
675
|
+
# resp.error_list[0].error_code #=> String
|
676
|
+
# resp.error_list[0].error_message #=> String
|
677
|
+
#
|
678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentiment AWS API Documentation
|
679
|
+
#
|
680
|
+
# @overload batch_detect_targeted_sentiment(params = {})
|
681
|
+
# @param [Hash] params ({})
|
682
|
+
def batch_detect_targeted_sentiment(params = {}, options = {})
|
683
|
+
req = build_request(:batch_detect_targeted_sentiment, params)
|
684
|
+
req.send_request(options)
|
685
|
+
end
|
686
|
+
|
608
687
|
# Creates a new document classification request to analyze a single
|
609
688
|
# document in real-time, using a previously created and trained custom
|
610
689
|
# model and an endpoint.
|
@@ -613,7 +692,12 @@ module Aws::Comprehend
|
|
613
692
|
# The document text to be analyzed.
|
614
693
|
#
|
615
694
|
# @option params [required, String] :endpoint_arn
|
616
|
-
# The Amazon Resource Number (ARN) of the endpoint.
|
695
|
+
# The Amazon Resource Number (ARN) of the endpoint. For information
|
696
|
+
# about endpoints, see [Managing endpoints][1].
|
697
|
+
#
|
698
|
+
#
|
699
|
+
#
|
700
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
617
701
|
#
|
618
702
|
# @return [Types::ClassifyDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
619
703
|
#
|
@@ -650,12 +734,11 @@ module Aws::Comprehend
|
|
650
734
|
# types such as name, address, bank account number, or phone number.
|
651
735
|
#
|
652
736
|
# @option params [required, String] :text
|
653
|
-
#
|
654
|
-
# document in real-time, returning personally identifiable information
|
655
|
-
# (PII) entity labels.
|
737
|
+
# A UTF-8 text string. The maximum string size is 100 KB.
|
656
738
|
#
|
657
739
|
# @option params [required, String] :language_code
|
658
|
-
# The language of the input documents.
|
740
|
+
# The language of the input documents. Currently, English is the only
|
741
|
+
# valid language.
|
659
742
|
#
|
660
743
|
# @return [Types::ContainsPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
661
744
|
#
|
@@ -671,7 +754,7 @@ module Aws::Comprehend
|
|
671
754
|
# @example Response structure
|
672
755
|
#
|
673
756
|
# resp.labels #=> Array
|
674
|
-
# resp.labels[0].name #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
757
|
+
# resp.labels[0].name #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
|
675
758
|
# resp.labels[0].score #=> Float
|
676
759
|
#
|
677
760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntities AWS API Documentation
|
@@ -688,7 +771,11 @@ module Aws::Comprehend
|
|
688
771
|
# documents that labeled with the categories that you want to use. After
|
689
772
|
# the classifier is trained you can use it to categorize a set of
|
690
773
|
# labeled documents into the categories. For more information, see
|
691
|
-
#
|
774
|
+
# [Document Classification][1] in the Comprehend Developer Guide.
|
775
|
+
#
|
776
|
+
#
|
777
|
+
#
|
778
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html
|
692
779
|
#
|
693
780
|
# @option params [required, String] :document_classifier_name
|
694
781
|
# The name of the document classifier.
|
@@ -849,7 +936,12 @@ module Aws::Comprehend
|
|
849
936
|
end
|
850
937
|
|
851
938
|
# Creates a model-specific endpoint for synchronous inference for a
|
852
|
-
# previously trained custom model
|
939
|
+
# previously trained custom model For information about endpoints, see
|
940
|
+
# [Managing endpoints][1].
|
941
|
+
#
|
942
|
+
#
|
943
|
+
#
|
944
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
853
945
|
#
|
854
946
|
# @option params [required, String] :endpoint_name
|
855
947
|
# This is the descriptive suffix that becomes part of the `EndpointArn`
|
@@ -1115,7 +1207,11 @@ module Aws::Comprehend
|
|
1115
1207
|
|
1116
1208
|
# Deletes a model-specific endpoint for a previously-trained custom
|
1117
1209
|
# model. All endpoints must be deleted in order for the model to be
|
1118
|
-
# deleted.
|
1210
|
+
# deleted. For information about endpoints, see [Managing endpoints][1].
|
1211
|
+
#
|
1212
|
+
#
|
1213
|
+
#
|
1214
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
1119
1215
|
#
|
1120
1216
|
# @option params [required, String] :endpoint_arn
|
1121
1217
|
# The Amazon Resource Number (ARN) of the endpoint being deleted.
|
@@ -1368,7 +1464,12 @@ module Aws::Comprehend
|
|
1368
1464
|
end
|
1369
1465
|
|
1370
1466
|
# Gets the properties associated with a specific endpoint. Use this
|
1371
|
-
# operation to get the status of an endpoint.
|
1467
|
+
# operation to get the status of an endpoint. For information about
|
1468
|
+
# endpoints, see [Managing endpoints][1].
|
1469
|
+
#
|
1470
|
+
#
|
1471
|
+
#
|
1472
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
1372
1473
|
#
|
1373
1474
|
# @option params [required, String] :endpoint_arn
|
1374
1475
|
# The Amazon Resource Number (ARN) of the endpoint being described.
|
@@ -1664,7 +1765,7 @@ module Aws::Comprehend
|
|
1664
1765
|
# resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
|
1665
1766
|
# resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
|
1666
1767
|
# resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
|
1667
|
-
# resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
1768
|
+
# resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
|
1668
1769
|
# resp.pii_entities_detection_job_properties.redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
|
1669
1770
|
# resp.pii_entities_detection_job_properties.redaction_config.mask_character #=> String
|
1670
1771
|
# resp.pii_entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -1876,8 +1977,8 @@ module Aws::Comprehend
|
|
1876
1977
|
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html
|
1877
1978
|
#
|
1878
1979
|
# @option params [required, String] :text
|
1879
|
-
# A UTF-8 text string.
|
1880
|
-
#
|
1980
|
+
# A UTF-8 text string. The string must contain at least 20 characters.
|
1981
|
+
# The maximum string size is 100 KB.
|
1881
1982
|
#
|
1882
1983
|
# @return [Types::DetectDominantLanguageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1883
1984
|
#
|
@@ -1905,11 +2006,15 @@ module Aws::Comprehend
|
|
1905
2006
|
end
|
1906
2007
|
|
1907
2008
|
# Inspects text for named entities, and returns information about them.
|
1908
|
-
# For more information, about named entities, see
|
2009
|
+
# For more information, about named entities, see [Entities][1] in the
|
2010
|
+
# Comprehend Developer Guide.
|
2011
|
+
#
|
2012
|
+
#
|
2013
|
+
#
|
2014
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html
|
1909
2015
|
#
|
1910
2016
|
# @option params [required, String] :text
|
1911
|
-
# A UTF-8 text string.
|
1912
|
-
# of UTF-8 encoded characters.
|
2017
|
+
# A UTF-8 text string. The maximum string size is 100 KB.
|
1913
2018
|
#
|
1914
2019
|
# @option params [String] :language_code
|
1915
2020
|
# The language of the input documents. You can specify any of the
|
@@ -1930,6 +2035,12 @@ module Aws::Comprehend
|
|
1930
2035
|
# your custom model, and it ignores any language code that you provide
|
1931
2036
|
# in your request.
|
1932
2037
|
#
|
2038
|
+
# For information about endpoints, see [Managing endpoints][1].
|
2039
|
+
#
|
2040
|
+
#
|
2041
|
+
#
|
2042
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
2043
|
+
#
|
1933
2044
|
# @return [Types::DetectEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1934
2045
|
#
|
1935
2046
|
# * {Types::DetectEntitiesResponse#entities #entities} => Array<Types::Entity>
|
@@ -1963,8 +2074,8 @@ module Aws::Comprehend
|
|
1963
2074
|
# Detects the key noun phrases found in the text.
|
1964
2075
|
#
|
1965
2076
|
# @option params [required, String] :text
|
1966
|
-
# A UTF-8 text string.
|
1967
|
-
#
|
2077
|
+
# A UTF-8 text string. The string must contain less than 100 KB of UTF-8
|
2078
|
+
# encoded characters.
|
1968
2079
|
#
|
1969
2080
|
# @option params [required, String] :language_code
|
1970
2081
|
# The language of the input documents. You can specify any of the
|
@@ -2003,11 +2114,11 @@ module Aws::Comprehend
|
|
2003
2114
|
# identifiable information (PII) and returns information about them.
|
2004
2115
|
#
|
2005
2116
|
# @option params [required, String] :text
|
2006
|
-
# A UTF-8 text string.
|
2007
|
-
# of UTF-8 encoded characters.
|
2117
|
+
# A UTF-8 text string. The maximum string size is 100 KB.
|
2008
2118
|
#
|
2009
2119
|
# @option params [required, String] :language_code
|
2010
|
-
# The language of the input documents.
|
2120
|
+
# The language of the input documents. Currently, English is the only
|
2121
|
+
# valid language.
|
2011
2122
|
#
|
2012
2123
|
# @return [Types::DetectPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2013
2124
|
#
|
@@ -2024,7 +2135,7 @@ module Aws::Comprehend
|
|
2024
2135
|
#
|
2025
2136
|
# resp.entities #=> Array
|
2026
2137
|
# resp.entities[0].score #=> Float
|
2027
|
-
# resp.entities[0].type #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
2138
|
+
# resp.entities[0].type #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
|
2028
2139
|
# resp.entities[0].begin_offset #=> Integer
|
2029
2140
|
# resp.entities[0].end_offset #=> Integer
|
2030
2141
|
#
|
@@ -2041,8 +2152,13 @@ module Aws::Comprehend
|
|
2041
2152
|
# (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
|
2042
2153
|
#
|
2043
2154
|
# @option params [required, String] :text
|
2044
|
-
# A UTF-8 text string.
|
2045
|
-
#
|
2155
|
+
# A UTF-8 text string. The maximum string size is 5 KB.
|
2156
|
+
#
|
2157
|
+
# <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
|
2158
|
+
# 500 characters of the input text and ignores any additional text in
|
2159
|
+
# the input.
|
2160
|
+
#
|
2161
|
+
# </note>
|
2046
2162
|
#
|
2047
2163
|
# @option params [required, String] :language_code
|
2048
2164
|
# The language of the input documents. You can specify any of the
|
@@ -2079,11 +2195,15 @@ module Aws::Comprehend
|
|
2079
2195
|
end
|
2080
2196
|
|
2081
2197
|
# Inspects text for syntax and the part of speech of words in the
|
2082
|
-
# document. For more information,
|
2198
|
+
# document. For more information, see [Syntax][1] in the Comprehend
|
2199
|
+
# Developer Guide.
|
2200
|
+
#
|
2201
|
+
#
|
2202
|
+
#
|
2203
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
|
2083
2204
|
#
|
2084
2205
|
# @option params [required, String] :text
|
2085
|
-
# A UTF-8 string.
|
2086
|
-
# encoded characters.
|
2206
|
+
# A UTF-8 string. The maximum string size is 5 KB.
|
2087
2207
|
#
|
2088
2208
|
# @option params [required, String] :language_code
|
2089
2209
|
# The language code of the input documents. You can specify any of the
|
@@ -2121,6 +2241,61 @@ module Aws::Comprehend
|
|
2121
2241
|
req.send_request(options)
|
2122
2242
|
end
|
2123
2243
|
|
2244
|
+
# Inspects the input text and returns a sentiment analysis for each
|
2245
|
+
# entity identified in the text.
|
2246
|
+
#
|
2247
|
+
# For more information about targeted sentiment, see [Targeted
|
2248
|
+
# sentiment][1].
|
2249
|
+
#
|
2250
|
+
#
|
2251
|
+
#
|
2252
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html
|
2253
|
+
#
|
2254
|
+
# @option params [required, String] :text
|
2255
|
+
# A UTF-8 text string. The maximum string length is 5 KB.
|
2256
|
+
#
|
2257
|
+
# @option params [required, String] :language_code
|
2258
|
+
# The language of the input documents. Currently, English is the only
|
2259
|
+
# supported language.
|
2260
|
+
#
|
2261
|
+
# @return [Types::DetectTargetedSentimentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2262
|
+
#
|
2263
|
+
# * {Types::DetectTargetedSentimentResponse#entities #entities} => Array<Types::TargetedSentimentEntity>
|
2264
|
+
#
|
2265
|
+
# @example Request syntax with placeholder values
|
2266
|
+
#
|
2267
|
+
# resp = client.detect_targeted_sentiment({
|
2268
|
+
# text: "CustomerInputString", # required
|
2269
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
2270
|
+
# })
|
2271
|
+
#
|
2272
|
+
# @example Response structure
|
2273
|
+
#
|
2274
|
+
# resp.entities #=> Array
|
2275
|
+
# resp.entities[0].descriptive_mention_index #=> Array
|
2276
|
+
# resp.entities[0].descriptive_mention_index[0] #=> Integer
|
2277
|
+
# resp.entities[0].mentions #=> Array
|
2278
|
+
# resp.entities[0].mentions[0].score #=> Float
|
2279
|
+
# resp.entities[0].mentions[0].group_score #=> Float
|
2280
|
+
# resp.entities[0].mentions[0].text #=> String
|
2281
|
+
# resp.entities[0].mentions[0].type #=> String, one of "PERSON", "LOCATION", "ORGANIZATION", "FACILITY", "BRAND", "COMMERCIAL_ITEM", "MOVIE", "MUSIC", "BOOK", "SOFTWARE", "GAME", "PERSONAL_TITLE", "EVENT", "DATE", "QUANTITY", "ATTRIBUTE", "OTHER"
|
2282
|
+
# resp.entities[0].mentions[0].mention_sentiment.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED"
|
2283
|
+
# resp.entities[0].mentions[0].mention_sentiment.sentiment_score.positive #=> Float
|
2284
|
+
# resp.entities[0].mentions[0].mention_sentiment.sentiment_score.negative #=> Float
|
2285
|
+
# resp.entities[0].mentions[0].mention_sentiment.sentiment_score.neutral #=> Float
|
2286
|
+
# resp.entities[0].mentions[0].mention_sentiment.sentiment_score.mixed #=> Float
|
2287
|
+
# resp.entities[0].mentions[0].begin_offset #=> Integer
|
2288
|
+
# resp.entities[0].mentions[0].end_offset #=> Integer
|
2289
|
+
#
|
2290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentiment AWS API Documentation
|
2291
|
+
#
|
2292
|
+
# @overload detect_targeted_sentiment(params = {})
|
2293
|
+
# @param [Hash] params ({})
|
2294
|
+
def detect_targeted_sentiment(params = {}, options = {})
|
2295
|
+
req = build_request(:detect_targeted_sentiment, params)
|
2296
|
+
req.send_request(options)
|
2297
|
+
end
|
2298
|
+
|
2124
2299
|
# Creates a new custom model that replicates a source custom model that
|
2125
2300
|
# you import. The source model can be in your AWS account or another
|
2126
2301
|
# one.
|
@@ -2476,7 +2651,12 @@ module Aws::Comprehend
|
|
2476
2651
|
req.send_request(options)
|
2477
2652
|
end
|
2478
2653
|
|
2479
|
-
# Gets a list of all existing endpoints that you've created.
|
2654
|
+
# Gets a list of all existing endpoints that you've created. For
|
2655
|
+
# information about endpoints, see [Managing endpoints][1].
|
2656
|
+
#
|
2657
|
+
#
|
2658
|
+
#
|
2659
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
2480
2660
|
#
|
2481
2661
|
# @option params [Types::EndpointFilter] :filter
|
2482
2662
|
# Filters the endpoints that are returned. You can filter endpoints on
|
@@ -2933,7 +3113,7 @@ module Aws::Comprehend
|
|
2933
3113
|
# resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2934
3114
|
# resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2935
3115
|
# resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
|
2936
|
-
# resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
3116
|
+
# resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL", "LICENSE_PLATE", "VEHICLE_IDENTIFICATION_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "IN_PERMANENT_ACCOUNT_NUMBER", "IN_NREGA", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "CA_HEALTH_NUMBER", "IN_AADHAAR", "IN_VOTER_NUMBER"
|
2937
3117
|
# resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
|
2938
3118
|
# resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_character #=> String
|
2939
3119
|
# resp.pii_entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
@@ -3821,7 +4001,8 @@ module Aws::Comprehend
|
|
3821
4001
|
# The identifier of the job.
|
3822
4002
|
#
|
3823
4003
|
# @option params [required, String] :language_code
|
3824
|
-
# The language of the input documents.
|
4004
|
+
# The language of the input documents. Currently, English is the only
|
4005
|
+
# valid language.
|
3825
4006
|
#
|
3826
4007
|
# @option params [String] :client_request_token
|
3827
4008
|
# A unique identifier for the request. If you don't set the client
|
@@ -3860,7 +4041,7 @@ module Aws::Comprehend
|
|
3860
4041
|
# },
|
3861
4042
|
# mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
|
3862
4043
|
# redaction_config: {
|
3863
|
-
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
|
4044
|
+
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL, LICENSE_PLATE, VEHICLE_IDENTIFICATION_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, IN_PERMANENT_ACCOUNT_NUMBER, IN_NREGA, INTERNATIONAL_BANK_ACCOUNT_NUMBER, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, CA_HEALTH_NUMBER, IN_AADHAAR, IN_VOTER_NUMBER
|
3864
4045
|
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
3865
4046
|
# mask_character: "MaskCharacter",
|
3866
4047
|
# },
|
@@ -4029,9 +4210,8 @@ module Aws::Comprehend
|
|
4029
4210
|
# The identifier of the job.
|
4030
4211
|
#
|
4031
4212
|
# @option params [required, String] :language_code
|
4032
|
-
# The language of the input documents.
|
4033
|
-
#
|
4034
|
-
# be in the same language.
|
4213
|
+
# The language of the input documents. Currently, English is the only
|
4214
|
+
# supported language.
|
4035
4215
|
#
|
4036
4216
|
# @option params [String] :client_request_token
|
4037
4217
|
# A unique identifier for the request. If you don't set the client
|
@@ -4423,7 +4603,7 @@ module Aws::Comprehend
|
|
4423
4603
|
|
4424
4604
|
# Stops a sentiment detection job in progress.
|
4425
4605
|
#
|
4426
|
-
# If the job state is `IN_PROGRESS
|
4606
|
+
# If the job state is `IN_PROGRESS`, the job is marked for termination
|
4427
4607
|
# and put into the `STOP_REQUESTED` state. If the job completes before
|
4428
4608
|
# it can be stopped, it is put into the `COMPLETED` state; otherwise the
|
4429
4609
|
# job is be stopped and put into the `STOPPED` state.
|
@@ -4465,7 +4645,7 @@ module Aws::Comprehend
|
|
4465
4645
|
|
4466
4646
|
# Stops a targeted sentiment detection job in progress.
|
4467
4647
|
#
|
4468
|
-
# If the job state is `IN_PROGRESS
|
4648
|
+
# If the job state is `IN_PROGRESS`, the job is marked for termination
|
4469
4649
|
# and put into the `STOP_REQUESTED` state. If the job completes before
|
4470
4650
|
# it can be stopped, it is put into the `COMPLETED` state; otherwise the
|
4471
4651
|
# job is be stopped and put into the `STOPPED` state.
|
@@ -4633,7 +4813,12 @@ module Aws::Comprehend
|
|
4633
4813
|
req.send_request(options)
|
4634
4814
|
end
|
4635
4815
|
|
4636
|
-
# Updates information about the specified endpoint.
|
4816
|
+
# Updates information about the specified endpoint. For information
|
4817
|
+
# about endpoints, see [Managing endpoints][1].
|
4818
|
+
#
|
4819
|
+
#
|
4820
|
+
#
|
4821
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
4637
4822
|
#
|
4638
4823
|
# @option params [required, String] :endpoint_arn
|
4639
4824
|
# The Amazon Resource Number (ARN) of the endpoint being updated.
|
@@ -4683,7 +4868,7 @@ module Aws::Comprehend
|
|
4683
4868
|
params: params,
|
4684
4869
|
config: config)
|
4685
4870
|
context[:gem_name] = 'aws-sdk-comprehend'
|
4686
|
-
context[:gem_version] = '1.
|
4871
|
+
context[:gem_version] = '1.62.0'
|
4687
4872
|
Seahorse::Client::Request.new(handlers, context)
|
4688
4873
|
end
|
4689
4874
|
|