aws-sdk-comprehend 1.61.0 → 1.62.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e9506b07c0fd74a91d95eb651618788bde3605dbe23762423c4e241644bcc3c8
4
- data.tar.gz: '0094e85d2ff29db0389c55662ac90e94ccdd3b08076b56d09a7e94ee8a2efdba'
3
+ metadata.gz: b2b0ff29417aa35c35084fa9357970b72b02f674261ec69b68401baffccedd3d
4
+ data.tar.gz: 284edfaefd2215cd9783ab96c6535b0e50c1b6f763067f51a32ef2ac501e9952
5
5
  SHA512:
6
- metadata.gz: 61ed9fc9bbe5d1c330e70d64564ba6beb6eccbd6a8e25cd8be9e1e896536a44d930138c626a2054f90302d33fb2894115a777abd6e1ad12cb0bcbe787f980efe
7
- data.tar.gz: faa8ad043980f18673d0f31f286713e60dba7b5af54e6a69befac5fd9894be4f1cd73c45b3507772c88a04189b5764523ce964938db5976f4aef0300aaae5738
6
+ metadata.gz: 1433313b3641640353668d8e0f6f9f007ca8d7b7ef645bb210b9c05ebdf7f8172d4a545bf27179c8bd5ab7b3a33eefacfff093b57f10113b5bc0a06e1ec70ddb
7
+ data.tar.gz: 48864026f184295c7e9c9945286ea283dee6eb418dee073595c9a40113fc90201324089751874f8b1a72bca52a8e6c9dcb31b07ac29a39698c9f9911e26f07d7
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
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
+
4
9
  1.61.0 (2022-05-20)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.61.0
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 list can
374
- # contain a maximum of 25 documents. Each document should contain at
375
- # least 20 characters and must contain fewer than 5,000 bytes of UTF-8
376
- # encoded characters.
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 how-entities
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 list can
416
- # contain a maximum of 25 documents. Each document must contain fewer
417
- # than 5,000 bytes of UTF-8 encoded characters.
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 list can
464
- # contain a maximum of 25 documents. Each document must contain fewer
465
- # than 5,000 bytes of UTF-8 encoded characters.
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 list can
513
- # contain a maximum of 25 documents. Each document must contain fewer
514
- # that 5,000 bytes of UTF-8 encoded characters.
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 how-syntax.
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 list can
562
- # contain a maximum of 25 documents. Each document must contain fewer
563
- # that 5,000 bytes of UTF-8 encoded characters.
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&lt;Types::BatchDetectTargetedSentimentItemResult&gt;
645
+ # * {Types::BatchDetectTargetedSentimentResponse#error_list #error_list} => Array&lt;Types::BatchItemError&gt;
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.
@@ -655,9 +734,7 @@ module Aws::Comprehend
655
734
  # types such as name, address, bank account number, or phone number.
656
735
  #
657
736
  # @option params [required, String] :text
658
- # Creates a new document classification request to analyze a single
659
- # document in real-time, returning personally identifiable information
660
- # (PII) entity labels.
737
+ # A UTF-8 text string. The maximum string size is 100 KB.
661
738
  #
662
739
  # @option params [required, String] :language_code
663
740
  # The language of the input documents. Currently, English is the only
@@ -694,7 +771,11 @@ module Aws::Comprehend
694
771
  # documents that labeled with the categories that you want to use. After
695
772
  # the classifier is trained you can use it to categorize a set of
696
773
  # labeled documents into the categories. For more information, see
697
- # how-document-classification.
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
698
779
  #
699
780
  # @option params [required, String] :document_classifier_name
700
781
  # The name of the document classifier.
@@ -1896,8 +1977,8 @@ module Aws::Comprehend
1896
1977
  # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html
1897
1978
  #
1898
1979
  # @option params [required, String] :text
1899
- # A UTF-8 text string. Each string should contain at least 20 characters
1900
- # and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
1980
+ # A UTF-8 text string. The string must contain at least 20 characters.
1981
+ # The maximum string size is 100 KB.
1901
1982
  #
1902
1983
  # @return [Types::DetectDominantLanguageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1903
1984
  #
@@ -1925,11 +2006,15 @@ module Aws::Comprehend
1925
2006
  end
1926
2007
 
1927
2008
  # Inspects text for named entities, and returns information about them.
1928
- # For more information, about named entities, see how-entities.
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
1929
2015
  #
1930
2016
  # @option params [required, String] :text
1931
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
1932
- # of UTF-8 encoded characters.
2017
+ # A UTF-8 text string. The maximum string size is 100 KB.
1933
2018
  #
1934
2019
  # @option params [String] :language_code
1935
2020
  # The language of the input documents. You can specify any of the
@@ -1989,8 +2074,8 @@ module Aws::Comprehend
1989
2074
  # Detects the key noun phrases found in the text.
1990
2075
  #
1991
2076
  # @option params [required, String] :text
1992
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
1993
- # of UTF-8 encoded characters.
2077
+ # A UTF-8 text string. The string must contain less than 100 KB of UTF-8
2078
+ # encoded characters.
1994
2079
  #
1995
2080
  # @option params [required, String] :language_code
1996
2081
  # The language of the input documents. You can specify any of the
@@ -2029,8 +2114,7 @@ module Aws::Comprehend
2029
2114
  # identifiable information (PII) and returns information about them.
2030
2115
  #
2031
2116
  # @option params [required, String] :text
2032
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
2033
- # of UTF-8 encoded characters.
2117
+ # A UTF-8 text string. The maximum string size is 100 KB.
2034
2118
  #
2035
2119
  # @option params [required, String] :language_code
2036
2120
  # The language of the input documents. Currently, English is the only
@@ -2068,8 +2152,13 @@ module Aws::Comprehend
2068
2152
  # (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
2069
2153
  #
2070
2154
  # @option params [required, String] :text
2071
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
2072
- # of UTF-8 encoded characters.
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>
2073
2162
  #
2074
2163
  # @option params [required, String] :language_code
2075
2164
  # The language of the input documents. You can specify any of the
@@ -2106,11 +2195,15 @@ module Aws::Comprehend
2106
2195
  end
2107
2196
 
2108
2197
  # Inspects text for syntax and the part of speech of words in the
2109
- # document. For more information, how-syntax.
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
2110
2204
  #
2111
2205
  # @option params [required, String] :text
2112
- # A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF
2113
- # encoded characters.
2206
+ # A UTF-8 string. The maximum string size is 5 KB.
2114
2207
  #
2115
2208
  # @option params [required, String] :language_code
2116
2209
  # The language code of the input documents. You can specify any of the
@@ -2148,6 +2241,61 @@ module Aws::Comprehend
2148
2241
  req.send_request(options)
2149
2242
  end
2150
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&lt;Types::TargetedSentimentEntity&gt;
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
+
2151
2299
  # Creates a new custom model that replicates a source custom model that
2152
2300
  # you import. The source model can be in your AWS account or another
2153
2301
  # one.
@@ -4063,7 +4211,7 @@ module Aws::Comprehend
4063
4211
  #
4064
4212
  # @option params [required, String] :language_code
4065
4213
  # The language of the input documents. Currently, English is the only
4066
- # valid language.
4214
+ # supported language.
4067
4215
  #
4068
4216
  # @option params [String] :client_request_token
4069
4217
  # A unique identifier for the request. If you don't set the client
@@ -4720,7 +4868,7 @@ module Aws::Comprehend
4720
4868
  params: params,
4721
4869
  config: config)
4722
4870
  context[:gem_name] = 'aws-sdk-comprehend'
4723
- context[:gem_version] = '1.61.0'
4871
+ context[:gem_version] = '1.62.0'
4724
4872
  Seahorse::Client::Request.new(handlers, context)
4725
4873
  end
4726
4874
 
@@ -33,6 +33,9 @@ module Aws::Comprehend
33
33
  BatchDetectSyntaxItemResult = Shapes::StructureShape.new(name: 'BatchDetectSyntaxItemResult')
34
34
  BatchDetectSyntaxRequest = Shapes::StructureShape.new(name: 'BatchDetectSyntaxRequest')
35
35
  BatchDetectSyntaxResponse = Shapes::StructureShape.new(name: 'BatchDetectSyntaxResponse')
36
+ BatchDetectTargetedSentimentItemResult = Shapes::StructureShape.new(name: 'BatchDetectTargetedSentimentItemResult')
37
+ BatchDetectTargetedSentimentRequest = Shapes::StructureShape.new(name: 'BatchDetectTargetedSentimentRequest')
38
+ BatchDetectTargetedSentimentResponse = Shapes::StructureShape.new(name: 'BatchDetectTargetedSentimentResponse')
36
39
  BatchItemError = Shapes::StructureShape.new(name: 'BatchItemError')
37
40
  BatchItemErrorList = Shapes::ListShape.new(name: 'BatchItemErrorList')
38
41
  BatchSizeLimitExceededException = Shapes::StructureShape.new(name: 'BatchSizeLimitExceededException')
@@ -103,6 +106,8 @@ module Aws::Comprehend
103
106
  DetectSentimentResponse = Shapes::StructureShape.new(name: 'DetectSentimentResponse')
104
107
  DetectSyntaxRequest = Shapes::StructureShape.new(name: 'DetectSyntaxRequest')
105
108
  DetectSyntaxResponse = Shapes::StructureShape.new(name: 'DetectSyntaxResponse')
109
+ DetectTargetedSentimentRequest = Shapes::StructureShape.new(name: 'DetectTargetedSentimentRequest')
110
+ DetectTargetedSentimentResponse = Shapes::StructureShape.new(name: 'DetectTargetedSentimentResponse')
106
111
  DocumentClass = Shapes::StructureShape.new(name: 'DocumentClass')
107
112
  DocumentClassificationJobFilter = Shapes::StructureShape.new(name: 'DocumentClassificationJobFilter')
108
113
  DocumentClassificationJobProperties = Shapes::StructureShape.new(name: 'DocumentClassificationJobProperties')
@@ -208,20 +213,24 @@ module Aws::Comprehend
208
213
  ListKeyPhrasesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsRequest')
209
214
  ListKeyPhrasesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListKeyPhrasesDetectionJobsResponse')
210
215
  ListOfClasses = Shapes::ListShape.new(name: 'ListOfClasses')
216
+ ListOfDescriptiveMentionIndices = Shapes::ListShape.new(name: 'ListOfDescriptiveMentionIndices')
211
217
  ListOfDetectDominantLanguageResult = Shapes::ListShape.new(name: 'ListOfDetectDominantLanguageResult')
212
218
  ListOfDetectEntitiesResult = Shapes::ListShape.new(name: 'ListOfDetectEntitiesResult')
213
219
  ListOfDetectKeyPhrasesResult = Shapes::ListShape.new(name: 'ListOfDetectKeyPhrasesResult')
214
220
  ListOfDetectSentimentResult = Shapes::ListShape.new(name: 'ListOfDetectSentimentResult')
215
221
  ListOfDetectSyntaxResult = Shapes::ListShape.new(name: 'ListOfDetectSyntaxResult')
222
+ ListOfDetectTargetedSentimentResult = Shapes::ListShape.new(name: 'ListOfDetectTargetedSentimentResult')
216
223
  ListOfDocumentReadFeatureTypes = Shapes::ListShape.new(name: 'ListOfDocumentReadFeatureTypes')
217
224
  ListOfDominantLanguages = Shapes::ListShape.new(name: 'ListOfDominantLanguages')
218
225
  ListOfEntities = Shapes::ListShape.new(name: 'ListOfEntities')
219
226
  ListOfEntityLabels = Shapes::ListShape.new(name: 'ListOfEntityLabels')
220
227
  ListOfKeyPhrases = Shapes::ListShape.new(name: 'ListOfKeyPhrases')
221
228
  ListOfLabels = Shapes::ListShape.new(name: 'ListOfLabels')
229
+ ListOfMentions = Shapes::ListShape.new(name: 'ListOfMentions')
222
230
  ListOfPiiEntities = Shapes::ListShape.new(name: 'ListOfPiiEntities')
223
231
  ListOfPiiEntityTypes = Shapes::ListShape.new(name: 'ListOfPiiEntityTypes')
224
232
  ListOfSyntaxTokens = Shapes::ListShape.new(name: 'ListOfSyntaxTokens')
233
+ ListOfTargetedSentimentEntities = Shapes::ListShape.new(name: 'ListOfTargetedSentimentEntities')
225
234
  ListPiiEntitiesDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsRequest')
226
235
  ListPiiEntitiesDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListPiiEntitiesDetectionJobsResponse')
227
236
  ListSentimentDetectionJobsRequest = Shapes::StructureShape.new(name: 'ListSentimentDetectionJobsRequest')
@@ -234,6 +243,7 @@ module Aws::Comprehend
234
243
  ListTopicsDetectionJobsResponse = Shapes::StructureShape.new(name: 'ListTopicsDetectionJobsResponse')
235
244
  MaskCharacter = Shapes::StringShape.new(name: 'MaskCharacter')
236
245
  MaxResultsInteger = Shapes::IntegerShape.new(name: 'MaxResultsInteger')
246
+ MentionSentiment = Shapes::StructureShape.new(name: 'MentionSentiment')
237
247
  ModelStatus = Shapes::StringShape.new(name: 'ModelStatus')
238
248
  NumberOfTopicsInteger = Shapes::IntegerShape.new(name: 'NumberOfTopicsInteger')
239
249
  OutputDataConfig = Shapes::StructureShape.new(name: 'OutputDataConfig')
@@ -317,6 +327,9 @@ module Aws::Comprehend
317
327
  TargetedSentimentDetectionJobFilter = Shapes::StructureShape.new(name: 'TargetedSentimentDetectionJobFilter')
318
328
  TargetedSentimentDetectionJobProperties = Shapes::StructureShape.new(name: 'TargetedSentimentDetectionJobProperties')
319
329
  TargetedSentimentDetectionJobPropertiesList = Shapes::ListShape.new(name: 'TargetedSentimentDetectionJobPropertiesList')
330
+ TargetedSentimentEntity = Shapes::StructureShape.new(name: 'TargetedSentimentEntity')
331
+ TargetedSentimentEntityType = Shapes::StringShape.new(name: 'TargetedSentimentEntityType')
332
+ TargetedSentimentMention = Shapes::StructureShape.new(name: 'TargetedSentimentMention')
320
333
  TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
321
334
  Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
322
335
  TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
@@ -403,6 +416,18 @@ module Aws::Comprehend
403
416
  BatchDetectSyntaxResponse.add_member(:error_list, Shapes::ShapeRef.new(shape: BatchItemErrorList, required: true, location_name: "ErrorList"))
404
417
  BatchDetectSyntaxResponse.struct_class = Types::BatchDetectSyntaxResponse
405
418
 
419
+ BatchDetectTargetedSentimentItemResult.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "Index"))
420
+ BatchDetectTargetedSentimentItemResult.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfTargetedSentimentEntities, location_name: "Entities"))
421
+ BatchDetectTargetedSentimentItemResult.struct_class = Types::BatchDetectTargetedSentimentItemResult
422
+
423
+ BatchDetectTargetedSentimentRequest.add_member(:text_list, Shapes::ShapeRef.new(shape: CustomerInputStringList, required: true, location_name: "TextList"))
424
+ BatchDetectTargetedSentimentRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
425
+ BatchDetectTargetedSentimentRequest.struct_class = Types::BatchDetectTargetedSentimentRequest
426
+
427
+ BatchDetectTargetedSentimentResponse.add_member(:result_list, Shapes::ShapeRef.new(shape: ListOfDetectTargetedSentimentResult, required: true, location_name: "ResultList"))
428
+ BatchDetectTargetedSentimentResponse.add_member(:error_list, Shapes::ShapeRef.new(shape: BatchItemErrorList, required: true, location_name: "ErrorList"))
429
+ BatchDetectTargetedSentimentResponse.struct_class = Types::BatchDetectTargetedSentimentResponse
430
+
406
431
  BatchItemError.add_member(:index, Shapes::ShapeRef.new(shape: Integer, location_name: "Index"))
407
432
  BatchItemError.add_member(:error_code, Shapes::ShapeRef.new(shape: String, location_name: "ErrorCode"))
408
433
  BatchItemError.add_member(:error_message, Shapes::ShapeRef.new(shape: String, location_name: "ErrorMessage"))
@@ -639,6 +664,13 @@ module Aws::Comprehend
639
664
  DetectSyntaxResponse.add_member(:syntax_tokens, Shapes::ShapeRef.new(shape: ListOfSyntaxTokens, location_name: "SyntaxTokens"))
640
665
  DetectSyntaxResponse.struct_class = Types::DetectSyntaxResponse
641
666
 
667
+ DetectTargetedSentimentRequest.add_member(:text, Shapes::ShapeRef.new(shape: CustomerInputString, required: true, location_name: "Text"))
668
+ DetectTargetedSentimentRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
669
+ DetectTargetedSentimentRequest.struct_class = Types::DetectTargetedSentimentRequest
670
+
671
+ DetectTargetedSentimentResponse.add_member(:entities, Shapes::ShapeRef.new(shape: ListOfTargetedSentimentEntities, location_name: "Entities"))
672
+ DetectTargetedSentimentResponse.struct_class = Types::DetectTargetedSentimentResponse
673
+
642
674
  DocumentClass.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
643
675
  DocumentClass.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
644
676
  DocumentClass.struct_class = Types::DocumentClass
@@ -1064,6 +1096,8 @@ module Aws::Comprehend
1064
1096
 
1065
1097
  ListOfClasses.member = Shapes::ShapeRef.new(shape: DocumentClass)
1066
1098
 
1099
+ ListOfDescriptiveMentionIndices.member = Shapes::ShapeRef.new(shape: Integer)
1100
+
1067
1101
  ListOfDetectDominantLanguageResult.member = Shapes::ShapeRef.new(shape: BatchDetectDominantLanguageItemResult)
1068
1102
 
1069
1103
  ListOfDetectEntitiesResult.member = Shapes::ShapeRef.new(shape: BatchDetectEntitiesItemResult)
@@ -1074,6 +1108,8 @@ module Aws::Comprehend
1074
1108
 
1075
1109
  ListOfDetectSyntaxResult.member = Shapes::ShapeRef.new(shape: BatchDetectSyntaxItemResult)
1076
1110
 
1111
+ ListOfDetectTargetedSentimentResult.member = Shapes::ShapeRef.new(shape: BatchDetectTargetedSentimentItemResult)
1112
+
1077
1113
  ListOfDocumentReadFeatureTypes.member = Shapes::ShapeRef.new(shape: DocumentReadFeatureTypes)
1078
1114
 
1079
1115
  ListOfDominantLanguages.member = Shapes::ShapeRef.new(shape: DominantLanguage)
@@ -1086,12 +1122,16 @@ module Aws::Comprehend
1086
1122
 
1087
1123
  ListOfLabels.member = Shapes::ShapeRef.new(shape: DocumentLabel)
1088
1124
 
1125
+ ListOfMentions.member = Shapes::ShapeRef.new(shape: TargetedSentimentMention)
1126
+
1089
1127
  ListOfPiiEntities.member = Shapes::ShapeRef.new(shape: PiiEntity)
1090
1128
 
1091
1129
  ListOfPiiEntityTypes.member = Shapes::ShapeRef.new(shape: PiiEntityType)
1092
1130
 
1093
1131
  ListOfSyntaxTokens.member = Shapes::ShapeRef.new(shape: SyntaxToken)
1094
1132
 
1133
+ ListOfTargetedSentimentEntities.member = Shapes::ShapeRef.new(shape: TargetedSentimentEntity)
1134
+
1095
1135
  ListPiiEntitiesDetectionJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: PiiEntitiesDetectionJobFilter, location_name: "Filter"))
1096
1136
  ListPiiEntitiesDetectionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
1097
1137
  ListPiiEntitiesDetectionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsInteger, location_name: "MaxResults"))
@@ -1135,6 +1175,10 @@ module Aws::Comprehend
1135
1175
  ListTopicsDetectionJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
1136
1176
  ListTopicsDetectionJobsResponse.struct_class = Types::ListTopicsDetectionJobsResponse
1137
1177
 
1178
+ MentionSentiment.add_member(:sentiment, Shapes::ShapeRef.new(shape: SentimentType, location_name: "Sentiment"))
1179
+ MentionSentiment.add_member(:sentiment_score, Shapes::ShapeRef.new(shape: SentimentScore, location_name: "SentimentScore"))
1180
+ MentionSentiment.struct_class = Types::MentionSentiment
1181
+
1138
1182
  OutputDataConfig.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3Uri"))
1139
1183
  OutputDataConfig.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: KmsKeyId, location_name: "KmsKeyId"))
1140
1184
  OutputDataConfig.struct_class = Types::OutputDataConfig
@@ -1482,6 +1526,19 @@ module Aws::Comprehend
1482
1526
 
1483
1527
  TargetedSentimentDetectionJobPropertiesList.member = Shapes::ShapeRef.new(shape: TargetedSentimentDetectionJobProperties)
1484
1528
 
1529
+ TargetedSentimentEntity.add_member(:descriptive_mention_index, Shapes::ShapeRef.new(shape: ListOfDescriptiveMentionIndices, location_name: "DescriptiveMentionIndex"))
1530
+ TargetedSentimentEntity.add_member(:mentions, Shapes::ShapeRef.new(shape: ListOfMentions, location_name: "Mentions"))
1531
+ TargetedSentimentEntity.struct_class = Types::TargetedSentimentEntity
1532
+
1533
+ TargetedSentimentMention.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
1534
+ TargetedSentimentMention.add_member(:group_score, Shapes::ShapeRef.new(shape: Float, location_name: "GroupScore"))
1535
+ TargetedSentimentMention.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
1536
+ TargetedSentimentMention.add_member(:type, Shapes::ShapeRef.new(shape: TargetedSentimentEntityType, location_name: "Type"))
1537
+ TargetedSentimentMention.add_member(:mention_sentiment, Shapes::ShapeRef.new(shape: MentionSentiment, location_name: "MentionSentiment"))
1538
+ TargetedSentimentMention.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
1539
+ TargetedSentimentMention.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
1540
+ TargetedSentimentMention.struct_class = Types::TargetedSentimentMention
1541
+
1485
1542
  TextSizeLimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
1486
1543
  TextSizeLimitExceededException.struct_class = Types::TextSizeLimitExceededException
1487
1544
 
@@ -1621,6 +1678,19 @@ module Aws::Comprehend
1621
1678
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1622
1679
  end)
1623
1680
 
1681
+ api.add_operation(:batch_detect_targeted_sentiment, Seahorse::Model::Operation.new.tap do |o|
1682
+ o.name = "BatchDetectTargetedSentiment"
1683
+ o.http_method = "POST"
1684
+ o.http_request_uri = "/"
1685
+ o.input = Shapes::ShapeRef.new(shape: BatchDetectTargetedSentimentRequest)
1686
+ o.output = Shapes::ShapeRef.new(shape: BatchDetectTargetedSentimentResponse)
1687
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1688
+ o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
1689
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
1690
+ o.errors << Shapes::ShapeRef.new(shape: BatchSizeLimitExceededException)
1691
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1692
+ end)
1693
+
1624
1694
  api.add_operation(:classify_document, Seahorse::Model::Operation.new.tap do |o|
1625
1695
  o.name = "ClassifyDocument"
1626
1696
  o.http_method = "POST"
@@ -1972,6 +2042,18 @@ module Aws::Comprehend
1972
2042
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1973
2043
  end)
1974
2044
 
2045
+ api.add_operation(:detect_targeted_sentiment, Seahorse::Model::Operation.new.tap do |o|
2046
+ o.name = "DetectTargetedSentiment"
2047
+ o.http_method = "POST"
2048
+ o.http_request_uri = "/"
2049
+ o.input = Shapes::ShapeRef.new(shape: DetectTargetedSentimentRequest)
2050
+ o.output = Shapes::ShapeRef.new(shape: DetectTargetedSentimentResponse)
2051
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
2052
+ o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
2053
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedLanguageException)
2054
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2055
+ end)
2056
+
1975
2057
  api.add_operation(:import_model, Seahorse::Model::Operation.new.tap do |o|
1976
2058
  o.name = "ImportModel"
1977
2059
  o.http_method = "POST"
@@ -126,10 +126,10 @@ module Aws::Comprehend
126
126
  # }
127
127
  #
128
128
  # @!attribute [rw] text_list
129
- # A list containing the text of the input documents. The list can
130
- # contain a maximum of 25 documents. Each document should contain at
131
- # least 20 characters and must contain fewer than 5,000 bytes of UTF-8
132
- # encoded characters.
129
+ # A list containing the UTF-8 encoded text of the input documents. The
130
+ # list can contain a maximum of 25 documents. Each document should
131
+ # contain at least 20 characters. The maximum size of each document is
132
+ # 5 KB.
133
133
  # @return [Array<String>]
134
134
  #
135
135
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectDominantLanguageRequest AWS API Documentation
@@ -193,9 +193,9 @@ module Aws::Comprehend
193
193
  # }
194
194
  #
195
195
  # @!attribute [rw] text_list
196
- # A list containing the text of the input documents. The list can
197
- # contain a maximum of 25 documents. Each document must contain fewer
198
- # than 5,000 bytes of UTF-8 encoded characters.
196
+ # A list containing the UTF-8 encoded text of the input documents. The
197
+ # list can contain a maximum of 25 documents. The maximum size of each
198
+ # document is 5 KB.
199
199
  # @return [Array<String>]
200
200
  #
201
201
  # @!attribute [rw] language_code
@@ -266,9 +266,9 @@ module Aws::Comprehend
266
266
  # }
267
267
  #
268
268
  # @!attribute [rw] text_list
269
- # A list containing the text of the input documents. The list can
270
- # contain a maximum of 25 documents. Each document must contain fewer
271
- # than 5,000 bytes of UTF-8 encoded characters.
269
+ # A list containing the UTF-8 encoded text of the input documents. The
270
+ # list can contain a maximum of 25 documents. The maximum size of each
271
+ # document is 5 KB.
272
272
  # @return [Array<String>]
273
273
  #
274
274
  # @!attribute [rw] language_code
@@ -344,9 +344,15 @@ module Aws::Comprehend
344
344
  # }
345
345
  #
346
346
  # @!attribute [rw] text_list
347
- # A list containing the text of the input documents. The list can
348
- # contain a maximum of 25 documents. Each document must contain fewer
349
- # that 5,000 bytes of UTF-8 encoded characters.
347
+ # A list containing the UTF-8 encoded text of the input documents. The
348
+ # list can contain a maximum of 25 documents. The maximum size of each
349
+ # document is 5 KB.
350
+ #
351
+ # <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
352
+ # 500 characters of the input text and ignores any additional text in
353
+ # the input.
354
+ #
355
+ # </note>
350
356
  # @return [Array<String>]
351
357
  #
352
358
  # @!attribute [rw] language_code
@@ -417,9 +423,9 @@ module Aws::Comprehend
417
423
  # }
418
424
  #
419
425
  # @!attribute [rw] text_list
420
- # A list containing the text of the input documents. The list can
421
- # contain a maximum of 25 documents. Each document must contain fewer
422
- # that 5,000 bytes of UTF-8 encoded characters.
426
+ # A list containing the UTF-8 encoded text of the input documents. The
427
+ # list can contain a maximum of 25 documents. The maximum size for
428
+ # each document is 5 KB.
423
429
  # @return [Array<String>]
424
430
  #
425
431
  # @!attribute [rw] language_code
@@ -462,6 +468,73 @@ module Aws::Comprehend
462
468
  include Aws::Structure
463
469
  end
464
470
 
471
+ # Analysis results for one of the documents in the batch.
472
+ #
473
+ # @!attribute [rw] index
474
+ # The zero-based index of this result in the input list.
475
+ # @return [Integer]
476
+ #
477
+ # @!attribute [rw] entities
478
+ # An array of targeted sentiment entities.
479
+ # @return [Array<Types::TargetedSentimentEntity>]
480
+ #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentimentItemResult AWS API Documentation
482
+ #
483
+ class BatchDetectTargetedSentimentItemResult < Struct.new(
484
+ :index,
485
+ :entities)
486
+ SENSITIVE = []
487
+ include Aws::Structure
488
+ end
489
+
490
+ # @note When making an API call, you may pass BatchDetectTargetedSentimentRequest
491
+ # data as a hash:
492
+ #
493
+ # {
494
+ # text_list: ["CustomerInputString"], # required
495
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
496
+ # }
497
+ #
498
+ # @!attribute [rw] text_list
499
+ # A list containing the UTF-8 encoded text of the input documents. The
500
+ # list can contain a maximum of 25 documents. The maximum size of each
501
+ # document is 5 KB.
502
+ # @return [Array<String>]
503
+ #
504
+ # @!attribute [rw] language_code
505
+ # The language of the input documents. Currently, English is the only
506
+ # supported language.
507
+ # @return [String]
508
+ #
509
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentimentRequest AWS API Documentation
510
+ #
511
+ class BatchDetectTargetedSentimentRequest < Struct.new(
512
+ :text_list,
513
+ :language_code)
514
+ SENSITIVE = [:text_list]
515
+ include Aws::Structure
516
+ end
517
+
518
+ # @!attribute [rw] result_list
519
+ # A list of objects containing the results of the operation. The
520
+ # results are sorted in ascending order by the `Index` field and match
521
+ # the order of the documents in the input list. If all of the
522
+ # documents contain an error, the `ResultList` is empty.
523
+ # @return [Array<Types::BatchDetectTargetedSentimentItemResult>]
524
+ #
525
+ # @!attribute [rw] error_list
526
+ # List of errors that the operation can return.
527
+ # @return [Array<Types::BatchItemError>]
528
+ #
529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectTargetedSentimentResponse AWS API Documentation
530
+ #
531
+ class BatchDetectTargetedSentimentResponse < Struct.new(
532
+ :result_list,
533
+ :error_list)
534
+ SENSITIVE = []
535
+ include Aws::Structure
536
+ end
537
+
465
538
  # Describes an error that occurred while processing a document in a
466
539
  # batch. The operation returns on `BatchItemError` object for each
467
540
  # document that contained an error.
@@ -692,9 +765,7 @@ module Aws::Comprehend
692
765
  # }
693
766
  #
694
767
  # @!attribute [rw] text
695
- # Creates a new document classification request to analyze a single
696
- # document in real-time, returning personally identifiable information
697
- # (PII) entity labels.
768
+ # A UTF-8 text string. The maximum string size is 100 KB.
698
769
  # @return [String]
699
770
  #
700
771
  # @!attribute [rw] language_code
@@ -1728,9 +1799,8 @@ module Aws::Comprehend
1728
1799
  # }
1729
1800
  #
1730
1801
  # @!attribute [rw] text
1731
- # A UTF-8 text string. Each string should contain at least 20
1732
- # characters and must contain fewer that 5,000 bytes of UTF-8 encoded
1733
- # characters.
1802
+ # A UTF-8 text string. The string must contain at least 20 characters.
1803
+ # The maximum string size is 100 KB.
1734
1804
  # @return [String]
1735
1805
  #
1736
1806
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguageRequest AWS API Documentation
@@ -1771,8 +1841,7 @@ module Aws::Comprehend
1771
1841
  # }
1772
1842
  #
1773
1843
  # @!attribute [rw] text
1774
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
1775
- # of UTF-8 encoded characters.
1844
+ # A UTF-8 text string. The maximum string size is 100 KB.
1776
1845
  # @return [String]
1777
1846
  #
1778
1847
  # @!attribute [rw] language_code
@@ -1822,7 +1891,12 @@ module Aws::Comprehend
1822
1891
  # If your request uses a custom entity recognition model, Amazon
1823
1892
  # Comprehend detects the entities that the model is trained to
1824
1893
  # recognize. Otherwise, it detects the default entity types. For a
1825
- # list of default entity types, see how-entities.
1894
+ # list of default entity types, see [Entities][1] in the Comprehend
1895
+ # Developer Guide.
1896
+ #
1897
+ #
1898
+ #
1899
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html
1826
1900
  # @return [Array<Types::Entity>]
1827
1901
  #
1828
1902
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesResponse AWS API Documentation
@@ -1842,8 +1916,8 @@ module Aws::Comprehend
1842
1916
  # }
1843
1917
  #
1844
1918
  # @!attribute [rw] text
1845
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
1846
- # of UTF-8 encoded characters.
1919
+ # A UTF-8 text string. The string must contain less than 100 KB of
1920
+ # UTF-8 encoded characters.
1847
1921
  # @return [String]
1848
1922
  #
1849
1923
  # @!attribute [rw] language_code
@@ -1886,8 +1960,7 @@ module Aws::Comprehend
1886
1960
  # }
1887
1961
  #
1888
1962
  # @!attribute [rw] text
1889
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
1890
- # of UTF-8 encoded characters.
1963
+ # A UTF-8 text string. The maximum string size is 100 KB.
1891
1964
  # @return [String]
1892
1965
  #
1893
1966
  # @!attribute [rw] language_code
@@ -1928,8 +2001,13 @@ module Aws::Comprehend
1928
2001
  # }
1929
2002
  #
1930
2003
  # @!attribute [rw] text
1931
- # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
1932
- # of UTF-8 encoded characters.
2004
+ # A UTF-8 text string. The maximum string size is 5 KB.
2005
+ #
2006
+ # <note markdown="1"> Amazon Comprehend performs real-time sentiment analysis on the first
2007
+ # 500 characters of the input text and ignores any additional text in
2008
+ # the input.
2009
+ #
2010
+ # </note>
1933
2011
  # @return [String]
1934
2012
  #
1935
2013
  # @!attribute [rw] language_code
@@ -1975,8 +2053,7 @@ module Aws::Comprehend
1975
2053
  # }
1976
2054
  #
1977
2055
  # @!attribute [rw] text
1978
- # A UTF-8 string. Each string must contain fewer that 5,000 bytes of
1979
- # UTF encoded characters.
2056
+ # A UTF-8 string. The maximum string size is 5 KB.
1980
2057
  # @return [String]
1981
2058
  #
1982
2059
  # @!attribute [rw] language_code
@@ -2000,7 +2077,11 @@ module Aws::Comprehend
2000
2077
  # the response provides the text, the token type, where the text
2001
2078
  # begins and ends, and the level of confidence that Amazon Comprehend
2002
2079
  # has that the token is correct. For a list of token types, see
2003
- # how-syntax.
2080
+ # [Syntax][1] in the Comprehend Developer Guide.
2081
+ #
2082
+ #
2083
+ #
2084
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
2004
2085
  # @return [Array<Types::SyntaxToken>]
2005
2086
  #
2006
2087
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntaxResponse AWS API Documentation
@@ -2011,6 +2092,45 @@ module Aws::Comprehend
2011
2092
  include Aws::Structure
2012
2093
  end
2013
2094
 
2095
+ # @note When making an API call, you may pass DetectTargetedSentimentRequest
2096
+ # data as a hash:
2097
+ #
2098
+ # {
2099
+ # text: "CustomerInputString", # required
2100
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
2101
+ # }
2102
+ #
2103
+ # @!attribute [rw] text
2104
+ # A UTF-8 text string. The maximum string length is 5 KB.
2105
+ # @return [String]
2106
+ #
2107
+ # @!attribute [rw] language_code
2108
+ # The language of the input documents. Currently, English is the only
2109
+ # supported language.
2110
+ # @return [String]
2111
+ #
2112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentimentRequest AWS API Documentation
2113
+ #
2114
+ class DetectTargetedSentimentRequest < Struct.new(
2115
+ :text,
2116
+ :language_code)
2117
+ SENSITIVE = [:text]
2118
+ include Aws::Structure
2119
+ end
2120
+
2121
+ # @!attribute [rw] entities
2122
+ # Targeted sentiment analysis for each of the entities identified in
2123
+ # the input text.
2124
+ # @return [Array<Types::TargetedSentimentEntity>]
2125
+ #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectTargetedSentimentResponse AWS API Documentation
2127
+ #
2128
+ class DetectTargetedSentimentResponse < Struct.new(
2129
+ :entities)
2130
+ SENSITIVE = []
2131
+ include Aws::Structure
2132
+ end
2133
+
2014
2134
  # Specifies the class that categorizes the document being analyzed
2015
2135
  #
2016
2136
  # @!attribute [rw] name
@@ -2233,7 +2353,11 @@ module Aws::Comprehend
2233
2353
  # The input properties for training a document classifier.
2234
2354
  #
2235
2355
  # For more information on how the input file is formatted, see
2236
- # prep-classifier-data.
2356
+ # [Preparing training data][1] in the Comprehend Developer Guide.
2357
+ #
2358
+ #
2359
+ #
2360
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html
2237
2361
  #
2238
2362
  # @note When making an API call, you may pass DocumentClassifierInputDataConfig
2239
2363
  # data as a hash:
@@ -2291,10 +2415,9 @@ module Aws::Comprehend
2291
2415
  # @return [String]
2292
2416
  #
2293
2417
  # @!attribute [rw] test_s3_uri
2294
- # The Amazon S3 URI for the input data. The Amazon S3 bucket must be
2295
- # in the same AWS Region as the API endpoint that you are calling. The
2296
- # URI can point to a single input file or it can provide the prefix
2297
- # for a collection of input files.
2418
+ # This specifies the Amazon S3 location where the test annotations for
2419
+ # an entity recognizer are located. The URI must be in the same AWS
2420
+ # Region as the API endpoint that you are calling.
2298
2421
  # @return [String]
2299
2422
  #
2300
2423
  # @!attribute [rw] label_delimiter
@@ -3091,20 +3214,13 @@ module Aws::Comprehend
3091
3214
  # @return [String]
3092
3215
  #
3093
3216
  # @!attribute [rw] begin_offset
3094
- # A character offset in the input text that shows where the entity
3095
- # begins (the first character is at position 0). The offset returns
3096
- # the position of each UTF-8 code point in the string. A *code point*
3097
- # is the abstract character from a particular graphical
3098
- # representation. For example, a multi-byte UTF-8 character maps to a
3099
- # single code point.
3217
+ # The zero-based offset from the beginning of the source text to the
3218
+ # first character in the entity.
3100
3219
  # @return [Integer]
3101
3220
  #
3102
3221
  # @!attribute [rw] end_offset
3103
- # A character offset in the input text that shows where the entity
3104
- # ends. The offset returns the position of each UTF-8 code point in
3105
- # the string. A *code point* is the abstract character from a
3106
- # particular graphical representation. For example, a multi-byte UTF-8
3107
- # character maps to a single code point.
3222
+ # The zero-based offset from the beginning of the source text to the
3223
+ # last character in the entity.
3108
3224
  # @return [Integer]
3109
3225
  #
3110
3226
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Entity AWS API Documentation
@@ -3157,9 +3273,9 @@ module Aws::Comprehend
3157
3273
  # @return [String]
3158
3274
  #
3159
3275
  # @!attribute [rw] test_s3_uri
3160
- # This specifies the Amazon S3 location where the test annotations for
3161
- # an entity recognizer are located. The URI must be in the same AWS
3162
- # Region as the API endpoint that you are calling.
3276
+ # Specifies the Amazon S3 location where the test annotations for an
3277
+ # entity recognizer are located. The URI must be in the same region as
3278
+ # the API endpoint that you are calling.
3163
3279
  # @return [String]
3164
3280
  #
3165
3281
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerAnnotations AWS API Documentation
@@ -4041,20 +4157,13 @@ module Aws::Comprehend
4041
4157
  # @return [String]
4042
4158
  #
4043
4159
  # @!attribute [rw] begin_offset
4044
- # A character offset in the input text that shows where the key phrase
4045
- # begins (the first character is at position 0). The offset returns
4046
- # the position of each UTF-8 code point in the string. A *code point*
4047
- # is the abstract character from a particular graphical
4048
- # representation. For example, a multi-byte UTF-8 character maps to a
4049
- # single code point.
4160
+ # The zero-based offset from the beginning of the source text to the
4161
+ # first character in the key phrase.
4050
4162
  # @return [Integer]
4051
4163
  #
4052
4164
  # @!attribute [rw] end_offset
4053
- # A character offset in the input text where the key phrase ends. The
4054
- # offset returns the position of each UTF-8 code point in the string.
4055
- # A `code point` is the abstract character from a particular graphical
4056
- # representation. For example, a multi-byte UTF-8 character maps to a
4057
- # single code point.
4165
+ # The zero-based offset from the beginning of the source text to the
4166
+ # last character in the key phrase.
4058
4167
  # @return [Integer]
4059
4168
  #
4060
4169
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrase AWS API Documentation
@@ -5030,6 +5139,34 @@ module Aws::Comprehend
5030
5139
  include Aws::Structure
5031
5140
  end
5032
5141
 
5142
+ # Contains the sentiment and sentiment score for one mention of an
5143
+ # entity.
5144
+ #
5145
+ # For more information about targeted sentiment, see [Targeted
5146
+ # sentiment][1].
5147
+ #
5148
+ #
5149
+ #
5150
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html
5151
+ #
5152
+ # @!attribute [rw] sentiment
5153
+ # The sentiment of the mention.
5154
+ # @return [String]
5155
+ #
5156
+ # @!attribute [rw] sentiment_score
5157
+ # Describes the level of confidence that Amazon Comprehend has in the
5158
+ # accuracy of its detection of sentiments.
5159
+ # @return [Types::SentimentScore]
5160
+ #
5161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/MentionSentiment AWS API Documentation
5162
+ #
5163
+ class MentionSentiment < Struct.new(
5164
+ :sentiment,
5165
+ :sentiment_score)
5166
+ SENSITIVE = []
5167
+ include Aws::Structure
5168
+ end
5169
+
5033
5170
  # Provides configuration parameters for the output of inference jobs.
5034
5171
  #
5035
5172
  # @note When making an API call, you may pass OutputDataConfig
@@ -5085,7 +5222,12 @@ module Aws::Comprehend
5085
5222
  # Identifies the part of speech represented by the token and gives the
5086
5223
  # confidence that Amazon Comprehend has that the part of speech was
5087
5224
  # correctly identified. For more information about the parts of speech
5088
- # that Amazon Comprehend can identify, see how-syntax.
5225
+ # that Amazon Comprehend can identify, see [Syntax][1] in the Comprehend
5226
+ # Developer Guide.
5227
+ #
5228
+ #
5229
+ #
5230
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
5089
5231
  #
5090
5232
  # @!attribute [rw] tag
5091
5233
  # Identifies the part of speech that the token represents.
@@ -5256,20 +5398,13 @@ module Aws::Comprehend
5256
5398
  # @return [String]
5257
5399
  #
5258
5400
  # @!attribute [rw] begin_offset
5259
- # A character offset in the input text that shows where the PII entity
5260
- # begins (the first character is at position 0). The offset returns
5261
- # the position of each UTF-8 code point in the string. A *code point*
5262
- # is the abstract character from a particular graphical
5263
- # representation. For example, a multi-byte UTF-8 character maps to a
5264
- # single code point.
5401
+ # The zero-based offset from the beginning of the source text to the
5402
+ # first character in the entity.
5265
5403
  # @return [Integer]
5266
5404
  #
5267
5405
  # @!attribute [rw] end_offset
5268
- # A character offset in the input text that shows where the PII entity
5269
- # ends. The offset returns the position of each UTF-8 code point in
5270
- # the string. A *code point* is the abstract character from a
5271
- # particular graphical representation. For example, a multi-byte UTF-8
5272
- # character maps to a single code point.
5406
+ # The zero-based offset from the beginning of the source text to the
5407
+ # last character in the entity.
5273
5408
  # @return [Integer]
5274
5409
  #
5275
5410
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntity AWS API Documentation
@@ -6756,7 +6891,7 @@ module Aws::Comprehend
6756
6891
  #
6757
6892
  # @!attribute [rw] language_code
6758
6893
  # The language of the input documents. Currently, English is the only
6759
- # valid language.
6894
+ # supported language.
6760
6895
  # @return [String]
6761
6896
  #
6762
6897
  # @!attribute [rw] client_request_token
@@ -7351,7 +7486,12 @@ module Aws::Comprehend
7351
7486
  # @!attribute [rw] part_of_speech
7352
7487
  # Provides the part of speech label and the confidence level that
7353
7488
  # Amazon Comprehend has that the part of speech was correctly
7354
- # identified. For more information, see how-syntax.
7489
+ # identified. For more information, see [Syntax][1] in the Comprehend
7490
+ # Developer Guide.
7491
+ #
7492
+ #
7493
+ #
7494
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
7355
7495
  # @return [Types::PartOfSpeechTag]
7356
7496
  #
7357
7497
  # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SyntaxToken AWS API Documentation
@@ -7590,6 +7730,100 @@ module Aws::Comprehend
7590
7730
  include Aws::Structure
7591
7731
  end
7592
7732
 
7733
+ # Information about one of the entities found by targeted sentiment
7734
+ # analysis.
7735
+ #
7736
+ # For more information about targeted sentiment, see [Targeted
7737
+ # sentiment][1].
7738
+ #
7739
+ #
7740
+ #
7741
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html
7742
+ #
7743
+ # @!attribute [rw] descriptive_mention_index
7744
+ # One or more index into the Mentions array that provides the best
7745
+ # name for the entity group.
7746
+ # @return [Array<Integer>]
7747
+ #
7748
+ # @!attribute [rw] mentions
7749
+ # An array of mentions of the entity in the document. The array
7750
+ # represents a co-reference group. See [ Co-reference group][1] for an
7751
+ # example.
7752
+ #
7753
+ #
7754
+ #
7755
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-values
7756
+ # @return [Array<Types::TargetedSentimentMention>]
7757
+ #
7758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentEntity AWS API Documentation
7759
+ #
7760
+ class TargetedSentimentEntity < Struct.new(
7761
+ :descriptive_mention_index,
7762
+ :mentions)
7763
+ SENSITIVE = []
7764
+ include Aws::Structure
7765
+ end
7766
+
7767
+ # Information about one mention of an entity. The mention information
7768
+ # includes the location of the mention in the text and the sentiment of
7769
+ # the mention.
7770
+ #
7771
+ # For more information about targeted sentiment, see [Targeted
7772
+ # sentiment][1].
7773
+ #
7774
+ #
7775
+ #
7776
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html
7777
+ #
7778
+ # @!attribute [rw] score
7779
+ # Model confidence that the entity is relevant. Value range is zero to
7780
+ # one, where one is highest confidence.
7781
+ # @return [Float]
7782
+ #
7783
+ # @!attribute [rw] group_score
7784
+ # The confidence that all the entities mentioned in the group relate
7785
+ # to the same entity.
7786
+ # @return [Float]
7787
+ #
7788
+ # @!attribute [rw] text
7789
+ # The text in the document that identifies the entity.
7790
+ # @return [String]
7791
+ #
7792
+ # @!attribute [rw] type
7793
+ # The type of the entity. Amazon Comprehend supports a variety of
7794
+ # [entity types][1].
7795
+ #
7796
+ #
7797
+ #
7798
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities
7799
+ # @return [String]
7800
+ #
7801
+ # @!attribute [rw] mention_sentiment
7802
+ # Contains the sentiment and sentiment score for the mention.
7803
+ # @return [Types::MentionSentiment]
7804
+ #
7805
+ # @!attribute [rw] begin_offset
7806
+ # The offset into the document text where the mention begins.
7807
+ # @return [Integer]
7808
+ #
7809
+ # @!attribute [rw] end_offset
7810
+ # The offset into the document text where the mention ends.
7811
+ # @return [Integer]
7812
+ #
7813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/TargetedSentimentMention AWS API Documentation
7814
+ #
7815
+ class TargetedSentimentMention < Struct.new(
7816
+ :score,
7817
+ :group_score,
7818
+ :text,
7819
+ :type,
7820
+ :mention_sentiment,
7821
+ :begin_offset,
7822
+ :end_offset)
7823
+ SENSITIVE = []
7824
+ include Aws::Structure
7825
+ end
7826
+
7593
7827
  # The size of the input text exceeds the limit. Use a smaller document.
7594
7828
  #
7595
7829
  # @!attribute [rw] message
@@ -7798,7 +8032,11 @@ module Aws::Comprehend
7798
8032
  # Amazon Comprehend can't process the language of the input text. For
7799
8033
  # custom entity recognition APIs, only English, Spanish, French,
7800
8034
  # Italian, German, or Portuguese are accepted. For a list of supported
7801
- # languages, see supported-languages.
8035
+ # languages, [Supported languages][1] in the Comprehend Developer Guide.
8036
+ #
8037
+ #
8038
+ #
8039
+ # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html
7802
8040
  #
7803
8041
  # @!attribute [rw] message
7804
8042
  # @return [String]
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-comprehend/customizations'
48
48
  # @!group service
49
49
  module Aws::Comprehend
50
50
 
51
- GEM_VERSION = '1.61.0'
51
+ GEM_VERSION = '1.62.0'
52
52
 
53
53
  end
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.61.0
4
+ version: 1.62.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: 2022-05-20 00:00:00.000000000 Z
11
+ date: 2022-09-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core