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
@@ -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
|
130
|
-
# contain a maximum of 25 documents. Each document should
|
131
|
-
# least 20 characters
|
132
|
-
#
|
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
|
197
|
-
# contain a maximum of 25 documents.
|
198
|
-
#
|
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
|
270
|
-
# contain a maximum of 25 documents.
|
271
|
-
#
|
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
|
348
|
-
# contain a maximum of 25 documents.
|
349
|
-
#
|
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
|
421
|
-
# contain a maximum of 25 documents.
|
422
|
-
#
|
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.
|
@@ -626,7 +699,12 @@ module Aws::Comprehend
|
|
626
699
|
# @return [String]
|
627
700
|
#
|
628
701
|
# @!attribute [rw] endpoint_arn
|
629
|
-
# The Amazon Resource Number (ARN) of the endpoint.
|
702
|
+
# The Amazon Resource Number (ARN) of the endpoint. For information
|
703
|
+
# about endpoints, see [Managing endpoints][1].
|
704
|
+
#
|
705
|
+
#
|
706
|
+
#
|
707
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
630
708
|
# @return [String]
|
631
709
|
#
|
632
710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ClassifyDocumentRequest AWS API Documentation
|
@@ -687,13 +765,12 @@ module Aws::Comprehend
|
|
687
765
|
# }
|
688
766
|
#
|
689
767
|
# @!attribute [rw] text
|
690
|
-
#
|
691
|
-
# document in real-time, returning personally identifiable information
|
692
|
-
# (PII) entity labels.
|
768
|
+
# A UTF-8 text string. The maximum string size is 100 KB.
|
693
769
|
# @return [String]
|
694
770
|
#
|
695
771
|
# @!attribute [rw] language_code
|
696
|
-
# The language of the input documents.
|
772
|
+
# The language of the input documents. Currently, English is the only
|
773
|
+
# valid language.
|
697
774
|
# @return [String]
|
698
775
|
#
|
699
776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ContainsPiiEntitiesRequest AWS API Documentation
|
@@ -1722,9 +1799,8 @@ module Aws::Comprehend
|
|
1722
1799
|
# }
|
1723
1800
|
#
|
1724
1801
|
# @!attribute [rw] text
|
1725
|
-
# A UTF-8 text string.
|
1726
|
-
#
|
1727
|
-
# characters.
|
1802
|
+
# A UTF-8 text string. The string must contain at least 20 characters.
|
1803
|
+
# The maximum string size is 100 KB.
|
1728
1804
|
# @return [String]
|
1729
1805
|
#
|
1730
1806
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectDominantLanguageRequest AWS API Documentation
|
@@ -1765,8 +1841,7 @@ module Aws::Comprehend
|
|
1765
1841
|
# }
|
1766
1842
|
#
|
1767
1843
|
# @!attribute [rw] text
|
1768
|
-
# A UTF-8 text string.
|
1769
|
-
# of UTF-8 encoded characters.
|
1844
|
+
# A UTF-8 text string. The maximum string size is 100 KB.
|
1770
1845
|
# @return [String]
|
1771
1846
|
#
|
1772
1847
|
# @!attribute [rw] language_code
|
@@ -1789,6 +1864,12 @@ module Aws::Comprehend
|
|
1789
1864
|
# If you specify an endpoint, Amazon Comprehend uses the language of
|
1790
1865
|
# your custom model, and it ignores any language code that you provide
|
1791
1866
|
# in your request.
|
1867
|
+
#
|
1868
|
+
# For information about endpoints, see [Managing endpoints][1].
|
1869
|
+
#
|
1870
|
+
#
|
1871
|
+
#
|
1872
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
1792
1873
|
# @return [String]
|
1793
1874
|
#
|
1794
1875
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesRequest AWS API Documentation
|
@@ -1810,7 +1891,12 @@ module Aws::Comprehend
|
|
1810
1891
|
# If your request uses a custom entity recognition model, Amazon
|
1811
1892
|
# Comprehend detects the entities that the model is trained to
|
1812
1893
|
# recognize. Otherwise, it detects the default entity types. For a
|
1813
|
-
# list of default entity types, see
|
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
|
1814
1900
|
# @return [Array<Types::Entity>]
|
1815
1901
|
#
|
1816
1902
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectEntitiesResponse AWS API Documentation
|
@@ -1830,8 +1916,8 @@ module Aws::Comprehend
|
|
1830
1916
|
# }
|
1831
1917
|
#
|
1832
1918
|
# @!attribute [rw] text
|
1833
|
-
# A UTF-8 text string.
|
1834
|
-
#
|
1919
|
+
# A UTF-8 text string. The string must contain less than 100 KB of
|
1920
|
+
# UTF-8 encoded characters.
|
1835
1921
|
# @return [String]
|
1836
1922
|
#
|
1837
1923
|
# @!attribute [rw] language_code
|
@@ -1874,12 +1960,12 @@ module Aws::Comprehend
|
|
1874
1960
|
# }
|
1875
1961
|
#
|
1876
1962
|
# @!attribute [rw] text
|
1877
|
-
# A UTF-8 text string.
|
1878
|
-
# of UTF-8 encoded characters.
|
1963
|
+
# A UTF-8 text string. The maximum string size is 100 KB.
|
1879
1964
|
# @return [String]
|
1880
1965
|
#
|
1881
1966
|
# @!attribute [rw] language_code
|
1882
|
-
# The language of the input documents.
|
1967
|
+
# The language of the input documents. Currently, English is the only
|
1968
|
+
# valid language.
|
1883
1969
|
# @return [String]
|
1884
1970
|
#
|
1885
1971
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesRequest AWS API Documentation
|
@@ -1915,8 +2001,13 @@ module Aws::Comprehend
|
|
1915
2001
|
# }
|
1916
2002
|
#
|
1917
2003
|
# @!attribute [rw] text
|
1918
|
-
# A UTF-8 text string.
|
1919
|
-
#
|
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>
|
1920
2011
|
# @return [String]
|
1921
2012
|
#
|
1922
2013
|
# @!attribute [rw] language_code
|
@@ -1962,8 +2053,7 @@ module Aws::Comprehend
|
|
1962
2053
|
# }
|
1963
2054
|
#
|
1964
2055
|
# @!attribute [rw] text
|
1965
|
-
# A UTF-8 string.
|
1966
|
-
# UTF encoded characters.
|
2056
|
+
# A UTF-8 string. The maximum string size is 5 KB.
|
1967
2057
|
# @return [String]
|
1968
2058
|
#
|
1969
2059
|
# @!attribute [rw] language_code
|
@@ -1987,7 +2077,11 @@ module Aws::Comprehend
|
|
1987
2077
|
# the response provides the text, the token type, where the text
|
1988
2078
|
# begins and ends, and the level of confidence that Amazon Comprehend
|
1989
2079
|
# has that the token is correct. For a list of token types, see
|
1990
|
-
#
|
2080
|
+
# [Syntax][1] in the Comprehend Developer Guide.
|
2081
|
+
#
|
2082
|
+
#
|
2083
|
+
#
|
2084
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
|
1991
2085
|
# @return [Array<Types::SyntaxToken>]
|
1992
2086
|
#
|
1993
2087
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectSyntaxResponse AWS API Documentation
|
@@ -1998,6 +2092,45 @@ module Aws::Comprehend
|
|
1998
2092
|
include Aws::Structure
|
1999
2093
|
end
|
2000
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
|
+
|
2001
2134
|
# Specifies the class that categorizes the document being analyzed
|
2002
2135
|
#
|
2003
2136
|
# @!attribute [rw] name
|
@@ -2147,7 +2280,7 @@ module Aws::Comprehend
|
|
2147
2280
|
#
|
2148
2281
|
#
|
2149
2282
|
#
|
2150
|
-
# [1]: https://docs.aws.amazon.com/
|
2283
|
+
# [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
|
2151
2284
|
# @return [Types::VpcConfig]
|
2152
2285
|
#
|
2153
2286
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties AWS API Documentation
|
@@ -2220,7 +2353,11 @@ module Aws::Comprehend
|
|
2220
2353
|
# The input properties for training a document classifier.
|
2221
2354
|
#
|
2222
2355
|
# For more information on how the input file is formatted, see
|
2223
|
-
#
|
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
|
2224
2361
|
#
|
2225
2362
|
# @note When making an API call, you may pass DocumentClassifierInputDataConfig
|
2226
2363
|
# data as a hash:
|
@@ -2278,10 +2415,9 @@ module Aws::Comprehend
|
|
2278
2415
|
# @return [String]
|
2279
2416
|
#
|
2280
2417
|
# @!attribute [rw] test_s3_uri
|
2281
|
-
#
|
2282
|
-
#
|
2283
|
-
#
|
2284
|
-
# 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.
|
2285
2421
|
# @return [String]
|
2286
2422
|
#
|
2287
2423
|
# @!attribute [rw] label_delimiter
|
@@ -2449,7 +2585,7 @@ module Aws::Comprehend
|
|
2449
2585
|
#
|
2450
2586
|
#
|
2451
2587
|
#
|
2452
|
-
# [1]: https://docs.aws.amazon.com/
|
2588
|
+
# [1]: https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html
|
2453
2589
|
# @return [Types::VpcConfig]
|
2454
2590
|
#
|
2455
2591
|
# @!attribute [rw] mode
|
@@ -2826,7 +2962,12 @@ module Aws::Comprehend
|
|
2826
2962
|
include Aws::Structure
|
2827
2963
|
end
|
2828
2964
|
|
2829
|
-
# Specifies information about the specified endpoint.
|
2965
|
+
# Specifies information about the specified endpoint. For information
|
2966
|
+
# about endpoints, see [Managing endpoints][1].
|
2967
|
+
#
|
2968
|
+
#
|
2969
|
+
#
|
2970
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html
|
2830
2971
|
#
|
2831
2972
|
# @!attribute [rw] endpoint_arn
|
2832
2973
|
# The Amazon Resource Number (ARN) of the endpoint.
|
@@ -3073,20 +3214,13 @@ module Aws::Comprehend
|
|
3073
3214
|
# @return [String]
|
3074
3215
|
#
|
3075
3216
|
# @!attribute [rw] begin_offset
|
3076
|
-
#
|
3077
|
-
#
|
3078
|
-
# the position of each UTF-8 code point in the string. A *code point*
|
3079
|
-
# is the abstract character from a particular graphical
|
3080
|
-
# representation. For example, a multi-byte UTF-8 character maps to a
|
3081
|
-
# single code point.
|
3217
|
+
# The zero-based offset from the beginning of the source text to the
|
3218
|
+
# first character in the entity.
|
3082
3219
|
# @return [Integer]
|
3083
3220
|
#
|
3084
3221
|
# @!attribute [rw] end_offset
|
3085
|
-
#
|
3086
|
-
#
|
3087
|
-
# the string. A *code point* is the abstract character from a
|
3088
|
-
# particular graphical representation. For example, a multi-byte UTF-8
|
3089
|
-
# 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.
|
3090
3224
|
# @return [Integer]
|
3091
3225
|
#
|
3092
3226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/Entity AWS API Documentation
|
@@ -3139,9 +3273,9 @@ module Aws::Comprehend
|
|
3139
3273
|
# @return [String]
|
3140
3274
|
#
|
3141
3275
|
# @!attribute [rw] test_s3_uri
|
3142
|
-
#
|
3143
|
-
#
|
3144
|
-
#
|
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.
|
3145
3279
|
# @return [String]
|
3146
3280
|
#
|
3147
3281
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerAnnotations AWS API Documentation
|
@@ -4023,20 +4157,13 @@ module Aws::Comprehend
|
|
4023
4157
|
# @return [String]
|
4024
4158
|
#
|
4025
4159
|
# @!attribute [rw] begin_offset
|
4026
|
-
#
|
4027
|
-
#
|
4028
|
-
# the position of each UTF-8 code point in the string. A *code point*
|
4029
|
-
# is the abstract character from a particular graphical
|
4030
|
-
# representation. For example, a multi-byte UTF-8 character maps to a
|
4031
|
-
# single code point.
|
4160
|
+
# The zero-based offset from the beginning of the source text to the
|
4161
|
+
# first character in the key phrase.
|
4032
4162
|
# @return [Integer]
|
4033
4163
|
#
|
4034
4164
|
# @!attribute [rw] end_offset
|
4035
|
-
#
|
4036
|
-
#
|
4037
|
-
# A `code point` is the abstract character from a particular graphical
|
4038
|
-
# representation. For example, a multi-byte UTF-8 character maps to a
|
4039
|
-
# single code point.
|
4165
|
+
# The zero-based offset from the beginning of the source text to the
|
4166
|
+
# last character in the key phrase.
|
4040
4167
|
# @return [Integer]
|
4041
4168
|
#
|
4042
4169
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/KeyPhrase AWS API Documentation
|
@@ -5012,6 +5139,34 @@ module Aws::Comprehend
|
|
5012
5139
|
include Aws::Structure
|
5013
5140
|
end
|
5014
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
|
+
|
5015
5170
|
# Provides configuration parameters for the output of inference jobs.
|
5016
5171
|
#
|
5017
5172
|
# @note When making an API call, you may pass OutputDataConfig
|
@@ -5067,7 +5222,12 @@ module Aws::Comprehend
|
|
5067
5222
|
# Identifies the part of speech represented by the token and gives the
|
5068
5223
|
# confidence that Amazon Comprehend has that the part of speech was
|
5069
5224
|
# correctly identified. For more information about the parts of speech
|
5070
|
-
# that Amazon Comprehend can identify, see
|
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
|
5071
5231
|
#
|
5072
5232
|
# @!attribute [rw] tag
|
5073
5233
|
# Identifies the part of speech that the token represents.
|
@@ -5238,20 +5398,13 @@ module Aws::Comprehend
|
|
5238
5398
|
# @return [String]
|
5239
5399
|
#
|
5240
5400
|
# @!attribute [rw] begin_offset
|
5241
|
-
#
|
5242
|
-
#
|
5243
|
-
# the position of each UTF-8 code point in the string. A *code point*
|
5244
|
-
# is the abstract character from a particular graphical
|
5245
|
-
# representation. For example, a multi-byte UTF-8 character maps to a
|
5246
|
-
# single code point.
|
5401
|
+
# The zero-based offset from the beginning of the source text to the
|
5402
|
+
# first character in the entity.
|
5247
5403
|
# @return [Integer]
|
5248
5404
|
#
|
5249
5405
|
# @!attribute [rw] end_offset
|
5250
|
-
#
|
5251
|
-
#
|
5252
|
-
# the string. A *code point* is the abstract character from a
|
5253
|
-
# particular graphical representation. For example, a multi-byte UTF-8
|
5254
|
-
# 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.
|
5255
5408
|
# @return [Integer]
|
5256
5409
|
#
|
5257
5410
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntity AWS API Documentation
|
@@ -5359,7 +5512,7 @@ module Aws::Comprehend
|
|
5359
5512
|
# data as a hash:
|
5360
5513
|
#
|
5361
5514
|
# {
|
5362
|
-
# 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
|
5515
|
+
# 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
|
5363
5516
|
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
5364
5517
|
# mask_character: "MaskCharacter",
|
5365
5518
|
# }
|
@@ -6405,7 +6558,7 @@ module Aws::Comprehend
|
|
6405
6558
|
# },
|
6406
6559
|
# mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
|
6407
6560
|
# redaction_config: {
|
6408
|
-
# 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
|
6561
|
+
# 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
|
6409
6562
|
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
6410
6563
|
# mask_character: "MaskCharacter",
|
6411
6564
|
# },
|
@@ -6454,7 +6607,8 @@ module Aws::Comprehend
|
|
6454
6607
|
# @return [String]
|
6455
6608
|
#
|
6456
6609
|
# @!attribute [rw] language_code
|
6457
|
-
# The language of the input documents.
|
6610
|
+
# The language of the input documents. Currently, English is the only
|
6611
|
+
# valid language.
|
6458
6612
|
# @return [String]
|
6459
6613
|
#
|
6460
6614
|
# @!attribute [rw] client_request_token
|
@@ -6736,9 +6890,8 @@ module Aws::Comprehend
|
|
6736
6890
|
# @return [String]
|
6737
6891
|
#
|
6738
6892
|
# @!attribute [rw] language_code
|
6739
|
-
# The language of the input documents.
|
6740
|
-
#
|
6741
|
-
# be in the same language.
|
6893
|
+
# The language of the input documents. Currently, English is the only
|
6894
|
+
# supported language.
|
6742
6895
|
# @return [String]
|
6743
6896
|
#
|
6744
6897
|
# @!attribute [rw] client_request_token
|
@@ -7333,7 +7486,12 @@ module Aws::Comprehend
|
|
7333
7486
|
# @!attribute [rw] part_of_speech
|
7334
7487
|
# Provides the part of speech label and the confidence level that
|
7335
7488
|
# Amazon Comprehend has that the part of speech was correctly
|
7336
|
-
# identified. For more information, see
|
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
|
7337
7495
|
# @return [Types::PartOfSpeechTag]
|
7338
7496
|
#
|
7339
7497
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/SyntaxToken AWS API Documentation
|
@@ -7572,6 +7730,100 @@ module Aws::Comprehend
|
|
7572
7730
|
include Aws::Structure
|
7573
7731
|
end
|
7574
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
|
+
|
7575
7827
|
# The size of the input text exceeds the limit. Use a smaller document.
|
7576
7828
|
#
|
7577
7829
|
# @!attribute [rw] message
|
@@ -7780,7 +8032,11 @@ module Aws::Comprehend
|
|
7780
8032
|
# Amazon Comprehend can't process the language of the input text. For
|
7781
8033
|
# custom entity recognition APIs, only English, Spanish, French,
|
7782
8034
|
# Italian, German, or Portuguese are accepted. For a list of supported
|
7783
|
-
# 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
|
7784
8040
|
#
|
7785
8041
|
# @!attribute [rw] message
|
7786
8042
|
# @return [String]
|