aws-sdk-comprehend 1.61.0 → 1.63.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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]
@@ -13,9 +13,13 @@ require 'aws-sigv4'
13
13
 
14
14
  require_relative 'aws-sdk-comprehend/types'
15
15
  require_relative 'aws-sdk-comprehend/client_api'
16
+ require_relative 'aws-sdk-comprehend/plugins/endpoints.rb'
16
17
  require_relative 'aws-sdk-comprehend/client'
17
18
  require_relative 'aws-sdk-comprehend/errors'
18
19
  require_relative 'aws-sdk-comprehend/resource'
20
+ require_relative 'aws-sdk-comprehend/endpoint_parameters'
21
+ require_relative 'aws-sdk-comprehend/endpoint_provider'
22
+ require_relative 'aws-sdk-comprehend/endpoints'
19
23
  require_relative 'aws-sdk-comprehend/customizations'
20
24
 
21
25
  # This module provides support for Amazon Comprehend. This module is available in the
@@ -48,6 +52,6 @@ require_relative 'aws-sdk-comprehend/customizations'
48
52
  # @!group service
49
53
  module Aws::Comprehend
50
54
 
51
- GEM_VERSION = '1.61.0'
55
+ GEM_VERSION = '1.63.0'
52
56
 
53
57
  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.63.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-10-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.127.0
22
+ version: 3.165.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.127.0
32
+ version: 3.165.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,11 @@ files:
59
59
  - lib/aws-sdk-comprehend/client.rb
60
60
  - lib/aws-sdk-comprehend/client_api.rb
61
61
  - lib/aws-sdk-comprehend/customizations.rb
62
+ - lib/aws-sdk-comprehend/endpoint_parameters.rb
63
+ - lib/aws-sdk-comprehend/endpoint_provider.rb
64
+ - lib/aws-sdk-comprehend/endpoints.rb
62
65
  - lib/aws-sdk-comprehend/errors.rb
66
+ - lib/aws-sdk-comprehend/plugins/endpoints.rb
63
67
  - lib/aws-sdk-comprehend/resource.rb
64
68
  - lib/aws-sdk-comprehend/types.rb
65
69
  homepage: https://github.com/aws/aws-sdk-ruby