aws-sdk-comprehend 1.37.0 → 1.42.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +2 -1
- data/lib/aws-sdk-comprehend/client.rb +493 -3
- data/lib/aws-sdk-comprehend/client_api.rb +312 -2
- data/lib/aws-sdk-comprehend/types.rb +1008 -41
- metadata +4 -4
@@ -10,6 +10,47 @@
|
|
10
10
|
module Aws::Comprehend
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# An augmented manifest file that provides training data for your custom
|
14
|
+
# model. An augmented manifest file is a labeled dataset that is
|
15
|
+
# produced by Amazon SageMaker Ground Truth.
|
16
|
+
#
|
17
|
+
# @note When making an API call, you may pass AugmentedManifestsListItem
|
18
|
+
# data as a hash:
|
19
|
+
#
|
20
|
+
# {
|
21
|
+
# s3_uri: "S3Uri", # required
|
22
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
23
|
+
# }
|
24
|
+
#
|
25
|
+
# @!attribute [rw] s3_uri
|
26
|
+
# The Amazon S3 location of the augmented manifest file.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] attribute_names
|
30
|
+
# The JSON attribute that contains the annotations for your training
|
31
|
+
# documents. The number of attribute names that you specify depends on
|
32
|
+
# whether your augmented manifest file is the output of a single
|
33
|
+
# labeling job or a chained labeling job.
|
34
|
+
#
|
35
|
+
# If your file is the output of a single labeling job, specify the
|
36
|
+
# LabelAttributeName key that was used when the job was created in
|
37
|
+
# Ground Truth.
|
38
|
+
#
|
39
|
+
# If your file is the output of a chained labeling job, specify the
|
40
|
+
# LabelAttributeName key for one or more jobs in the chain. Each
|
41
|
+
# LabelAttributeName key provides the annotations from an individual
|
42
|
+
# job.
|
43
|
+
# @return [Array<String>]
|
44
|
+
#
|
45
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/AugmentedManifestsListItem AWS API Documentation
|
46
|
+
#
|
47
|
+
class AugmentedManifestsListItem < Struct.new(
|
48
|
+
:s3_uri,
|
49
|
+
:attribute_names)
|
50
|
+
SENSITIVE = []
|
51
|
+
include Aws::Structure
|
52
|
+
end
|
53
|
+
|
13
54
|
# The result of calling the operation. The operation returns one object
|
14
55
|
# for each document that is successfully processed by the operation.
|
15
56
|
#
|
@@ -562,7 +603,7 @@ module Aws::Comprehend
|
|
562
603
|
# @!attribute [rw] labels
|
563
604
|
# The labels used the document being analyzed. These are used for
|
564
605
|
# multi-label trained models. Individual labels represent different
|
565
|
-
# categories that are related in some manner and are not
|
606
|
+
# categories that are related in some manner and are not mutually
|
566
607
|
# exclusive. For example, a movie can be just an action movie, or it
|
567
608
|
# can be an action movie, a science fiction movie, and a comedy, all
|
568
609
|
# at the same time.
|
@@ -604,8 +645,15 @@ module Aws::Comprehend
|
|
604
645
|
# },
|
605
646
|
# ],
|
606
647
|
# input_data_config: { # required
|
607
|
-
#
|
648
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
649
|
+
# s3_uri: "S3Uri",
|
608
650
|
# label_delimiter: "LabelDelimiter",
|
651
|
+
# augmented_manifests: [
|
652
|
+
# {
|
653
|
+
# s3_uri: "S3Uri", # required
|
654
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
655
|
+
# },
|
656
|
+
# ],
|
609
657
|
# },
|
610
658
|
# output_data_config: {
|
611
659
|
# s3_uri: "S3Uri",
|
@@ -810,12 +858,13 @@ module Aws::Comprehend
|
|
810
858
|
# },
|
811
859
|
# ],
|
812
860
|
# input_data_config: { # required
|
861
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
813
862
|
# entity_types: [ # required
|
814
863
|
# {
|
815
864
|
# type: "EntityTypeName", # required
|
816
865
|
# },
|
817
866
|
# ],
|
818
|
-
# documents: {
|
867
|
+
# documents: {
|
819
868
|
# s3_uri: "S3Uri", # required
|
820
869
|
# },
|
821
870
|
# annotations: {
|
@@ -824,6 +873,12 @@ module Aws::Comprehend
|
|
824
873
|
# entity_list: {
|
825
874
|
# s3_uri: "S3Uri", # required
|
826
875
|
# },
|
876
|
+
# augmented_manifests: [
|
877
|
+
# {
|
878
|
+
# s3_uri: "S3Uri", # required
|
879
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
880
|
+
# },
|
881
|
+
# ],
|
827
882
|
# },
|
828
883
|
# client_request_token: "ClientRequestTokenString",
|
829
884
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
@@ -1192,6 +1247,38 @@ module Aws::Comprehend
|
|
1192
1247
|
include Aws::Structure
|
1193
1248
|
end
|
1194
1249
|
|
1250
|
+
# @note When making an API call, you may pass DescribeEventsDetectionJobRequest
|
1251
|
+
# data as a hash:
|
1252
|
+
#
|
1253
|
+
# {
|
1254
|
+
# job_id: "JobId", # required
|
1255
|
+
# }
|
1256
|
+
#
|
1257
|
+
# @!attribute [rw] job_id
|
1258
|
+
# The identifier of the events detection job.
|
1259
|
+
# @return [String]
|
1260
|
+
#
|
1261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobRequest AWS API Documentation
|
1262
|
+
#
|
1263
|
+
class DescribeEventsDetectionJobRequest < Struct.new(
|
1264
|
+
:job_id)
|
1265
|
+
SENSITIVE = []
|
1266
|
+
include Aws::Structure
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# @!attribute [rw] events_detection_job_properties
|
1270
|
+
# An object that contains the properties associated with an event
|
1271
|
+
# detection job.
|
1272
|
+
# @return [Types::EventsDetectionJobProperties]
|
1273
|
+
#
|
1274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJobResponse AWS API Documentation
|
1275
|
+
#
|
1276
|
+
class DescribeEventsDetectionJobResponse < Struct.new(
|
1277
|
+
:events_detection_job_properties)
|
1278
|
+
SENSITIVE = []
|
1279
|
+
include Aws::Structure
|
1280
|
+
end
|
1281
|
+
|
1195
1282
|
# @note When making an API call, you may pass DescribeKeyPhrasesDetectionJobRequest
|
1196
1283
|
# data as a hash:
|
1197
1284
|
#
|
@@ -1225,6 +1312,38 @@ module Aws::Comprehend
|
|
1225
1312
|
include Aws::Structure
|
1226
1313
|
end
|
1227
1314
|
|
1315
|
+
# @note When making an API call, you may pass DescribePiiEntitiesDetectionJobRequest
|
1316
|
+
# data as a hash:
|
1317
|
+
#
|
1318
|
+
# {
|
1319
|
+
# job_id: "JobId", # required
|
1320
|
+
# }
|
1321
|
+
#
|
1322
|
+
# @!attribute [rw] job_id
|
1323
|
+
# The identifier that Amazon Comprehend generated for the job. The
|
1324
|
+
# operation returns this identifier in its response.
|
1325
|
+
# @return [String]
|
1326
|
+
#
|
1327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobRequest AWS API Documentation
|
1328
|
+
#
|
1329
|
+
class DescribePiiEntitiesDetectionJobRequest < Struct.new(
|
1330
|
+
:job_id)
|
1331
|
+
SENSITIVE = []
|
1332
|
+
include Aws::Structure
|
1333
|
+
end
|
1334
|
+
|
1335
|
+
# @!attribute [rw] pii_entities_detection_job_properties
|
1336
|
+
# Provides information about a PII entities detection job.
|
1337
|
+
# @return [Types::PiiEntitiesDetectionJobProperties]
|
1338
|
+
#
|
1339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJobResponse AWS API Documentation
|
1340
|
+
#
|
1341
|
+
class DescribePiiEntitiesDetectionJobResponse < Struct.new(
|
1342
|
+
:pii_entities_detection_job_properties)
|
1343
|
+
SENSITIVE = []
|
1344
|
+
include Aws::Structure
|
1345
|
+
end
|
1346
|
+
|
1228
1347
|
# @note When making an API call, you may pass DescribeSentimentDetectionJobRequest
|
1229
1348
|
# data as a hash:
|
1230
1349
|
#
|
@@ -1440,6 +1559,47 @@ module Aws::Comprehend
|
|
1440
1559
|
include Aws::Structure
|
1441
1560
|
end
|
1442
1561
|
|
1562
|
+
# @note When making an API call, you may pass DetectPiiEntitiesRequest
|
1563
|
+
# data as a hash:
|
1564
|
+
#
|
1565
|
+
# {
|
1566
|
+
# text: "String", # required
|
1567
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
1568
|
+
# }
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] text
|
1571
|
+
# A UTF-8 text string. Each string must contain fewer that 5,000 bytes
|
1572
|
+
# of UTF-8 encoded characters.
|
1573
|
+
# @return [String]
|
1574
|
+
#
|
1575
|
+
# @!attribute [rw] language_code
|
1576
|
+
# The language of the input documents.
|
1577
|
+
# @return [String]
|
1578
|
+
#
|
1579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesRequest AWS API Documentation
|
1580
|
+
#
|
1581
|
+
class DetectPiiEntitiesRequest < Struct.new(
|
1582
|
+
:text,
|
1583
|
+
:language_code)
|
1584
|
+
SENSITIVE = []
|
1585
|
+
include Aws::Structure
|
1586
|
+
end
|
1587
|
+
|
1588
|
+
# @!attribute [rw] entities
|
1589
|
+
# A collection of PII entities identified in the input text. For each
|
1590
|
+
# entity, the response provides the entity type, where the entity text
|
1591
|
+
# begins and ends, and the level of confidence that Amazon Comprehend
|
1592
|
+
# has in the detection.
|
1593
|
+
# @return [Array<Types::PiiEntity>]
|
1594
|
+
#
|
1595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntitiesResponse AWS API Documentation
|
1596
|
+
#
|
1597
|
+
class DetectPiiEntitiesResponse < Struct.new(
|
1598
|
+
:entities)
|
1599
|
+
SENSITIVE = []
|
1600
|
+
include Aws::Structure
|
1601
|
+
end
|
1602
|
+
|
1443
1603
|
# @note When making an API call, you may pass DetectSentimentRequest
|
1444
1604
|
# data as a hash:
|
1445
1605
|
#
|
@@ -1740,10 +1900,37 @@ module Aws::Comprehend
|
|
1740
1900
|
# data as a hash:
|
1741
1901
|
#
|
1742
1902
|
# {
|
1743
|
-
#
|
1903
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
1904
|
+
# s3_uri: "S3Uri",
|
1744
1905
|
# label_delimiter: "LabelDelimiter",
|
1906
|
+
# augmented_manifests: [
|
1907
|
+
# {
|
1908
|
+
# s3_uri: "S3Uri", # required
|
1909
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
1910
|
+
# },
|
1911
|
+
# ],
|
1745
1912
|
# }
|
1746
1913
|
#
|
1914
|
+
# @!attribute [rw] data_format
|
1915
|
+
# The format of your training data:
|
1916
|
+
#
|
1917
|
+
# * `COMPREHEND_CSV`\: A two-column CSV file, where labels are
|
1918
|
+
# provided in the first column, and documents are provided in the
|
1919
|
+
# second. If you use this value, you must provide the `S3Uri`
|
1920
|
+
# parameter in your request.
|
1921
|
+
#
|
1922
|
+
# * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
|
1923
|
+
# Amazon SageMaker Ground Truth. This file is in JSON lines format.
|
1924
|
+
# Each line is a complete JSON object that contains a training
|
1925
|
+
# document and its associated labels.
|
1926
|
+
#
|
1927
|
+
# If you use this value, you must provide the `AugmentedManifests`
|
1928
|
+
# parameter in your request.
|
1929
|
+
#
|
1930
|
+
# If you don't specify a value, Amazon Comprehend uses
|
1931
|
+
# `COMPREHEND_CSV` as the default.
|
1932
|
+
# @return [String]
|
1933
|
+
#
|
1747
1934
|
# @!attribute [rw] s3_uri
|
1748
1935
|
# The Amazon S3 URI for the input data. The S3 bucket must be in the
|
1749
1936
|
# same region as the API endpoint that you are calling. The URI can
|
@@ -1754,6 +1941,9 @@ module Aws::Comprehend
|
|
1754
1941
|
# prefix is a single file, Amazon Comprehend uses that file as input.
|
1755
1942
|
# If more than one file begins with the prefix, Amazon Comprehend uses
|
1756
1943
|
# all of them as input.
|
1944
|
+
#
|
1945
|
+
# This parameter is required if you set `DataFormat` to
|
1946
|
+
# `COMPREHEND_CSV`.
|
1757
1947
|
# @return [String]
|
1758
1948
|
#
|
1759
1949
|
# @!attribute [rw] label_delimiter
|
@@ -1766,11 +1956,22 @@ module Aws::Comprehend
|
|
1766
1956
|
# be combined to make a single unique label, such as LABELLABELLABEL.
|
1767
1957
|
# @return [String]
|
1768
1958
|
#
|
1959
|
+
# @!attribute [rw] augmented_manifests
|
1960
|
+
# A list of augmented manifest files that provide training data for
|
1961
|
+
# your custom model. An augmented manifest file is a labeled dataset
|
1962
|
+
# that is produced by Amazon SageMaker Ground Truth.
|
1963
|
+
#
|
1964
|
+
# This parameter is required if you set `DataFormat` to
|
1965
|
+
# `AUGMENTED_MANIFEST`.
|
1966
|
+
# @return [Array<Types::AugmentedManifestsListItem>]
|
1967
|
+
#
|
1769
1968
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierInputDataConfig AWS API Documentation
|
1770
1969
|
#
|
1771
1970
|
class DocumentClassifierInputDataConfig < Struct.new(
|
1971
|
+
:data_format,
|
1772
1972
|
:s3_uri,
|
1773
|
-
:label_delimiter
|
1973
|
+
:label_delimiter,
|
1974
|
+
:augmented_manifests)
|
1774
1975
|
SENSITIVE = []
|
1775
1976
|
include Aws::Structure
|
1776
1977
|
end
|
@@ -2121,7 +2322,7 @@ module Aws::Comprehend
|
|
2121
2322
|
include Aws::Structure
|
2122
2323
|
end
|
2123
2324
|
|
2124
|
-
# The filter used to determine which endpoints are
|
2325
|
+
# The filter used to determine which endpoints are returned. You can
|
2125
2326
|
# filter jobs on their name, model, status, or the date and time that
|
2126
2327
|
# they were created. You can only set one filter at a time.
|
2127
2328
|
#
|
@@ -2553,12 +2754,13 @@ module Aws::Comprehend
|
|
2553
2754
|
# data as a hash:
|
2554
2755
|
#
|
2555
2756
|
# {
|
2757
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
2556
2758
|
# entity_types: [ # required
|
2557
2759
|
# {
|
2558
2760
|
# type: "EntityTypeName", # required
|
2559
2761
|
# },
|
2560
2762
|
# ],
|
2561
|
-
# documents: {
|
2763
|
+
# documents: {
|
2562
2764
|
# s3_uri: "S3Uri", # required
|
2563
2765
|
# },
|
2564
2766
|
# annotations: {
|
@@ -2567,33 +2769,89 @@ module Aws::Comprehend
|
|
2567
2769
|
# entity_list: {
|
2568
2770
|
# s3_uri: "S3Uri", # required
|
2569
2771
|
# },
|
2772
|
+
# augmented_manifests: [
|
2773
|
+
# {
|
2774
|
+
# s3_uri: "S3Uri", # required
|
2775
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
2776
|
+
# },
|
2777
|
+
# ],
|
2570
2778
|
# }
|
2571
2779
|
#
|
2780
|
+
# @!attribute [rw] data_format
|
2781
|
+
# The format of your training data:
|
2782
|
+
#
|
2783
|
+
# * `COMPREHEND_CSV`\: A CSV file that supplements your training
|
2784
|
+
# documents. The CSV file contains information about the custom
|
2785
|
+
# entities that your trained model will detect. The required format
|
2786
|
+
# of the file depends on whether you are providing annotations or an
|
2787
|
+
# entity list.
|
2788
|
+
#
|
2789
|
+
# If you use this value, you must provide your CSV file by using
|
2790
|
+
# either the `Annotations` or `EntityList` parameters. You must
|
2791
|
+
# provide your training documents by using the `Documents`
|
2792
|
+
# parameter.
|
2793
|
+
#
|
2794
|
+
# * `AUGMENTED_MANIFEST`\: A labeled dataset that is produced by
|
2795
|
+
# Amazon SageMaker Ground Truth. This file is in JSON lines format.
|
2796
|
+
# Each line is a complete JSON object that contains a training
|
2797
|
+
# document and its labels. Each label annotates a named entity in
|
2798
|
+
# the training document.
|
2799
|
+
#
|
2800
|
+
# If you use this value, you must provide the `AugmentedManifests`
|
2801
|
+
# parameter in your request.
|
2802
|
+
#
|
2803
|
+
# If you don't specify a value, Amazon Comprehend uses
|
2804
|
+
# `COMPREHEND_CSV` as the default.
|
2805
|
+
# @return [String]
|
2806
|
+
#
|
2572
2807
|
# @!attribute [rw] entity_types
|
2573
|
-
# The entity types in the
|
2574
|
-
#
|
2575
|
-
#
|
2808
|
+
# The entity types in the labeled training data that Amazon Comprehend
|
2809
|
+
# uses to train the custom entity recognizer. Any entity types that
|
2810
|
+
# you don't specify are ignored.
|
2811
|
+
#
|
2812
|
+
# A maximum of 25 entity types can be used at one time to train an
|
2813
|
+
# entity recognizer. Entity types must not contain the following
|
2814
|
+
# invalid characters: \\n (line break), \\\\n (escaped line break),
|
2815
|
+
# \\r (carriage return), \\\\r (escaped carriage return), \\t (tab),
|
2816
|
+
# \\\\t (escaped tab), space, and , (comma).
|
2576
2817
|
# @return [Array<Types::EntityTypesListItem>]
|
2577
2818
|
#
|
2578
2819
|
# @!attribute [rw] documents
|
2579
|
-
# S3 location of the
|
2820
|
+
# The S3 location of the folder that contains the training documents
|
2821
|
+
# for your custom entity recognizer.
|
2822
|
+
#
|
2823
|
+
# This parameter is required if you set `DataFormat` to
|
2824
|
+
# `COMPREHEND_CSV`.
|
2580
2825
|
# @return [Types::EntityRecognizerDocuments]
|
2581
2826
|
#
|
2582
2827
|
# @!attribute [rw] annotations
|
2583
|
-
# S3 location of the
|
2828
|
+
# The S3 location of the CSV file that annotates your training
|
2829
|
+
# documents.
|
2584
2830
|
# @return [Types::EntityRecognizerAnnotations]
|
2585
2831
|
#
|
2586
2832
|
# @!attribute [rw] entity_list
|
2587
|
-
# S3 location of the entity list for
|
2833
|
+
# The S3 location of the CSV file that has the entity list for your
|
2834
|
+
# custom entity recognizer.
|
2588
2835
|
# @return [Types::EntityRecognizerEntityList]
|
2589
2836
|
#
|
2837
|
+
# @!attribute [rw] augmented_manifests
|
2838
|
+
# A list of augmented manifest files that provide training data for
|
2839
|
+
# your custom model. An augmented manifest file is a labeled dataset
|
2840
|
+
# that is produced by Amazon SageMaker Ground Truth.
|
2841
|
+
#
|
2842
|
+
# This parameter is required if you set `DataFormat` to
|
2843
|
+
# `AUGMENTED_MANIFEST`.
|
2844
|
+
# @return [Array<Types::AugmentedManifestsListItem>]
|
2845
|
+
#
|
2590
2846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerInputDataConfig AWS API Documentation
|
2591
2847
|
#
|
2592
2848
|
class EntityRecognizerInputDataConfig < Struct.new(
|
2849
|
+
:data_format,
|
2593
2850
|
:entity_types,
|
2594
2851
|
:documents,
|
2595
2852
|
:annotations,
|
2596
|
-
:entity_list
|
2853
|
+
:entity_list,
|
2854
|
+
:augmented_manifests)
|
2597
2855
|
SENSITIVE = []
|
2598
2856
|
include Aws::Structure
|
2599
2857
|
end
|
@@ -2768,11 +3026,10 @@ module Aws::Comprehend
|
|
2768
3026
|
# @return [Float]
|
2769
3027
|
#
|
2770
3028
|
# @!attribute [rw] f1_score
|
2771
|
-
# A measure of how accurate the recognizer results are for
|
2772
|
-
#
|
2773
|
-
# `
|
2774
|
-
#
|
2775
|
-
# score is 0.
|
3029
|
+
# A measure of how accurate the recognizer results are for a specific
|
3030
|
+
# entity type in the test data. It is derived from the `Precision` and
|
3031
|
+
# `Recall` values. The `F1Score` is the harmonic average of the two
|
3032
|
+
# scores. The highest score is 1, and the worst score is 0.
|
2776
3033
|
# @return [Float]
|
2777
3034
|
#
|
2778
3035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesEvaluationMetrics AWS API Documentation
|
@@ -2785,7 +3042,8 @@ module Aws::Comprehend
|
|
2785
3042
|
include Aws::Structure
|
2786
3043
|
end
|
2787
3044
|
|
2788
|
-
#
|
3045
|
+
# An entity type within a labeled training dataset that Amazon
|
3046
|
+
# Comprehend uses to train a custom entity recognizer.
|
2789
3047
|
#
|
2790
3048
|
# @note When making an API call, you may pass EntityTypesListItem
|
2791
3049
|
# data as a hash:
|
@@ -2795,7 +3053,13 @@ module Aws::Comprehend
|
|
2795
3053
|
# }
|
2796
3054
|
#
|
2797
3055
|
# @!attribute [rw] type
|
2798
|
-
#
|
3056
|
+
# An entity type within a labeled training dataset that Amazon
|
3057
|
+
# Comprehend uses to train a custom entity recognizer.
|
3058
|
+
#
|
3059
|
+
# Entity types must not contain the following invalid characters: \\n
|
3060
|
+
# (line break), \\\\n (escaped line break, \\r (carriage return),
|
3061
|
+
# \\\\r (escaped carriage return), \\t (tab), \\\\t (escaped tab),
|
3062
|
+
# space, and , (comma).
|
2799
3063
|
# @return [String]
|
2800
3064
|
#
|
2801
3065
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityTypesListItem AWS API Documentation
|
@@ -2806,6 +3070,120 @@ module Aws::Comprehend
|
|
2806
3070
|
include Aws::Structure
|
2807
3071
|
end
|
2808
3072
|
|
3073
|
+
# Provides information for filtering a list of event detection jobs.
|
3074
|
+
#
|
3075
|
+
# @note When making an API call, you may pass EventsDetectionJobFilter
|
3076
|
+
# data as a hash:
|
3077
|
+
#
|
3078
|
+
# {
|
3079
|
+
# job_name: "JobName",
|
3080
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3081
|
+
# submit_time_before: Time.now,
|
3082
|
+
# submit_time_after: Time.now,
|
3083
|
+
# }
|
3084
|
+
#
|
3085
|
+
# @!attribute [rw] job_name
|
3086
|
+
# Filters on the name of the events detection job.
|
3087
|
+
# @return [String]
|
3088
|
+
#
|
3089
|
+
# @!attribute [rw] job_status
|
3090
|
+
# Filters the list of jobs based on job status. Returns only jobs with
|
3091
|
+
# the specified status.
|
3092
|
+
# @return [String]
|
3093
|
+
#
|
3094
|
+
# @!attribute [rw] submit_time_before
|
3095
|
+
# Filters the list of jobs based on the time that the job was
|
3096
|
+
# submitted for processing. Returns only jobs submitted before the
|
3097
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
3098
|
+
# newest.
|
3099
|
+
# @return [Time]
|
3100
|
+
#
|
3101
|
+
# @!attribute [rw] submit_time_after
|
3102
|
+
# Filters the list of jobs based on the time that the job was
|
3103
|
+
# submitted for processing. Returns only jobs submitted after the
|
3104
|
+
# specified time. Jobs are returned in descending order, newest to
|
3105
|
+
# oldest.
|
3106
|
+
# @return [Time]
|
3107
|
+
#
|
3108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobFilter AWS API Documentation
|
3109
|
+
#
|
3110
|
+
class EventsDetectionJobFilter < Struct.new(
|
3111
|
+
:job_name,
|
3112
|
+
:job_status,
|
3113
|
+
:submit_time_before,
|
3114
|
+
:submit_time_after)
|
3115
|
+
SENSITIVE = []
|
3116
|
+
include Aws::Structure
|
3117
|
+
end
|
3118
|
+
|
3119
|
+
# Provides information about an events detection job.
|
3120
|
+
#
|
3121
|
+
# @!attribute [rw] job_id
|
3122
|
+
# The identifier assigned to the events detection job.
|
3123
|
+
# @return [String]
|
3124
|
+
#
|
3125
|
+
# @!attribute [rw] job_name
|
3126
|
+
# The name you assigned the events detection job.
|
3127
|
+
# @return [String]
|
3128
|
+
#
|
3129
|
+
# @!attribute [rw] job_status
|
3130
|
+
# The current status of the events detection job.
|
3131
|
+
# @return [String]
|
3132
|
+
#
|
3133
|
+
# @!attribute [rw] message
|
3134
|
+
# A description of the status of the events detection job.
|
3135
|
+
# @return [String]
|
3136
|
+
#
|
3137
|
+
# @!attribute [rw] submit_time
|
3138
|
+
# The time that the events detection job was submitted for processing.
|
3139
|
+
# @return [Time]
|
3140
|
+
#
|
3141
|
+
# @!attribute [rw] end_time
|
3142
|
+
# The time that the events detection job completed.
|
3143
|
+
# @return [Time]
|
3144
|
+
#
|
3145
|
+
# @!attribute [rw] input_data_config
|
3146
|
+
# The input data configuration that you supplied when you created the
|
3147
|
+
# events detection job.
|
3148
|
+
# @return [Types::InputDataConfig]
|
3149
|
+
#
|
3150
|
+
# @!attribute [rw] output_data_config
|
3151
|
+
# The output data configuration that you supplied when you created the
|
3152
|
+
# events detection job.
|
3153
|
+
# @return [Types::OutputDataConfig]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] language_code
|
3156
|
+
# The language code of the input documents.
|
3157
|
+
# @return [String]
|
3158
|
+
#
|
3159
|
+
# @!attribute [rw] data_access_role_arn
|
3160
|
+
# The Amazon Resource Name (ARN) of the AWS Identify and Access
|
3161
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
3162
|
+
# your input data.
|
3163
|
+
# @return [String]
|
3164
|
+
#
|
3165
|
+
# @!attribute [rw] target_event_types
|
3166
|
+
# The types of events that are detected by the job.
|
3167
|
+
# @return [Array<String>]
|
3168
|
+
#
|
3169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EventsDetectionJobProperties AWS API Documentation
|
3170
|
+
#
|
3171
|
+
class EventsDetectionJobProperties < Struct.new(
|
3172
|
+
:job_id,
|
3173
|
+
:job_name,
|
3174
|
+
:job_status,
|
3175
|
+
:message,
|
3176
|
+
:submit_time,
|
3177
|
+
:end_time,
|
3178
|
+
:input_data_config,
|
3179
|
+
:output_data_config,
|
3180
|
+
:language_code,
|
3181
|
+
:data_access_role_arn,
|
3182
|
+
:target_event_types)
|
3183
|
+
SENSITIVE = []
|
3184
|
+
include Aws::Structure
|
3185
|
+
end
|
3186
|
+
|
2809
3187
|
# The input properties for a topic detection job.
|
2810
3188
|
#
|
2811
3189
|
# @note When making an API call, you may pass InputDataConfig
|
@@ -3425,7 +3803,7 @@ module Aws::Comprehend
|
|
3425
3803
|
include Aws::Structure
|
3426
3804
|
end
|
3427
3805
|
|
3428
|
-
# @note When making an API call, you may pass
|
3806
|
+
# @note When making an API call, you may pass ListEventsDetectionJobsRequest
|
3429
3807
|
# data as a hash:
|
3430
3808
|
#
|
3431
3809
|
# {
|
@@ -3443,20 +3821,19 @@ module Aws::Comprehend
|
|
3443
3821
|
# Filters the jobs that are returned. You can filter jobs on their
|
3444
3822
|
# name, status, or the date and time that they were submitted. You can
|
3445
3823
|
# only set one filter at a time.
|
3446
|
-
# @return [Types::
|
3824
|
+
# @return [Types::EventsDetectionJobFilter]
|
3447
3825
|
#
|
3448
3826
|
# @!attribute [rw] next_token
|
3449
3827
|
# Identifies the next page of results to return.
|
3450
3828
|
# @return [String]
|
3451
3829
|
#
|
3452
3830
|
# @!attribute [rw] max_results
|
3453
|
-
# The maximum number of results to return in each page.
|
3454
|
-
# 100.
|
3831
|
+
# The maximum number of results to return in each page.
|
3455
3832
|
# @return [Integer]
|
3456
3833
|
#
|
3457
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/
|
3834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsRequest AWS API Documentation
|
3458
3835
|
#
|
3459
|
-
class
|
3836
|
+
class ListEventsDetectionJobsRequest < Struct.new(
|
3460
3837
|
:filter,
|
3461
3838
|
:next_token,
|
3462
3839
|
:max_results)
|
@@ -3464,24 +3841,24 @@ module Aws::Comprehend
|
|
3464
3841
|
include Aws::Structure
|
3465
3842
|
end
|
3466
3843
|
|
3467
|
-
# @!attribute [rw]
|
3844
|
+
# @!attribute [rw] events_detection_job_properties_list
|
3468
3845
|
# A list containing the properties of each job that is returned.
|
3469
|
-
# @return [Array<Types::
|
3846
|
+
# @return [Array<Types::EventsDetectionJobProperties>]
|
3470
3847
|
#
|
3471
3848
|
# @!attribute [rw] next_token
|
3472
3849
|
# Identifies the next page of results to return.
|
3473
3850
|
# @return [String]
|
3474
3851
|
#
|
3475
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/
|
3852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobsResponse AWS API Documentation
|
3476
3853
|
#
|
3477
|
-
class
|
3478
|
-
:
|
3854
|
+
class ListEventsDetectionJobsResponse < Struct.new(
|
3855
|
+
:events_detection_job_properties_list,
|
3479
3856
|
:next_token)
|
3480
3857
|
SENSITIVE = []
|
3481
3858
|
include Aws::Structure
|
3482
3859
|
end
|
3483
3860
|
|
3484
|
-
# @note When making an API call, you may pass
|
3861
|
+
# @note When making an API call, you may pass ListKeyPhrasesDetectionJobsRequest
|
3485
3862
|
# data as a hash:
|
3486
3863
|
#
|
3487
3864
|
# {
|
@@ -3499,7 +3876,7 @@ module Aws::Comprehend
|
|
3499
3876
|
# Filters the jobs that are returned. You can filter jobs on their
|
3500
3877
|
# name, status, or the date and time that they were submitted. You can
|
3501
3878
|
# only set one filter at a time.
|
3502
|
-
# @return [Types::
|
3879
|
+
# @return [Types::KeyPhrasesDetectionJobFilter]
|
3503
3880
|
#
|
3504
3881
|
# @!attribute [rw] next_token
|
3505
3882
|
# Identifies the next page of results to return.
|
@@ -3510,9 +3887,9 @@ module Aws::Comprehend
|
|
3510
3887
|
# 100.
|
3511
3888
|
# @return [Integer]
|
3512
3889
|
#
|
3513
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/
|
3890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobsRequest AWS API Documentation
|
3514
3891
|
#
|
3515
|
-
class
|
3892
|
+
class ListKeyPhrasesDetectionJobsRequest < Struct.new(
|
3516
3893
|
:filter,
|
3517
3894
|
:next_token,
|
3518
3895
|
:max_results)
|
@@ -3520,17 +3897,128 @@ module Aws::Comprehend
|
|
3520
3897
|
include Aws::Structure
|
3521
3898
|
end
|
3522
3899
|
|
3523
|
-
# @!attribute [rw]
|
3900
|
+
# @!attribute [rw] key_phrases_detection_job_properties_list
|
3524
3901
|
# A list containing the properties of each job that is returned.
|
3525
|
-
# @return [Array<Types::
|
3902
|
+
# @return [Array<Types::KeyPhrasesDetectionJobProperties>]
|
3526
3903
|
#
|
3527
3904
|
# @!attribute [rw] next_token
|
3528
3905
|
# Identifies the next page of results to return.
|
3529
3906
|
# @return [String]
|
3530
3907
|
#
|
3531
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/
|
3908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListKeyPhrasesDetectionJobsResponse AWS API Documentation
|
3532
3909
|
#
|
3533
|
-
class
|
3910
|
+
class ListKeyPhrasesDetectionJobsResponse < Struct.new(
|
3911
|
+
:key_phrases_detection_job_properties_list,
|
3912
|
+
:next_token)
|
3913
|
+
SENSITIVE = []
|
3914
|
+
include Aws::Structure
|
3915
|
+
end
|
3916
|
+
|
3917
|
+
# @note When making an API call, you may pass ListPiiEntitiesDetectionJobsRequest
|
3918
|
+
# data as a hash:
|
3919
|
+
#
|
3920
|
+
# {
|
3921
|
+
# filter: {
|
3922
|
+
# job_name: "JobName",
|
3923
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3924
|
+
# submit_time_before: Time.now,
|
3925
|
+
# submit_time_after: Time.now,
|
3926
|
+
# },
|
3927
|
+
# next_token: "String",
|
3928
|
+
# max_results: 1,
|
3929
|
+
# }
|
3930
|
+
#
|
3931
|
+
# @!attribute [rw] filter
|
3932
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
3933
|
+
# name, status, or the date and time that they were submitted. You can
|
3934
|
+
# only set one filter at a time.
|
3935
|
+
# @return [Types::PiiEntitiesDetectionJobFilter]
|
3936
|
+
#
|
3937
|
+
# @!attribute [rw] next_token
|
3938
|
+
# Identifies the next page of results to return.
|
3939
|
+
# @return [String]
|
3940
|
+
#
|
3941
|
+
# @!attribute [rw] max_results
|
3942
|
+
# The maximum number of results to return in each page.
|
3943
|
+
# @return [Integer]
|
3944
|
+
#
|
3945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsRequest AWS API Documentation
|
3946
|
+
#
|
3947
|
+
class ListPiiEntitiesDetectionJobsRequest < Struct.new(
|
3948
|
+
:filter,
|
3949
|
+
:next_token,
|
3950
|
+
:max_results)
|
3951
|
+
SENSITIVE = []
|
3952
|
+
include Aws::Structure
|
3953
|
+
end
|
3954
|
+
|
3955
|
+
# @!attribute [rw] pii_entities_detection_job_properties_list
|
3956
|
+
# A list containing the properties of each job that is returned.
|
3957
|
+
# @return [Array<Types::PiiEntitiesDetectionJobProperties>]
|
3958
|
+
#
|
3959
|
+
# @!attribute [rw] next_token
|
3960
|
+
# Identifies the next page of results to return.
|
3961
|
+
# @return [String]
|
3962
|
+
#
|
3963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobsResponse AWS API Documentation
|
3964
|
+
#
|
3965
|
+
class ListPiiEntitiesDetectionJobsResponse < Struct.new(
|
3966
|
+
:pii_entities_detection_job_properties_list,
|
3967
|
+
:next_token)
|
3968
|
+
SENSITIVE = []
|
3969
|
+
include Aws::Structure
|
3970
|
+
end
|
3971
|
+
|
3972
|
+
# @note When making an API call, you may pass ListSentimentDetectionJobsRequest
|
3973
|
+
# data as a hash:
|
3974
|
+
#
|
3975
|
+
# {
|
3976
|
+
# filter: {
|
3977
|
+
# job_name: "JobName",
|
3978
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
3979
|
+
# submit_time_before: Time.now,
|
3980
|
+
# submit_time_after: Time.now,
|
3981
|
+
# },
|
3982
|
+
# next_token: "String",
|
3983
|
+
# max_results: 1,
|
3984
|
+
# }
|
3985
|
+
#
|
3986
|
+
# @!attribute [rw] filter
|
3987
|
+
# Filters the jobs that are returned. You can filter jobs on their
|
3988
|
+
# name, status, or the date and time that they were submitted. You can
|
3989
|
+
# only set one filter at a time.
|
3990
|
+
# @return [Types::SentimentDetectionJobFilter]
|
3991
|
+
#
|
3992
|
+
# @!attribute [rw] next_token
|
3993
|
+
# Identifies the next page of results to return.
|
3994
|
+
# @return [String]
|
3995
|
+
#
|
3996
|
+
# @!attribute [rw] max_results
|
3997
|
+
# The maximum number of results to return in each page. The default is
|
3998
|
+
# 100.
|
3999
|
+
# @return [Integer]
|
4000
|
+
#
|
4001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobsRequest AWS API Documentation
|
4002
|
+
#
|
4003
|
+
class ListSentimentDetectionJobsRequest < Struct.new(
|
4004
|
+
:filter,
|
4005
|
+
:next_token,
|
4006
|
+
:max_results)
|
4007
|
+
SENSITIVE = []
|
4008
|
+
include Aws::Structure
|
4009
|
+
end
|
4010
|
+
|
4011
|
+
# @!attribute [rw] sentiment_detection_job_properties_list
|
4012
|
+
# A list containing the properties of each job that is returned.
|
4013
|
+
# @return [Array<Types::SentimentDetectionJobProperties>]
|
4014
|
+
#
|
4015
|
+
# @!attribute [rw] next_token
|
4016
|
+
# Identifies the next page of results to return.
|
4017
|
+
# @return [String]
|
4018
|
+
#
|
4019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListSentimentDetectionJobsResponse AWS API Documentation
|
4020
|
+
#
|
4021
|
+
class ListSentimentDetectionJobsResponse < Struct.new(
|
3534
4022
|
:sentiment_detection_job_properties_list,
|
3535
4023
|
:next_token)
|
3536
4024
|
SENSITIVE = []
|
@@ -3707,6 +4195,228 @@ module Aws::Comprehend
|
|
3707
4195
|
include Aws::Structure
|
3708
4196
|
end
|
3709
4197
|
|
4198
|
+
# Provides information for filtering a list of PII entity detection
|
4199
|
+
# jobs.
|
4200
|
+
#
|
4201
|
+
# @note When making an API call, you may pass PiiEntitiesDetectionJobFilter
|
4202
|
+
# data as a hash:
|
4203
|
+
#
|
4204
|
+
# {
|
4205
|
+
# job_name: "JobName",
|
4206
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
4207
|
+
# submit_time_before: Time.now,
|
4208
|
+
# submit_time_after: Time.now,
|
4209
|
+
# }
|
4210
|
+
#
|
4211
|
+
# @!attribute [rw] job_name
|
4212
|
+
# Filters on the name of the job.
|
4213
|
+
# @return [String]
|
4214
|
+
#
|
4215
|
+
# @!attribute [rw] job_status
|
4216
|
+
# Filters the list of jobs based on job status. Returns only jobs with
|
4217
|
+
# the specified status.
|
4218
|
+
# @return [String]
|
4219
|
+
#
|
4220
|
+
# @!attribute [rw] submit_time_before
|
4221
|
+
# Filters the list of jobs based on the time that the job was
|
4222
|
+
# submitted for processing. Returns only jobs submitted before the
|
4223
|
+
# specified time. Jobs are returned in ascending order, oldest to
|
4224
|
+
# newest.
|
4225
|
+
# @return [Time]
|
4226
|
+
#
|
4227
|
+
# @!attribute [rw] submit_time_after
|
4228
|
+
# Filters the list of jobs based on the time that the job was
|
4229
|
+
# submitted for processing. Returns only jobs submitted after the
|
4230
|
+
# specified time. Jobs are returned in descending order, newest to
|
4231
|
+
# oldest.
|
4232
|
+
# @return [Time]
|
4233
|
+
#
|
4234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobFilter AWS API Documentation
|
4235
|
+
#
|
4236
|
+
class PiiEntitiesDetectionJobFilter < Struct.new(
|
4237
|
+
:job_name,
|
4238
|
+
:job_status,
|
4239
|
+
:submit_time_before,
|
4240
|
+
:submit_time_after)
|
4241
|
+
SENSITIVE = []
|
4242
|
+
include Aws::Structure
|
4243
|
+
end
|
4244
|
+
|
4245
|
+
# Provides information about a PII entities detection job.
|
4246
|
+
#
|
4247
|
+
# @!attribute [rw] job_id
|
4248
|
+
# The identifier assigned to the PII entities detection job.
|
4249
|
+
# @return [String]
|
4250
|
+
#
|
4251
|
+
# @!attribute [rw] job_name
|
4252
|
+
# The name that you assigned the PII entities detection job.
|
4253
|
+
# @return [String]
|
4254
|
+
#
|
4255
|
+
# @!attribute [rw] job_status
|
4256
|
+
# The current status of the PII entities detection job. If the status
|
4257
|
+
# is `FAILED`, the `Message` field shows the reason for the failure.
|
4258
|
+
# @return [String]
|
4259
|
+
#
|
4260
|
+
# @!attribute [rw] message
|
4261
|
+
# A description of the status of a job.
|
4262
|
+
# @return [String]
|
4263
|
+
#
|
4264
|
+
# @!attribute [rw] submit_time
|
4265
|
+
# The time that the PII entities detection job was submitted for
|
4266
|
+
# processing.
|
4267
|
+
# @return [Time]
|
4268
|
+
#
|
4269
|
+
# @!attribute [rw] end_time
|
4270
|
+
# The time that the PII entities detection job completed.
|
4271
|
+
# @return [Time]
|
4272
|
+
#
|
4273
|
+
# @!attribute [rw] input_data_config
|
4274
|
+
# The input properties for a PII entities detection job.
|
4275
|
+
# @return [Types::InputDataConfig]
|
4276
|
+
#
|
4277
|
+
# @!attribute [rw] output_data_config
|
4278
|
+
# The output data configuration that you supplied when you created the
|
4279
|
+
# PII entities detection job.
|
4280
|
+
# @return [Types::PiiOutputDataConfig]
|
4281
|
+
#
|
4282
|
+
# @!attribute [rw] redaction_config
|
4283
|
+
# Provides configuration parameters for PII entity redaction.
|
4284
|
+
#
|
4285
|
+
# This parameter is required if you set the `Mode` parameter to
|
4286
|
+
# `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
|
4287
|
+
# definition that includes the `PiiEntityTypes` parameter.
|
4288
|
+
# @return [Types::RedactionConfig]
|
4289
|
+
#
|
4290
|
+
# @!attribute [rw] language_code
|
4291
|
+
# The language code of the input documents
|
4292
|
+
# @return [String]
|
4293
|
+
#
|
4294
|
+
# @!attribute [rw] data_access_role_arn
|
4295
|
+
# The Amazon Resource Name (ARN) that gives Amazon Comprehend read
|
4296
|
+
# access to your input data.
|
4297
|
+
# @return [String]
|
4298
|
+
#
|
4299
|
+
# @!attribute [rw] mode
|
4300
|
+
# Specifies whether the output provides the locations (offsets) of PII
|
4301
|
+
# entities or a file in which PII entities are redacted.
|
4302
|
+
# @return [String]
|
4303
|
+
#
|
4304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntitiesDetectionJobProperties AWS API Documentation
|
4305
|
+
#
|
4306
|
+
class PiiEntitiesDetectionJobProperties < Struct.new(
|
4307
|
+
:job_id,
|
4308
|
+
:job_name,
|
4309
|
+
:job_status,
|
4310
|
+
:message,
|
4311
|
+
:submit_time,
|
4312
|
+
:end_time,
|
4313
|
+
:input_data_config,
|
4314
|
+
:output_data_config,
|
4315
|
+
:redaction_config,
|
4316
|
+
:language_code,
|
4317
|
+
:data_access_role_arn,
|
4318
|
+
:mode)
|
4319
|
+
SENSITIVE = []
|
4320
|
+
include Aws::Structure
|
4321
|
+
end
|
4322
|
+
|
4323
|
+
# Provides information about a PII entity.
|
4324
|
+
#
|
4325
|
+
# @!attribute [rw] score
|
4326
|
+
# The level of confidence that Amazon Comprehend has in the accuracy
|
4327
|
+
# of the detection.
|
4328
|
+
# @return [Float]
|
4329
|
+
#
|
4330
|
+
# @!attribute [rw] type
|
4331
|
+
# The entity's type.
|
4332
|
+
# @return [String]
|
4333
|
+
#
|
4334
|
+
# @!attribute [rw] begin_offset
|
4335
|
+
# A character offset in the input text that shows where the PII entity
|
4336
|
+
# begins (the first character is at position 0). The offset returns
|
4337
|
+
# the position of each UTF-8 code point in the string. A *code point*
|
4338
|
+
# is the abstract character from a particular graphical
|
4339
|
+
# representation. For example, a multi-byte UTF-8 character maps to a
|
4340
|
+
# single code point.
|
4341
|
+
# @return [Integer]
|
4342
|
+
#
|
4343
|
+
# @!attribute [rw] end_offset
|
4344
|
+
# A character offset in the input text that shows where the PII entity
|
4345
|
+
# ends. The offset returns the position of each UTF-8 code point in
|
4346
|
+
# the string. A *code point* is the abstract character from a
|
4347
|
+
# particular graphical representation. For example, a multi-byte UTF-8
|
4348
|
+
# character maps to a single code point.
|
4349
|
+
# @return [Integer]
|
4350
|
+
#
|
4351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiEntity AWS API Documentation
|
4352
|
+
#
|
4353
|
+
class PiiEntity < Struct.new(
|
4354
|
+
:score,
|
4355
|
+
:type,
|
4356
|
+
:begin_offset,
|
4357
|
+
:end_offset)
|
4358
|
+
SENSITIVE = []
|
4359
|
+
include Aws::Structure
|
4360
|
+
end
|
4361
|
+
|
4362
|
+
# Provides configuration parameters for the output of PII entity
|
4363
|
+
# detection jobs.
|
4364
|
+
#
|
4365
|
+
# @!attribute [rw] s3_uri
|
4366
|
+
# When you use the `PiiOutputDataConfig` object with asynchronous
|
4367
|
+
# operations, you specify the Amazon S3 location where you want to
|
4368
|
+
# write the output data.
|
4369
|
+
# @return [String]
|
4370
|
+
#
|
4371
|
+
# @!attribute [rw] kms_key_id
|
4372
|
+
# ID for the AWS Key Management Service (KMS) key that Amazon
|
4373
|
+
# Comprehend uses to encrypt the output results from an analysis job.
|
4374
|
+
# @return [String]
|
4375
|
+
#
|
4376
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/PiiOutputDataConfig AWS API Documentation
|
4377
|
+
#
|
4378
|
+
class PiiOutputDataConfig < Struct.new(
|
4379
|
+
:s3_uri,
|
4380
|
+
:kms_key_id)
|
4381
|
+
SENSITIVE = []
|
4382
|
+
include Aws::Structure
|
4383
|
+
end
|
4384
|
+
|
4385
|
+
# Provides configuration parameters for PII entity redaction.
|
4386
|
+
#
|
4387
|
+
# @note When making an API call, you may pass RedactionConfig
|
4388
|
+
# data as a hash:
|
4389
|
+
#
|
4390
|
+
# {
|
4391
|
+
# 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
|
4392
|
+
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
4393
|
+
# mask_character: "MaskCharacter",
|
4394
|
+
# }
|
4395
|
+
#
|
4396
|
+
# @!attribute [rw] pii_entity_types
|
4397
|
+
# An array of the types of PII entities that Amazon Comprehend detects
|
4398
|
+
# in the input text for your request.
|
4399
|
+
# @return [Array<String>]
|
4400
|
+
#
|
4401
|
+
# @!attribute [rw] mask_mode
|
4402
|
+
# Specifies whether the PII entity is redacted with the mask character
|
4403
|
+
# or the entity type.
|
4404
|
+
# @return [String]
|
4405
|
+
#
|
4406
|
+
# @!attribute [rw] mask_character
|
4407
|
+
# A character that replaces each character in the redacted PII entity.
|
4408
|
+
# @return [String]
|
4409
|
+
#
|
4410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/RedactionConfig AWS API Documentation
|
4411
|
+
#
|
4412
|
+
class RedactionConfig < Struct.new(
|
4413
|
+
:pii_entity_types,
|
4414
|
+
:mask_mode,
|
4415
|
+
:mask_character)
|
4416
|
+
SENSITIVE = []
|
4417
|
+
include Aws::Structure
|
4418
|
+
end
|
4419
|
+
|
3710
4420
|
# The specified resource name is already in use. Use a different name
|
3711
4421
|
# and try your request again.
|
3712
4422
|
#
|
@@ -4314,6 +5024,91 @@ module Aws::Comprehend
|
|
4314
5024
|
include Aws::Structure
|
4315
5025
|
end
|
4316
5026
|
|
5027
|
+
# @note When making an API call, you may pass StartEventsDetectionJobRequest
|
5028
|
+
# data as a hash:
|
5029
|
+
#
|
5030
|
+
# {
|
5031
|
+
# input_data_config: { # required
|
5032
|
+
# s3_uri: "S3Uri", # required
|
5033
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5034
|
+
# },
|
5035
|
+
# output_data_config: { # required
|
5036
|
+
# s3_uri: "S3Uri", # required
|
5037
|
+
# kms_key_id: "KmsKeyId",
|
5038
|
+
# },
|
5039
|
+
# data_access_role_arn: "IamRoleArn", # required
|
5040
|
+
# job_name: "JobName",
|
5041
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5042
|
+
# client_request_token: "ClientRequestTokenString",
|
5043
|
+
# target_event_types: ["EventTypeString"], # required
|
5044
|
+
# }
|
5045
|
+
#
|
5046
|
+
# @!attribute [rw] input_data_config
|
5047
|
+
# Specifies the format and location of the input data for the job.
|
5048
|
+
# @return [Types::InputDataConfig]
|
5049
|
+
#
|
5050
|
+
# @!attribute [rw] output_data_config
|
5051
|
+
# Specifies where to send the output files.
|
5052
|
+
# @return [Types::OutputDataConfig]
|
5053
|
+
#
|
5054
|
+
# @!attribute [rw] data_access_role_arn
|
5055
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
5056
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
5057
|
+
# your input data.
|
5058
|
+
# @return [String]
|
5059
|
+
#
|
5060
|
+
# @!attribute [rw] job_name
|
5061
|
+
# The identifier of the events detection job.
|
5062
|
+
# @return [String]
|
5063
|
+
#
|
5064
|
+
# @!attribute [rw] language_code
|
5065
|
+
# The language code of the input documents.
|
5066
|
+
# @return [String]
|
5067
|
+
#
|
5068
|
+
# @!attribute [rw] client_request_token
|
5069
|
+
# An unique identifier for the request. If you don't set the client
|
5070
|
+
# request token, Amazon Comprehend generates one.
|
5071
|
+
#
|
5072
|
+
# **A suitable default value is auto-generated.** You should normally
|
5073
|
+
# not need to pass this option.
|
5074
|
+
# @return [String]
|
5075
|
+
#
|
5076
|
+
# @!attribute [rw] target_event_types
|
5077
|
+
# The types of events to detect in the input documents.
|
5078
|
+
# @return [Array<String>]
|
5079
|
+
#
|
5080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobRequest AWS API Documentation
|
5081
|
+
#
|
5082
|
+
class StartEventsDetectionJobRequest < Struct.new(
|
5083
|
+
:input_data_config,
|
5084
|
+
:output_data_config,
|
5085
|
+
:data_access_role_arn,
|
5086
|
+
:job_name,
|
5087
|
+
:language_code,
|
5088
|
+
:client_request_token,
|
5089
|
+
:target_event_types)
|
5090
|
+
SENSITIVE = []
|
5091
|
+
include Aws::Structure
|
5092
|
+
end
|
5093
|
+
|
5094
|
+
# @!attribute [rw] job_id
|
5095
|
+
# An unique identifier for the request. If you don't set the client
|
5096
|
+
# request token, Amazon Comprehend generates one.
|
5097
|
+
# @return [String]
|
5098
|
+
#
|
5099
|
+
# @!attribute [rw] job_status
|
5100
|
+
# The status of the events detection job.
|
5101
|
+
# @return [String]
|
5102
|
+
#
|
5103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobResponse AWS API Documentation
|
5104
|
+
#
|
5105
|
+
class StartEventsDetectionJobResponse < Struct.new(
|
5106
|
+
:job_id,
|
5107
|
+
:job_status)
|
5108
|
+
SENSITIVE = []
|
5109
|
+
include Aws::Structure
|
5110
|
+
end
|
5111
|
+
|
4317
5112
|
# @note When making an API call, you may pass StartKeyPhrasesDetectionJobRequest
|
4318
5113
|
# data as a hash:
|
4319
5114
|
#
|
@@ -4440,6 +5235,106 @@ module Aws::Comprehend
|
|
4440
5235
|
include Aws::Structure
|
4441
5236
|
end
|
4442
5237
|
|
5238
|
+
# @note When making an API call, you may pass StartPiiEntitiesDetectionJobRequest
|
5239
|
+
# data as a hash:
|
5240
|
+
#
|
5241
|
+
# {
|
5242
|
+
# input_data_config: { # required
|
5243
|
+
# s3_uri: "S3Uri", # required
|
5244
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5245
|
+
# },
|
5246
|
+
# output_data_config: { # required
|
5247
|
+
# s3_uri: "S3Uri", # required
|
5248
|
+
# kms_key_id: "KmsKeyId",
|
5249
|
+
# },
|
5250
|
+
# mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
|
5251
|
+
# redaction_config: {
|
5252
|
+
# 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
|
5253
|
+
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
5254
|
+
# mask_character: "MaskCharacter",
|
5255
|
+
# },
|
5256
|
+
# data_access_role_arn: "IamRoleArn", # required
|
5257
|
+
# job_name: "JobName",
|
5258
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5259
|
+
# client_request_token: "ClientRequestTokenString",
|
5260
|
+
# }
|
5261
|
+
#
|
5262
|
+
# @!attribute [rw] input_data_config
|
5263
|
+
# The input properties for a PII entities detection job.
|
5264
|
+
# @return [Types::InputDataConfig]
|
5265
|
+
#
|
5266
|
+
# @!attribute [rw] output_data_config
|
5267
|
+
# Provides configuration parameters for the output of PII entity
|
5268
|
+
# detection jobs.
|
5269
|
+
# @return [Types::OutputDataConfig]
|
5270
|
+
#
|
5271
|
+
# @!attribute [rw] mode
|
5272
|
+
# Specifies whether the output provides the locations (offsets) of PII
|
5273
|
+
# entities or a file in which PII entities are redacted.
|
5274
|
+
# @return [String]
|
5275
|
+
#
|
5276
|
+
# @!attribute [rw] redaction_config
|
5277
|
+
# Provides configuration parameters for PII entity redaction.
|
5278
|
+
#
|
5279
|
+
# This parameter is required if you set the `Mode` parameter to
|
5280
|
+
# `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
|
5281
|
+
# definition that includes the `PiiEntityTypes` parameter.
|
5282
|
+
# @return [Types::RedactionConfig]
|
5283
|
+
#
|
5284
|
+
# @!attribute [rw] data_access_role_arn
|
5285
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
5286
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
5287
|
+
# your input data.
|
5288
|
+
# @return [String]
|
5289
|
+
#
|
5290
|
+
# @!attribute [rw] job_name
|
5291
|
+
# The identifier of the job.
|
5292
|
+
# @return [String]
|
5293
|
+
#
|
5294
|
+
# @!attribute [rw] language_code
|
5295
|
+
# The language of the input documents.
|
5296
|
+
# @return [String]
|
5297
|
+
#
|
5298
|
+
# @!attribute [rw] client_request_token
|
5299
|
+
# A unique identifier for the request. If you don't set the client
|
5300
|
+
# request token, Amazon Comprehend generates one.
|
5301
|
+
#
|
5302
|
+
# **A suitable default value is auto-generated.** You should normally
|
5303
|
+
# not need to pass this option.
|
5304
|
+
# @return [String]
|
5305
|
+
#
|
5306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
|
5307
|
+
#
|
5308
|
+
class StartPiiEntitiesDetectionJobRequest < Struct.new(
|
5309
|
+
:input_data_config,
|
5310
|
+
:output_data_config,
|
5311
|
+
:mode,
|
5312
|
+
:redaction_config,
|
5313
|
+
:data_access_role_arn,
|
5314
|
+
:job_name,
|
5315
|
+
:language_code,
|
5316
|
+
:client_request_token)
|
5317
|
+
SENSITIVE = []
|
5318
|
+
include Aws::Structure
|
5319
|
+
end
|
5320
|
+
|
5321
|
+
# @!attribute [rw] job_id
|
5322
|
+
# The identifier generated for the job.
|
5323
|
+
# @return [String]
|
5324
|
+
#
|
5325
|
+
# @!attribute [rw] job_status
|
5326
|
+
# The status of the job.
|
5327
|
+
# @return [String]
|
5328
|
+
#
|
5329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobResponse AWS API Documentation
|
5330
|
+
#
|
5331
|
+
class StartPiiEntitiesDetectionJobResponse < Struct.new(
|
5332
|
+
:job_id,
|
5333
|
+
:job_status)
|
5334
|
+
SENSITIVE = []
|
5335
|
+
include Aws::Structure
|
5336
|
+
end
|
5337
|
+
|
4443
5338
|
# @note When making an API call, you may pass StartSentimentDetectionJobRequest
|
4444
5339
|
# data as a hash:
|
4445
5340
|
#
|
@@ -4769,6 +5664,42 @@ module Aws::Comprehend
|
|
4769
5664
|
include Aws::Structure
|
4770
5665
|
end
|
4771
5666
|
|
5667
|
+
# @note When making an API call, you may pass StopEventsDetectionJobRequest
|
5668
|
+
# data as a hash:
|
5669
|
+
#
|
5670
|
+
# {
|
5671
|
+
# job_id: "JobId", # required
|
5672
|
+
# }
|
5673
|
+
#
|
5674
|
+
# @!attribute [rw] job_id
|
5675
|
+
# The identifier of the events detection job to stop.
|
5676
|
+
# @return [String]
|
5677
|
+
#
|
5678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobRequest AWS API Documentation
|
5679
|
+
#
|
5680
|
+
class StopEventsDetectionJobRequest < Struct.new(
|
5681
|
+
:job_id)
|
5682
|
+
SENSITIVE = []
|
5683
|
+
include Aws::Structure
|
5684
|
+
end
|
5685
|
+
|
5686
|
+
# @!attribute [rw] job_id
|
5687
|
+
# The identifier of the events detection job to stop.
|
5688
|
+
# @return [String]
|
5689
|
+
#
|
5690
|
+
# @!attribute [rw] job_status
|
5691
|
+
# The status of the events detection job.
|
5692
|
+
# @return [String]
|
5693
|
+
#
|
5694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJobResponse AWS API Documentation
|
5695
|
+
#
|
5696
|
+
class StopEventsDetectionJobResponse < Struct.new(
|
5697
|
+
:job_id,
|
5698
|
+
:job_status)
|
5699
|
+
SENSITIVE = []
|
5700
|
+
include Aws::Structure
|
5701
|
+
end
|
5702
|
+
|
4772
5703
|
# @note When making an API call, you may pass StopKeyPhrasesDetectionJobRequest
|
4773
5704
|
# data as a hash:
|
4774
5705
|
#
|
@@ -4807,6 +5738,42 @@ module Aws::Comprehend
|
|
4807
5738
|
include Aws::Structure
|
4808
5739
|
end
|
4809
5740
|
|
5741
|
+
# @note When making an API call, you may pass StopPiiEntitiesDetectionJobRequest
|
5742
|
+
# data as a hash:
|
5743
|
+
#
|
5744
|
+
# {
|
5745
|
+
# job_id: "JobId", # required
|
5746
|
+
# }
|
5747
|
+
#
|
5748
|
+
# @!attribute [rw] job_id
|
5749
|
+
# The identifier of the PII entities detection job to stop.
|
5750
|
+
# @return [String]
|
5751
|
+
#
|
5752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobRequest AWS API Documentation
|
5753
|
+
#
|
5754
|
+
class StopPiiEntitiesDetectionJobRequest < Struct.new(
|
5755
|
+
:job_id)
|
5756
|
+
SENSITIVE = []
|
5757
|
+
include Aws::Structure
|
5758
|
+
end
|
5759
|
+
|
5760
|
+
# @!attribute [rw] job_id
|
5761
|
+
# The identifier of the PII entities detection job to stop.
|
5762
|
+
# @return [String]
|
5763
|
+
#
|
5764
|
+
# @!attribute [rw] job_status
|
5765
|
+
# The status of the PII entities detection job.
|
5766
|
+
# @return [String]
|
5767
|
+
#
|
5768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJobResponse AWS API Documentation
|
5769
|
+
#
|
5770
|
+
class StopPiiEntitiesDetectionJobResponse < Struct.new(
|
5771
|
+
:job_id,
|
5772
|
+
:job_status)
|
5773
|
+
SENSITIVE = []
|
5774
|
+
include Aws::Structure
|
5775
|
+
end
|
5776
|
+
|
4810
5777
|
# @note When making an API call, you may pass StopSentimentDetectionJobRequest
|
4811
5778
|
# data as a hash:
|
4812
5779
|
#
|
@@ -5283,7 +6250,7 @@ module Aws::Comprehend
|
|
5283
6250
|
class UpdateEndpointResponse < Aws::EmptyStructure; end
|
5284
6251
|
|
5285
6252
|
# Configuration parameters for an optional private Virtual Private Cloud
|
5286
|
-
# (VPC) containing the resources you are using for the job. For
|
6253
|
+
# (VPC) containing the resources you are using for the job. For more
|
5287
6254
|
# information, see [Amazon VPC][1].
|
5288
6255
|
#
|
5289
6256
|
#
|