Skip to content

Commit 30e60aa

Browse files
author
AWS
committed
Amazon Comprehend Update: ContainsPiiEntities API analyzes the input text for the presence of personally identifiable information(PII) and returns the labels of identified PII entity types such as name, address etc.
1 parent d19841e commit 30e60aa

File tree

2 files changed

+68
-2
lines changed

2 files changed

+68
-2
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Comprehend",
4+
"contributor": "",
5+
"description": "ContainsPiiEntities API analyzes the input text for the presence of personally identifiable information(PII) and returns the labels of identified PII entity types such as name, address etc."
6+
}

services/comprehend/src/main/resources/codegen-resources/service-2.json

+62-2
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,22 @@
113113
],
114114
"documentation":"<p>Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.</p>"
115115
},
116+
"ContainsPiiEntities":{
117+
"name":"ContainsPiiEntities",
118+
"http":{
119+
"method":"POST",
120+
"requestUri":"/"
121+
},
122+
"input":{"shape":"ContainsPiiEntitiesRequest"},
123+
"output":{"shape":"ContainsPiiEntitiesResponse"},
124+
"errors":[
125+
{"shape":"InvalidRequestException"},
126+
{"shape":"TextSizeLimitExceededException"},
127+
{"shape":"UnsupportedLanguageException"},
128+
{"shape":"InternalServerException"}
129+
],
130+
"documentation":"<p>Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.</p>"
131+
},
116132
"CreateDocumentClassifier":{
117133
"name":"CreateDocumentClassifier",
118134
"http":{
@@ -1429,6 +1445,32 @@
14291445
"documentation":"<p>Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported. </p>",
14301446
"exception":true
14311447
},
1448+
"ContainsPiiEntitiesRequest":{
1449+
"type":"structure",
1450+
"required":[
1451+
"Text",
1452+
"LanguageCode"
1453+
],
1454+
"members":{
1455+
"Text":{
1456+
"shape":"String",
1457+
"documentation":"<p>Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.</p>"
1458+
},
1459+
"LanguageCode":{
1460+
"shape":"LanguageCode",
1461+
"documentation":"<p>The language of the input documents.</p>"
1462+
}
1463+
}
1464+
},
1465+
"ContainsPiiEntitiesResponse":{
1466+
"type":"structure",
1467+
"members":{
1468+
"Labels":{
1469+
"shape":"ListOfEntityLabels",
1470+
"documentation":"<p>The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.</p>"
1471+
}
1472+
}
1473+
},
14321474
"CreateDocumentClassifierRequest":{
14331475
"type":"structure",
14341476
"required":[
@@ -2538,6 +2580,20 @@
25382580
},
25392581
"documentation":"<p>Provides information about an entity. </p> <p> </p>"
25402582
},
2583+
"EntityLabel":{
2584+
"type":"structure",
2585+
"members":{
2586+
"Name":{
2587+
"shape":"PiiEntityType",
2588+
"documentation":"<p>The name of the label.</p>"
2589+
},
2590+
"Score":{
2591+
"shape":"Float",
2592+
"documentation":"<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>"
2593+
}
2594+
},
2595+
"documentation":"<p>Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.</p>"
2596+
},
25412597
"EntityRecognizerAnnotations":{
25422598
"type":"structure",
25432599
"required":["S3Uri"],
@@ -2783,7 +2839,7 @@
27832839
"EntityTypeName":{
27842840
"type":"string",
27852841
"max":64,
2786-
"pattern":"^(?:(?!\\\\n+|\\\\t+|\\\\r+|[\\r\\t\\n\\s,]).)+$"
2842+
"pattern":"^(?:(?!\\\\n+|\\\\t+|\\\\r+|[\\r\\t\\n,]).)+$"
27872843
},
27882844
"EntityTypesEvaluationMetrics":{
27892845
"type":"structure",
@@ -3399,6 +3455,10 @@
33993455
"type":"list",
34003456
"member":{"shape":"Entity"}
34013457
},
3458+
"ListOfEntityLabels":{
3459+
"type":"list",
3460+
"member":{"shape":"EntityLabel"}
3461+
},
34023462
"ListOfKeyPhrases":{
34033463
"type":"list",
34043464
"member":{"shape":"KeyPhrase"}
@@ -4800,7 +4860,7 @@
48004860
"members":{
48014861
"Message":{"shape":"String"}
48024862
},
4803-
"documentation":"<p>Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as <code>CreateEntityRecognizer</code>), only English, Spanish, French, Italian, German, or Portuguese are accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see <a>supported-languages</a>. </p>",
4863+
"documentation":"<p>Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see <a>supported-languages</a>. </p>",
48044864
"exception":true
48054865
},
48064866
"UntagResourceRequest":{

0 commit comments

Comments
 (0)