cdk-comprehend-s3olap 2.0.102 → 2.0.103

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.
@@ -20,11 +20,11 @@ declare class Comprehend extends Service {
20
20
  */
21
21
  batchDetectDominantLanguage(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectDominantLanguageResponse) => void): Request<Comprehend.Types.BatchDetectDominantLanguageResponse, AWSError>;
22
22
  /**
23
- * Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities
23
+ * Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.
24
24
  */
25
25
  batchDetectEntities(params: Comprehend.Types.BatchDetectEntitiesRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectEntitiesResponse) => void): Request<Comprehend.Types.BatchDetectEntitiesResponse, AWSError>;
26
26
  /**
27
- * Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities
27
+ * Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.
28
28
  */
29
29
  batchDetectEntities(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectEntitiesResponse) => void): Request<Comprehend.Types.BatchDetectEntitiesResponse, AWSError>;
30
30
  /**
@@ -44,13 +44,21 @@ declare class Comprehend extends Service {
44
44
  */
45
45
  batchDetectSentiment(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSentimentResponse) => void): Request<Comprehend.Types.BatchDetectSentimentResponse, AWSError>;
46
46
  /**
47
- * 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 how-syntax.
47
+ * 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 Syntax in the Comprehend Developer Guide.
48
48
  */
49
49
  batchDetectSyntax(params: Comprehend.Types.BatchDetectSyntaxRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSyntaxResponse) => void): Request<Comprehend.Types.BatchDetectSyntaxResponse, AWSError>;
50
50
  /**
51
- * 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 how-syntax.
51
+ * 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 Syntax in the Comprehend Developer Guide.
52
52
  */
53
53
  batchDetectSyntax(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSyntaxResponse) => void): Request<Comprehend.Types.BatchDetectSyntaxResponse, AWSError>;
54
+ /**
55
+ * Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents. For more information about targeted sentiment, see Targeted sentiment.
56
+ */
57
+ batchDetectTargetedSentiment(params: Comprehend.Types.BatchDetectTargetedSentimentRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectTargetedSentimentResponse) => void): Request<Comprehend.Types.BatchDetectTargetedSentimentResponse, AWSError>;
58
+ /**
59
+ * Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents. For more information about targeted sentiment, see Targeted sentiment.
60
+ */
61
+ batchDetectTargetedSentiment(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectTargetedSentimentResponse) => void): Request<Comprehend.Types.BatchDetectTargetedSentimentResponse, AWSError>;
54
62
  /**
55
63
  * 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.
56
64
  */
@@ -68,11 +76,11 @@ declare class Comprehend extends Service {
68
76
  */
69
77
  containsPiiEntities(callback?: (err: AWSError, data: Comprehend.Types.ContainsPiiEntitiesResponse) => void): Request<Comprehend.Types.ContainsPiiEntitiesResponse, AWSError>;
70
78
  /**
71
- * 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 how-document-classification.
79
+ * 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 Document Classification in the Comprehend Developer Guide.
72
80
  */
73
81
  createDocumentClassifier(params: Comprehend.Types.CreateDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateDocumentClassifierResponse) => void): Request<Comprehend.Types.CreateDocumentClassifierResponse, AWSError>;
74
82
  /**
75
- * 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 how-document-classification.
83
+ * 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 Document Classification in the Comprehend Developer Guide.
76
84
  */
77
85
  createDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.CreateDocumentClassifierResponse) => void): Request<Comprehend.Types.CreateDocumentClassifierResponse, AWSError>;
78
86
  /**
@@ -236,11 +244,11 @@ declare class Comprehend extends Service {
236
244
  */
237
245
  detectDominantLanguage(callback?: (err: AWSError, data: Comprehend.Types.DetectDominantLanguageResponse) => void): Request<Comprehend.Types.DetectDominantLanguageResponse, AWSError>;
238
246
  /**
239
- * Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
247
+ * Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide.
240
248
  */
241
249
  detectEntities(params: Comprehend.Types.DetectEntitiesRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectEntitiesResponse) => void): Request<Comprehend.Types.DetectEntitiesResponse, AWSError>;
242
250
  /**
243
- * Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
251
+ * Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide.
244
252
  */
245
253
  detectEntities(callback?: (err: AWSError, data: Comprehend.Types.DetectEntitiesResponse) => void): Request<Comprehend.Types.DetectEntitiesResponse, AWSError>;
246
254
  /**
@@ -268,13 +276,21 @@ declare class Comprehend extends Service {
268
276
  */
269
277
  detectSentiment(callback?: (err: AWSError, data: Comprehend.Types.DetectSentimentResponse) => void): Request<Comprehend.Types.DetectSentimentResponse, AWSError>;
270
278
  /**
271
- * Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
279
+ * Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
272
280
  */
273
281
  detectSyntax(params: Comprehend.Types.DetectSyntaxRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectSyntaxResponse) => void): Request<Comprehend.Types.DetectSyntaxResponse, AWSError>;
274
282
  /**
275
- * Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
283
+ * Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.
276
284
  */
277
285
  detectSyntax(callback?: (err: AWSError, data: Comprehend.Types.DetectSyntaxResponse) => void): Request<Comprehend.Types.DetectSyntaxResponse, AWSError>;
286
+ /**
287
+ * Inspects the input text and returns a sentiment analysis for each entity identified in the text. For more information about targeted sentiment, see Targeted sentiment.
288
+ */
289
+ detectTargetedSentiment(params: Comprehend.Types.DetectTargetedSentimentRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectTargetedSentimentResponse) => void): Request<Comprehend.Types.DetectTargetedSentimentResponse, AWSError>;
290
+ /**
291
+ * Inspects the input text and returns a sentiment analysis for each entity identified in the text. For more information about targeted sentiment, see Targeted sentiment.
292
+ */
293
+ detectTargetedSentiment(callback?: (err: AWSError, data: Comprehend.Types.DetectTargetedSentimentResponse) => void): Request<Comprehend.Types.DetectTargetedSentimentResponse, AWSError>;
278
294
  /**
279
295
  * Creates a new custom model that replicates a source custom model that you import. The source model can be in your AWS account or another one. If the source model is in another AWS account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same AWS region that you're using when you import. You can't import a model that's in a different region.
280
296
  */
@@ -623,7 +639,7 @@ declare namespace Comprehend {
623
639
  }
624
640
  export interface BatchDetectDominantLanguageRequest {
625
641
  /**
626
- * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
642
+ * A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.
627
643
  */
628
644
  TextList: CustomerInputStringList;
629
645
  }
@@ -649,7 +665,7 @@ declare namespace Comprehend {
649
665
  }
650
666
  export interface BatchDetectEntitiesRequest {
651
667
  /**
652
- * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.
668
+ * A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
653
669
  */
654
670
  TextList: CustomerInputStringList;
655
671
  /**
@@ -679,7 +695,7 @@ declare namespace Comprehend {
679
695
  }
680
696
  export interface BatchDetectKeyPhrasesRequest {
681
697
  /**
682
- * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.
698
+ * A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
683
699
  */
684
700
  TextList: CustomerInputStringList;
685
701
  /**
@@ -713,7 +729,7 @@ declare namespace Comprehend {
713
729
  }
714
730
  export interface BatchDetectSentimentRequest {
715
731
  /**
716
- * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
732
+ * A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB. Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.
717
733
  */
718
734
  TextList: CustomerInputStringList;
719
735
  /**
@@ -743,7 +759,7 @@ declare namespace Comprehend {
743
759
  }
744
760
  export interface BatchDetectSyntaxRequest {
745
761
  /**
746
- * A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.
762
+ * A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.
747
763
  */
748
764
  TextList: CustomerInputStringList;
749
765
  /**
@@ -761,6 +777,36 @@ declare namespace Comprehend {
761
777
  */
762
778
  ErrorList: BatchItemErrorList;
763
779
  }
780
+ export interface BatchDetectTargetedSentimentItemResult {
781
+ /**
782
+ * The zero-based index of this result in the input list.
783
+ */
784
+ Index?: Integer;
785
+ /**
786
+ * An array of targeted sentiment entities.
787
+ */
788
+ Entities?: ListOfTargetedSentimentEntities;
789
+ }
790
+ export interface BatchDetectTargetedSentimentRequest {
791
+ /**
792
+ * A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.
793
+ */
794
+ TextList: CustomerInputStringList;
795
+ /**
796
+ * The language of the input documents. Currently, English is the only supported language.
797
+ */
798
+ LanguageCode: LanguageCode;
799
+ }
800
+ export interface BatchDetectTargetedSentimentResponse {
801
+ /**
802
+ * A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.
803
+ */
804
+ ResultList: ListOfDetectTargetedSentimentResult;
805
+ /**
806
+ * List of errors that the operation can return.
807
+ */
808
+ ErrorList: BatchItemErrorList;
809
+ }
764
810
  export interface BatchItemError {
765
811
  /**
766
812
  * The zero-based index of the document in the input list.
@@ -856,7 +902,7 @@ declare namespace Comprehend {
856
902
  export type ComprehendModelArn = string;
857
903
  export interface ContainsPiiEntitiesRequest {
858
904
  /**
859
- * Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.
905
+ * A UTF-8 text string. The maximum string size is 100 KB.
860
906
  */
861
907
  Text: String;
862
908
  /**
@@ -1219,7 +1265,7 @@ declare namespace Comprehend {
1219
1265
  }
1220
1266
  export interface DetectDominantLanguageRequest {
1221
1267
  /**
1222
- * A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
1268
+ * A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.
1223
1269
  */
1224
1270
  Text: CustomerInputString;
1225
1271
  }
@@ -1231,7 +1277,7 @@ declare namespace Comprehend {
1231
1277
  }
1232
1278
  export interface DetectEntitiesRequest {
1233
1279
  /**
1234
- * A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
1280
+ * A UTF-8 text string. The maximum string size is 100 KB.
1235
1281
  */
1236
1282
  Text: CustomerInputString;
1237
1283
  /**
@@ -1245,13 +1291,13 @@ declare namespace Comprehend {
1245
1291
  }
1246
1292
  export interface DetectEntitiesResponse {
1247
1293
  /**
1248
- * 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. 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 how-entities.
1294
+ * 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. 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 Entities in the Comprehend Developer Guide.
1249
1295
  */
1250
1296
  Entities?: ListOfEntities;
1251
1297
  }
1252
1298
  export interface DetectKeyPhrasesRequest {
1253
1299
  /**
1254
- * A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
1300
+ * A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.
1255
1301
  */
1256
1302
  Text: CustomerInputString;
1257
1303
  /**
@@ -1267,7 +1313,7 @@ declare namespace Comprehend {
1267
1313
  }
1268
1314
  export interface DetectPiiEntitiesRequest {
1269
1315
  /**
1270
- * A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
1316
+ * A UTF-8 text string. The maximum string size is 100 KB.
1271
1317
  */
1272
1318
  Text: String;
1273
1319
  /**
@@ -1283,7 +1329,7 @@ declare namespace Comprehend {
1283
1329
  }
1284
1330
  export interface DetectSentimentRequest {
1285
1331
  /**
1286
- * A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
1332
+ * A UTF-8 text string. The maximum string size is 5 KB. Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.
1287
1333
  */
1288
1334
  Text: CustomerInputString;
1289
1335
  /**
@@ -1303,7 +1349,7 @@ declare namespace Comprehend {
1303
1349
  }
1304
1350
  export interface DetectSyntaxRequest {
1305
1351
  /**
1306
- * A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.
1352
+ * A UTF-8 string. The maximum string size is 5 KB.
1307
1353
  */
1308
1354
  Text: CustomerInputString;
1309
1355
  /**
@@ -1313,10 +1359,26 @@ declare namespace Comprehend {
1313
1359
  }
1314
1360
  export interface DetectSyntaxResponse {
1315
1361
  /**
1316
- * A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.
1362
+ * A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax in the Comprehend Developer Guide.
1317
1363
  */
1318
1364
  SyntaxTokens?: ListOfSyntaxTokens;
1319
1365
  }
1366
+ export interface DetectTargetedSentimentRequest {
1367
+ /**
1368
+ * A UTF-8 text string. The maximum string length is 5 KB.
1369
+ */
1370
+ Text: CustomerInputString;
1371
+ /**
1372
+ * The language of the input documents. Currently, English is the only supported language.
1373
+ */
1374
+ LanguageCode: LanguageCode;
1375
+ }
1376
+ export interface DetectTargetedSentimentResponse {
1377
+ /**
1378
+ * Targeted sentiment analysis for each of the entities identified in the input text.
1379
+ */
1380
+ Entities?: ListOfTargetedSentimentEntities;
1381
+ }
1320
1382
  export interface DocumentClass {
1321
1383
  /**
1322
1384
  * The name of the class.
@@ -1432,7 +1494,7 @@ declare namespace Comprehend {
1432
1494
  */
1433
1495
  S3Uri?: S3Uri;
1434
1496
  /**
1435
- * The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
1497
+ * This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
1436
1498
  */
1437
1499
  TestS3Uri?: S3Uri;
1438
1500
  /**
@@ -1817,11 +1879,11 @@ declare namespace Comprehend {
1817
1879
  */
1818
1880
  Text?: String;
1819
1881
  /**
1820
- * A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
1882
+ * The zero-based offset from the beginning of the source text to the first character in the entity.
1821
1883
  */
1822
1884
  BeginOffset?: Integer;
1823
1885
  /**
1824
- * A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
1886
+ * The zero-based offset from the beginning of the source text to the last character in the entity.
1825
1887
  */
1826
1888
  EndOffset?: Integer;
1827
1889
  }
@@ -1841,7 +1903,7 @@ declare namespace Comprehend {
1841
1903
  */
1842
1904
  S3Uri: S3Uri;
1843
1905
  /**
1844
- * This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.
1906
+ * Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.
1845
1907
  */
1846
1908
  TestS3Uri?: S3Uri;
1847
1909
  }
@@ -2207,11 +2269,11 @@ declare namespace Comprehend {
2207
2269
  */
2208
2270
  Text?: String;
2209
2271
  /**
2210
- * A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
2272
+ * The zero-based offset from the beginning of the source text to the first character in the key phrase.
2211
2273
  */
2212
2274
  BeginOffset?: Integer;
2213
2275
  /**
2214
- * A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
2276
+ * The zero-based offset from the beginning of the source text to the last character in the key phrase.
2215
2277
  */
2216
2278
  EndOffset?: Integer;
2217
2279
  }
@@ -2524,20 +2586,24 @@ declare namespace Comprehend {
2524
2586
  NextToken?: String;
2525
2587
  }
2526
2588
  export type ListOfClasses = DocumentClass[];
2589
+ export type ListOfDescriptiveMentionIndices = Integer[];
2527
2590
  export type ListOfDetectDominantLanguageResult = BatchDetectDominantLanguageItemResult[];
2528
2591
  export type ListOfDetectEntitiesResult = BatchDetectEntitiesItemResult[];
2529
2592
  export type ListOfDetectKeyPhrasesResult = BatchDetectKeyPhrasesItemResult[];
2530
2593
  export type ListOfDetectSentimentResult = BatchDetectSentimentItemResult[];
2531
2594
  export type ListOfDetectSyntaxResult = BatchDetectSyntaxItemResult[];
2595
+ export type ListOfDetectTargetedSentimentResult = BatchDetectTargetedSentimentItemResult[];
2532
2596
  export type ListOfDocumentReadFeatureTypes = DocumentReadFeatureTypes[];
2533
2597
  export type ListOfDominantLanguages = DominantLanguage[];
2534
2598
  export type ListOfEntities = Entity[];
2535
2599
  export type ListOfEntityLabels = EntityLabel[];
2536
2600
  export type ListOfKeyPhrases = KeyPhrase[];
2537
2601
  export type ListOfLabels = DocumentLabel[];
2602
+ export type ListOfMentions = TargetedSentimentMention[];
2538
2603
  export type ListOfPiiEntities = PiiEntity[];
2539
2604
  export type ListOfPiiEntityTypes = PiiEntityType[];
2540
2605
  export type ListOfSyntaxTokens = SyntaxToken[];
2606
+ export type ListOfTargetedSentimentEntities = TargetedSentimentEntity[];
2541
2607
  export interface ListPiiEntitiesDetectionJobsRequest {
2542
2608
  /**
2543
2609
  * Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
@@ -2652,6 +2718,13 @@ declare namespace Comprehend {
2652
2718
  }
2653
2719
  export type MaskCharacter = string;
2654
2720
  export type MaxResultsInteger = number;
2721
+ export interface MentionSentiment {
2722
+ /**
2723
+ * The sentiment of the mention.
2724
+ */
2725
+ Sentiment?: SentimentType;
2726
+ SentimentScore?: SentimentScore;
2727
+ }
2655
2728
  export type ModelStatus = "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED"|string;
2656
2729
  export type NumberOfTopicsInteger = number;
2657
2730
  export interface OutputDataConfig {
@@ -2760,11 +2833,11 @@ declare namespace Comprehend {
2760
2833
  */
2761
2834
  Type?: PiiEntityType;
2762
2835
  /**
2763
- * A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
2836
+ * The zero-based offset from the beginning of the source text to the first character in the entity.
2764
2837
  */
2765
2838
  BeginOffset?: Integer;
2766
2839
  /**
2767
- * A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
2840
+ * The zero-based offset from the beginning of the source text to the last character in the entity.
2768
2841
  */
2769
2842
  EndOffset?: Integer;
2770
2843
  }
@@ -3286,7 +3359,7 @@ declare namespace Comprehend {
3286
3359
  */
3287
3360
  JobName?: JobName;
3288
3361
  /**
3289
- * The language of the input documents. Currently, English is the only valid language.
3362
+ * The language of the input documents. Currently, English is the only supported language.
3290
3363
  */
3291
3364
  LanguageCode: LanguageCode;
3292
3365
  /**
@@ -3519,7 +3592,7 @@ declare namespace Comprehend {
3519
3592
  */
3520
3593
  EndOffset?: Integer;
3521
3594
  /**
3522
- * Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.
3595
+ * Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.
3523
3596
  */
3524
3597
  PartOfSpeech?: PartOfSpeechTag;
3525
3598
  }
@@ -3614,6 +3687,47 @@ declare namespace Comprehend {
3614
3687
  VpcConfig?: VpcConfig;
3615
3688
  }
3616
3689
  export type TargetedSentimentDetectionJobPropertiesList = TargetedSentimentDetectionJobProperties[];
3690
+ export interface TargetedSentimentEntity {
3691
+ /**
3692
+ * One or more index into the Mentions array that provides the best name for the entity group.
3693
+ */
3694
+ DescriptiveMentionIndex?: ListOfDescriptiveMentionIndices;
3695
+ /**
3696
+ * An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.
3697
+ */
3698
+ Mentions?: ListOfMentions;
3699
+ }
3700
+ export type TargetedSentimentEntityType = "PERSON"|"LOCATION"|"ORGANIZATION"|"FACILITY"|"BRAND"|"COMMERCIAL_ITEM"|"MOVIE"|"MUSIC"|"BOOK"|"SOFTWARE"|"GAME"|"PERSONAL_TITLE"|"EVENT"|"DATE"|"QUANTITY"|"ATTRIBUTE"|"OTHER"|string;
3701
+ export interface TargetedSentimentMention {
3702
+ /**
3703
+ * Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.
3704
+ */
3705
+ Score?: Float;
3706
+ /**
3707
+ * The confidence that all the entities mentioned in the group relate to the same entity.
3708
+ */
3709
+ GroupScore?: Float;
3710
+ /**
3711
+ * The text in the document that identifies the entity.
3712
+ */
3713
+ Text?: String;
3714
+ /**
3715
+ * The type of the entity. Amazon Comprehend supports a variety of entity types.
3716
+ */
3717
+ Type?: TargetedSentimentEntityType;
3718
+ /**
3719
+ * Contains the sentiment and sentiment score for the mention.
3720
+ */
3721
+ MentionSentiment?: MentionSentiment;
3722
+ /**
3723
+ * The offset into the document text where the mention begins.
3724
+ */
3725
+ BeginOffset?: Integer;
3726
+ /**
3727
+ * The offset into the document text where the mention ends.
3728
+ */
3729
+ EndOffset?: Integer;
3730
+ }
3617
3731
  export type Timestamp = Date;
3618
3732
  export interface TopicsDetectionJobFilter {
3619
3733
  /**