|
8 | 8 | "BatchDetectSentiment": "<p>Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each one.</p>", |
9 | 9 | "BatchDetectSyntax": "<p>Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see <a>how-syntax</a>.</p>", |
10 | 10 | "ClassifyDocument": "<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>", |
| 11 | + "ContainsPiiEntities": "<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>", |
11 | 12 | "CreateDocumentClassifier": "<p>Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see <a>how-document-classification</a>.</p>", |
12 | 13 | "CreateEndpoint": "<p>Creates a model-specific endpoint for synchronous inference for a previously trained custom model </p>", |
13 | 14 | "CreateEntityRecognizer": "<p>Creates an entity recognizer using submitted files. After your <code>CreateEntityRecognizer</code> request is submitted, you can check job status using the API. </p>", |
|
284 | 285 | "refs": { |
285 | 286 | } |
286 | 287 | }, |
| 288 | + "ContainsPiiEntitiesRequest": { |
| 289 | + "base": null, |
| 290 | + "refs": { |
| 291 | + } |
| 292 | + }, |
| 293 | + "ContainsPiiEntitiesResponse": { |
| 294 | + "base": null, |
| 295 | + "refs": { |
| 296 | + } |
| 297 | + }, |
287 | 298 | "CreateDocumentClassifierRequest": { |
288 | 299 | "base": null, |
289 | 300 | "refs": { |
|
732 | 743 | "ListOfEntities$member": null |
733 | 744 | } |
734 | 745 | }, |
| 746 | + "EntityLabel": { |
| 747 | + "base": "<p>Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.</p>", |
| 748 | + "refs": { |
| 749 | + "ListOfEntityLabels$member": null |
| 750 | + } |
| 751 | + }, |
735 | 752 | "EntityRecognizerAnnotations": { |
736 | 753 | "base": "<p>Describes the annotations associated with a entity recognizer.</p>", |
737 | 754 | "refs": { |
|
892 | 909 | "DocumentLabel$Score": "<p>The confidence score that Amazon Comprehend has this label correctly attributed.</p>", |
893 | 910 | "DominantLanguage$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>", |
894 | 911 | "Entity$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>", |
| 912 | + "EntityLabel$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>", |
895 | 913 | "KeyPhrase$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>", |
896 | 914 | "PartOfSpeechTag$Score": "<p>The confidence that Amazon Comprehend has that the part of speech was correctly identified.</p>", |
897 | 915 | "PiiEntity$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>", |
|
1180 | 1198 | "BatchDetectEntitiesRequest$LanguageCode": "<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p>", |
1181 | 1199 | "BatchDetectKeyPhrasesRequest$LanguageCode": "<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p>", |
1182 | 1200 | "BatchDetectSentimentRequest$LanguageCode": "<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p>", |
| 1201 | + "ContainsPiiEntitiesRequest$LanguageCode": "<p>The language of the input documents.</p>", |
1183 | 1202 | "CreateDocumentClassifierRequest$LanguageCode": "<p>The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.</p>", |
1184 | 1203 | "CreateEntityRecognizerRequest$LanguageCode": "<p> You can specify any of the following languages supported by Amazon Comprehend: English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\"). All documents must be in the same language.</p>", |
1185 | 1204 | "DetectEntitiesRequest$LanguageCode": "<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p> <p>If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.</p>", |
|
1330 | 1349 | "DetectEntitiesResponse$Entities": "<p>A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. </p> <p>If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see <a>how-entities</a>.</p>" |
1331 | 1350 | } |
1332 | 1351 | }, |
| 1352 | + "ListOfEntityLabels": { |
| 1353 | + "base": null, |
| 1354 | + "refs": { |
| 1355 | + "ContainsPiiEntitiesResponse$Labels": "<p>The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.</p>" |
| 1356 | + } |
| 1357 | + }, |
1333 | 1358 | "ListOfKeyPhrases": { |
1334 | 1359 | "base": null, |
1335 | 1360 | "refs": { |
|
1512 | 1537 | "PiiEntityType": { |
1513 | 1538 | "base": null, |
1514 | 1539 | "refs": { |
| 1540 | + "EntityLabel$Name": "<p>The name of the label.</p>", |
1515 | 1541 | "ListOfPiiEntityTypes$member": null, |
1516 | 1542 | "PiiEntity$Type": "<p>The entity's type.</p>" |
1517 | 1543 | } |
|
1775 | 1801 | "BatchItemError$ErrorMessage": "<p>A text description of the error.</p>", |
1776 | 1802 | "BatchSizeLimitExceededException$Message": null, |
1777 | 1803 | "ConcurrentModificationException$Message": null, |
| 1804 | + "ContainsPiiEntitiesRequest$Text": "<p>Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.</p>", |
1778 | 1805 | "DetectPiiEntitiesRequest$Text": "<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>", |
1779 | 1806 | "DocumentClass$Name": "<p>The name of the class.</p>", |
1780 | 1807 | "DocumentLabel$Name": "<p>The name of the label.</p>", |
|
1990 | 2017 | } |
1991 | 2018 | }, |
1992 | 2019 | "UnsupportedLanguageException": { |
1993 | | - "base": "<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>", |
| 2020 | + "base": "<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>", |
1994 | 2021 | "refs": { |
1995 | 2022 | } |
1996 | 2023 | }, |
|
0 commit comments