1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class Comprehend extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: Comprehend.Types.ClientConfiguration)
|
13 | config: Config & Comprehend.Types.ClientConfiguration;
|
14 | /**
|
15 | * Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
|
16 | */
|
17 | batchDetectDominantLanguage(params: Comprehend.Types.BatchDetectDominantLanguageRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectDominantLanguageResponse) => void): Request<Comprehend.Types.BatchDetectDominantLanguageResponse, AWSError>;
|
18 | /**
|
19 | * Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
|
20 | */
|
21 | batchDetectDominantLanguage(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectDominantLanguageResponse) => void): Request<Comprehend.Types.BatchDetectDominantLanguageResponse, AWSError>;
|
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
|
24 | */
|
25 | batchDetectEntities(params: Comprehend.Types.BatchDetectEntitiesRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectEntitiesResponse) => void): Request<Comprehend.Types.BatchDetectEntitiesResponse, AWSError>;
|
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
|
28 | */
|
29 | batchDetectEntities(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectEntitiesResponse) => void): Request<Comprehend.Types.BatchDetectEntitiesResponse, AWSError>;
|
30 | /**
|
31 | * Detects the key noun phrases found in a batch of documents.
|
32 | */
|
33 | batchDetectKeyPhrases(params: Comprehend.Types.BatchDetectKeyPhrasesRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectKeyPhrasesResponse) => void): Request<Comprehend.Types.BatchDetectKeyPhrasesResponse, AWSError>;
|
34 | /**
|
35 | * Detects the key noun phrases found in a batch of documents.
|
36 | */
|
37 | batchDetectKeyPhrases(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectKeyPhrasesResponse) => void): Request<Comprehend.Types.BatchDetectKeyPhrasesResponse, AWSError>;
|
38 | /**
|
39 | * Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
|
40 | */
|
41 | batchDetectSentiment(params: Comprehend.Types.BatchDetectSentimentRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSentimentResponse) => void): Request<Comprehend.Types.BatchDetectSentimentResponse, AWSError>;
|
42 | /**
|
43 | * Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.
|
44 | */
|
45 | batchDetectSentiment(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSentimentResponse) => void): Request<Comprehend.Types.BatchDetectSentimentResponse, AWSError>;
|
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.
|
48 | */
|
49 | batchDetectSyntax(params: Comprehend.Types.BatchDetectSyntaxRequest, callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSyntaxResponse) => void): Request<Comprehend.Types.BatchDetectSyntaxResponse, AWSError>;
|
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.
|
52 | */
|
53 | batchDetectSyntax(callback?: (err: AWSError, data: Comprehend.Types.BatchDetectSyntaxResponse) => void): Request<Comprehend.Types.BatchDetectSyntaxResponse, AWSError>;
|
54 | /**
|
55 | * 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.
|
56 | */
|
57 | createDocumentClassifier(params: Comprehend.Types.CreateDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateDocumentClassifierResponse) => void): Request<Comprehend.Types.CreateDocumentClassifierResponse, AWSError>;
|
58 | /**
|
59 | * 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.
|
60 | */
|
61 | createDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.CreateDocumentClassifierResponse) => void): Request<Comprehend.Types.CreateDocumentClassifierResponse, AWSError>;
|
62 | /**
|
63 | * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
|
64 | */
|
65 | createEntityRecognizer(params: Comprehend.Types.CreateEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.CreateEntityRecognizerResponse) => void): Request<Comprehend.Types.CreateEntityRecognizerResponse, AWSError>;
|
66 | /**
|
67 | * Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.
|
68 | */
|
69 | createEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.CreateEntityRecognizerResponse) => void): Request<Comprehend.Types.CreateEntityRecognizerResponse, AWSError>;
|
70 | /**
|
71 | * Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
|
72 | */
|
73 | deleteDocumentClassifier(params: Comprehend.Types.DeleteDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.DeleteDocumentClassifierResponse) => void): Request<Comprehend.Types.DeleteDocumentClassifierResponse, AWSError>;
|
74 | /**
|
75 | * Deletes a previously created document classifier Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.
|
76 | */
|
77 | deleteDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.DeleteDocumentClassifierResponse) => void): Request<Comprehend.Types.DeleteDocumentClassifierResponse, AWSError>;
|
78 | /**
|
79 | * Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
|
80 | */
|
81 | deleteEntityRecognizer(params: Comprehend.Types.DeleteEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.DeleteEntityRecognizerResponse) => void): Request<Comprehend.Types.DeleteEntityRecognizerResponse, AWSError>;
|
82 | /**
|
83 | * Deletes an entity recognizer. Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned. This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.
|
84 | */
|
85 | deleteEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.DeleteEntityRecognizerResponse) => void): Request<Comprehend.Types.DeleteEntityRecognizerResponse, AWSError>;
|
86 | /**
|
87 | * Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
|
88 | */
|
89 | describeDocumentClassificationJob(params: Comprehend.Types.DescribeDocumentClassificationJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassificationJobResponse) => void): Request<Comprehend.Types.DescribeDocumentClassificationJobResponse, AWSError>;
|
90 | /**
|
91 | * Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
|
92 | */
|
93 | describeDocumentClassificationJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassificationJobResponse) => void): Request<Comprehend.Types.DescribeDocumentClassificationJobResponse, AWSError>;
|
94 | /**
|
95 | * Gets the properties associated with a document classifier.
|
96 | */
|
97 | describeDocumentClassifier(params: Comprehend.Types.DescribeDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassifierResponse) => void): Request<Comprehend.Types.DescribeDocumentClassifierResponse, AWSError>;
|
98 | /**
|
99 | * Gets the properties associated with a document classifier.
|
100 | */
|
101 | describeDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.DescribeDocumentClassifierResponse) => void): Request<Comprehend.Types.DescribeDocumentClassifierResponse, AWSError>;
|
102 | /**
|
103 | * Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
|
104 | */
|
105 | describeDominantLanguageDetectionJob(params: Comprehend.Types.DescribeDominantLanguageDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeDominantLanguageDetectionJobResponse) => void): Request<Comprehend.Types.DescribeDominantLanguageDetectionJobResponse, AWSError>;
|
106 | /**
|
107 | * Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.
|
108 | */
|
109 | describeDominantLanguageDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeDominantLanguageDetectionJobResponse) => void): Request<Comprehend.Types.DescribeDominantLanguageDetectionJobResponse, AWSError>;
|
110 | /**
|
111 | * Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
|
112 | */
|
113 | describeEntitiesDetectionJob(params: Comprehend.Types.DescribeEntitiesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeEntitiesDetectionJobResponse) => void): Request<Comprehend.Types.DescribeEntitiesDetectionJobResponse, AWSError>;
|
114 | /**
|
115 | * Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.
|
116 | */
|
117 | describeEntitiesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeEntitiesDetectionJobResponse) => void): Request<Comprehend.Types.DescribeEntitiesDetectionJobResponse, AWSError>;
|
118 | /**
|
119 | * Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
|
120 | */
|
121 | describeEntityRecognizer(params: Comprehend.Types.DescribeEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeEntityRecognizerResponse) => void): Request<Comprehend.Types.DescribeEntityRecognizerResponse, AWSError>;
|
122 | /**
|
123 | * Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.
|
124 | */
|
125 | describeEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.DescribeEntityRecognizerResponse) => void): Request<Comprehend.Types.DescribeEntityRecognizerResponse, AWSError>;
|
126 | /**
|
127 | * Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
|
128 | */
|
129 | describeKeyPhrasesDetectionJob(params: Comprehend.Types.DescribeKeyPhrasesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeKeyPhrasesDetectionJobResponse) => void): Request<Comprehend.Types.DescribeKeyPhrasesDetectionJobResponse, AWSError>;
|
130 | /**
|
131 | * Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.
|
132 | */
|
133 | describeKeyPhrasesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeKeyPhrasesDetectionJobResponse) => void): Request<Comprehend.Types.DescribeKeyPhrasesDetectionJobResponse, AWSError>;
|
134 | /**
|
135 | * Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
|
136 | */
|
137 | describeSentimentDetectionJob(params: Comprehend.Types.DescribeSentimentDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeSentimentDetectionJobResponse) => void): Request<Comprehend.Types.DescribeSentimentDetectionJobResponse, AWSError>;
|
138 | /**
|
139 | * Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.
|
140 | */
|
141 | describeSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeSentimentDetectionJobResponse) => void): Request<Comprehend.Types.DescribeSentimentDetectionJobResponse, AWSError>;
|
142 | /**
|
143 | * Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
|
144 | */
|
145 | describeTopicsDetectionJob(params: Comprehend.Types.DescribeTopicsDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.DescribeTopicsDetectionJobResponse) => void): Request<Comprehend.Types.DescribeTopicsDetectionJobResponse, AWSError>;
|
146 | /**
|
147 | * Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.
|
148 | */
|
149 | describeTopicsDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.DescribeTopicsDetectionJobResponse) => void): Request<Comprehend.Types.DescribeTopicsDetectionJobResponse, AWSError>;
|
150 | /**
|
151 | * Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
|
152 | */
|
153 | detectDominantLanguage(params: Comprehend.Types.DetectDominantLanguageRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectDominantLanguageResponse) => void): Request<Comprehend.Types.DetectDominantLanguageResponse, AWSError>;
|
154 | /**
|
155 | * Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.
|
156 | */
|
157 | detectDominantLanguage(callback?: (err: AWSError, data: Comprehend.Types.DetectDominantLanguageResponse) => void): Request<Comprehend.Types.DetectDominantLanguageResponse, AWSError>;
|
158 | /**
|
159 | * Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
|
160 | */
|
161 | detectEntities(params: Comprehend.Types.DetectEntitiesRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectEntitiesResponse) => void): Request<Comprehend.Types.DetectEntitiesResponse, AWSError>;
|
162 | /**
|
163 | * Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.
|
164 | */
|
165 | detectEntities(callback?: (err: AWSError, data: Comprehend.Types.DetectEntitiesResponse) => void): Request<Comprehend.Types.DetectEntitiesResponse, AWSError>;
|
166 | /**
|
167 | * Detects the key noun phrases found in the text.
|
168 | */
|
169 | detectKeyPhrases(params: Comprehend.Types.DetectKeyPhrasesRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectKeyPhrasesResponse) => void): Request<Comprehend.Types.DetectKeyPhrasesResponse, AWSError>;
|
170 | /**
|
171 | * Detects the key noun phrases found in the text.
|
172 | */
|
173 | detectKeyPhrases(callback?: (err: AWSError, data: Comprehend.Types.DetectKeyPhrasesResponse) => void): Request<Comprehend.Types.DetectKeyPhrasesResponse, AWSError>;
|
174 | /**
|
175 | * Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
|
176 | */
|
177 | detectSentiment(params: Comprehend.Types.DetectSentimentRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectSentimentResponse) => void): Request<Comprehend.Types.DetectSentimentResponse, AWSError>;
|
178 | /**
|
179 | * Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
|
180 | */
|
181 | detectSentiment(callback?: (err: AWSError, data: Comprehend.Types.DetectSentimentResponse) => void): Request<Comprehend.Types.DetectSentimentResponse, AWSError>;
|
182 | /**
|
183 | * Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
|
184 | */
|
185 | detectSyntax(params: Comprehend.Types.DetectSyntaxRequest, callback?: (err: AWSError, data: Comprehend.Types.DetectSyntaxResponse) => void): Request<Comprehend.Types.DetectSyntaxResponse, AWSError>;
|
186 | /**
|
187 | * Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.
|
188 | */
|
189 | detectSyntax(callback?: (err: AWSError, data: Comprehend.Types.DetectSyntaxResponse) => void): Request<Comprehend.Types.DetectSyntaxResponse, AWSError>;
|
190 | /**
|
191 | * Gets a list of the documentation classification jobs that you have submitted.
|
192 | */
|
193 | listDocumentClassificationJobs(params: Comprehend.Types.ListDocumentClassificationJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassificationJobsResponse) => void): Request<Comprehend.Types.ListDocumentClassificationJobsResponse, AWSError>;
|
194 | /**
|
195 | * Gets a list of the documentation classification jobs that you have submitted.
|
196 | */
|
197 | listDocumentClassificationJobs(callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassificationJobsResponse) => void): Request<Comprehend.Types.ListDocumentClassificationJobsResponse, AWSError>;
|
198 | /**
|
199 | * Gets a list of the document classifiers that you have created.
|
200 | */
|
201 | listDocumentClassifiers(params: Comprehend.Types.ListDocumentClassifiersRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassifiersResponse) => void): Request<Comprehend.Types.ListDocumentClassifiersResponse, AWSError>;
|
202 | /**
|
203 | * Gets a list of the document classifiers that you have created.
|
204 | */
|
205 | listDocumentClassifiers(callback?: (err: AWSError, data: Comprehend.Types.ListDocumentClassifiersResponse) => void): Request<Comprehend.Types.ListDocumentClassifiersResponse, AWSError>;
|
206 | /**
|
207 | * Gets a list of the dominant language detection jobs that you have submitted.
|
208 | */
|
209 | listDominantLanguageDetectionJobs(params: Comprehend.Types.ListDominantLanguageDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListDominantLanguageDetectionJobsResponse) => void): Request<Comprehend.Types.ListDominantLanguageDetectionJobsResponse, AWSError>;
|
210 | /**
|
211 | * Gets a list of the dominant language detection jobs that you have submitted.
|
212 | */
|
213 | listDominantLanguageDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListDominantLanguageDetectionJobsResponse) => void): Request<Comprehend.Types.ListDominantLanguageDetectionJobsResponse, AWSError>;
|
214 | /**
|
215 | * Gets a list of the entity detection jobs that you have submitted.
|
216 | */
|
217 | listEntitiesDetectionJobs(params: Comprehend.Types.ListEntitiesDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListEntitiesDetectionJobsResponse) => void): Request<Comprehend.Types.ListEntitiesDetectionJobsResponse, AWSError>;
|
218 | /**
|
219 | * Gets a list of the entity detection jobs that you have submitted.
|
220 | */
|
221 | listEntitiesDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListEntitiesDetectionJobsResponse) => void): Request<Comprehend.Types.ListEntitiesDetectionJobsResponse, AWSError>;
|
222 | /**
|
223 | * Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed.
|
224 | */
|
225 | listEntityRecognizers(params: Comprehend.Types.ListEntityRecognizersRequest, callback?: (err: AWSError, data: Comprehend.Types.ListEntityRecognizersResponse) => void): Request<Comprehend.Types.ListEntityRecognizersResponse, AWSError>;
|
226 | /**
|
227 | * Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list. The results of this list are not in any particular order. Please get the list and sort locally if needed.
|
228 | */
|
229 | listEntityRecognizers(callback?: (err: AWSError, data: Comprehend.Types.ListEntityRecognizersResponse) => void): Request<Comprehend.Types.ListEntityRecognizersResponse, AWSError>;
|
230 | /**
|
231 | * Get a list of key phrase detection jobs that you have submitted.
|
232 | */
|
233 | listKeyPhrasesDetectionJobs(params: Comprehend.Types.ListKeyPhrasesDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListKeyPhrasesDetectionJobsResponse) => void): Request<Comprehend.Types.ListKeyPhrasesDetectionJobsResponse, AWSError>;
|
234 | /**
|
235 | * Get a list of key phrase detection jobs that you have submitted.
|
236 | */
|
237 | listKeyPhrasesDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListKeyPhrasesDetectionJobsResponse) => void): Request<Comprehend.Types.ListKeyPhrasesDetectionJobsResponse, AWSError>;
|
238 | /**
|
239 | * Gets a list of sentiment detection jobs that you have submitted.
|
240 | */
|
241 | listSentimentDetectionJobs(params: Comprehend.Types.ListSentimentDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListSentimentDetectionJobsResponse) => void): Request<Comprehend.Types.ListSentimentDetectionJobsResponse, AWSError>;
|
242 | /**
|
243 | * Gets a list of sentiment detection jobs that you have submitted.
|
244 | */
|
245 | listSentimentDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListSentimentDetectionJobsResponse) => void): Request<Comprehend.Types.ListSentimentDetectionJobsResponse, AWSError>;
|
246 | /**
|
247 | * Gets a list of the topic detection jobs that you have submitted.
|
248 | */
|
249 | listTopicsDetectionJobs(params: Comprehend.Types.ListTopicsDetectionJobsRequest, callback?: (err: AWSError, data: Comprehend.Types.ListTopicsDetectionJobsResponse) => void): Request<Comprehend.Types.ListTopicsDetectionJobsResponse, AWSError>;
|
250 | /**
|
251 | * Gets a list of the topic detection jobs that you have submitted.
|
252 | */
|
253 | listTopicsDetectionJobs(callback?: (err: AWSError, data: Comprehend.Types.ListTopicsDetectionJobsResponse) => void): Request<Comprehend.Types.ListTopicsDetectionJobsResponse, AWSError>;
|
254 | /**
|
255 | * Starts an asynchronous document classification job. Use the operation to track the progress of the job.
|
256 | */
|
257 | startDocumentClassificationJob(params: Comprehend.Types.StartDocumentClassificationJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartDocumentClassificationJobResponse) => void): Request<Comprehend.Types.StartDocumentClassificationJobResponse, AWSError>;
|
258 | /**
|
259 | * Starts an asynchronous document classification job. Use the operation to track the progress of the job.
|
260 | */
|
261 | startDocumentClassificationJob(callback?: (err: AWSError, data: Comprehend.Types.StartDocumentClassificationJobResponse) => void): Request<Comprehend.Types.StartDocumentClassificationJobResponse, AWSError>;
|
262 | /**
|
263 | * Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
|
264 | */
|
265 | startDominantLanguageDetectionJob(params: Comprehend.Types.StartDominantLanguageDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartDominantLanguageDetectionJobResponse) => void): Request<Comprehend.Types.StartDominantLanguageDetectionJobResponse, AWSError>;
|
266 | /**
|
267 | * Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.
|
268 | */
|
269 | startDominantLanguageDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartDominantLanguageDetectionJobResponse) => void): Request<Comprehend.Types.StartDominantLanguageDetectionJobResponse, AWSError>;
|
270 | /**
|
271 | * Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.
|
272 | */
|
273 | startEntitiesDetectionJob(params: Comprehend.Types.StartEntitiesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartEntitiesDetectionJobResponse) => void): Request<Comprehend.Types.StartEntitiesDetectionJobResponse, AWSError>;
|
274 | /**
|
275 | * Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job. This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.
|
276 | */
|
277 | startEntitiesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartEntitiesDetectionJobResponse) => void): Request<Comprehend.Types.StartEntitiesDetectionJobResponse, AWSError>;
|
278 | /**
|
279 | * Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
|
280 | */
|
281 | startKeyPhrasesDetectionJob(params: Comprehend.Types.StartKeyPhrasesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartKeyPhrasesDetectionJobResponse) => void): Request<Comprehend.Types.StartKeyPhrasesDetectionJobResponse, AWSError>;
|
282 | /**
|
283 | * Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.
|
284 | */
|
285 | startKeyPhrasesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartKeyPhrasesDetectionJobResponse) => void): Request<Comprehend.Types.StartKeyPhrasesDetectionJobResponse, AWSError>;
|
286 | /**
|
287 | * Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
|
288 | */
|
289 | startSentimentDetectionJob(params: Comprehend.Types.StartSentimentDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartSentimentDetectionJobResponse) => void): Request<Comprehend.Types.StartSentimentDetectionJobResponse, AWSError>;
|
290 | /**
|
291 | * Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.
|
292 | */
|
293 | startSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartSentimentDetectionJobResponse) => void): Request<Comprehend.Types.StartSentimentDetectionJobResponse, AWSError>;
|
294 | /**
|
295 | * Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
|
296 | */
|
297 | startTopicsDetectionJob(params: Comprehend.Types.StartTopicsDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StartTopicsDetectionJobResponse) => void): Request<Comprehend.Types.StartTopicsDetectionJobResponse, AWSError>;
|
298 | /**
|
299 | * Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.
|
300 | */
|
301 | startTopicsDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StartTopicsDetectionJobResponse) => void): Request<Comprehend.Types.StartTopicsDetectionJobResponse, AWSError>;
|
302 | /**
|
303 | * Stops a dominant language detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
304 | */
|
305 | stopDominantLanguageDetectionJob(params: Comprehend.Types.StopDominantLanguageDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopDominantLanguageDetectionJobResponse) => void): Request<Comprehend.Types.StopDominantLanguageDetectionJobResponse, AWSError>;
|
306 | /**
|
307 | * Stops a dominant language detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
308 | */
|
309 | stopDominantLanguageDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopDominantLanguageDetectionJobResponse) => void): Request<Comprehend.Types.StopDominantLanguageDetectionJobResponse, AWSError>;
|
310 | /**
|
311 | * Stops an entities detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
312 | */
|
313 | stopEntitiesDetectionJob(params: Comprehend.Types.StopEntitiesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopEntitiesDetectionJobResponse) => void): Request<Comprehend.Types.StopEntitiesDetectionJobResponse, AWSError>;
|
314 | /**
|
315 | * Stops an entities detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
316 | */
|
317 | stopEntitiesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopEntitiesDetectionJobResponse) => void): Request<Comprehend.Types.StopEntitiesDetectionJobResponse, AWSError>;
|
318 | /**
|
319 | * Stops a key phrases detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
320 | */
|
321 | stopKeyPhrasesDetectionJob(params: Comprehend.Types.StopKeyPhrasesDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopKeyPhrasesDetectionJobResponse) => void): Request<Comprehend.Types.StopKeyPhrasesDetectionJobResponse, AWSError>;
|
322 | /**
|
323 | * Stops a key phrases detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
324 | */
|
325 | stopKeyPhrasesDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopKeyPhrasesDetectionJobResponse) => void): Request<Comprehend.Types.StopKeyPhrasesDetectionJobResponse, AWSError>;
|
326 | /**
|
327 | * Stops a sentiment detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
328 | */
|
329 | stopSentimentDetectionJob(params: Comprehend.Types.StopSentimentDetectionJobRequest, callback?: (err: AWSError, data: Comprehend.Types.StopSentimentDetectionJobResponse) => void): Request<Comprehend.Types.StopSentimentDetectionJobResponse, AWSError>;
|
330 | /**
|
331 | * Stops a sentiment detection job in progress. If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state. If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception. When a job is stopped, any documents already processed are written to the output location.
|
332 | */
|
333 | stopSentimentDetectionJob(callback?: (err: AWSError, data: Comprehend.Types.StopSentimentDetectionJobResponse) => void): Request<Comprehend.Types.StopSentimentDetectionJobResponse, AWSError>;
|
334 | /**
|
335 | * Stops a document classifier training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
|
336 | */
|
337 | stopTrainingDocumentClassifier(params: Comprehend.Types.StopTrainingDocumentClassifierRequest, callback?: (err: AWSError, data: Comprehend.Types.StopTrainingDocumentClassifierResponse) => void): Request<Comprehend.Types.StopTrainingDocumentClassifierResponse, AWSError>;
|
338 | /**
|
339 | * Stops a document classifier training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
|
340 | */
|
341 | stopTrainingDocumentClassifier(callback?: (err: AWSError, data: Comprehend.Types.StopTrainingDocumentClassifierResponse) => void): Request<Comprehend.Types.StopTrainingDocumentClassifierResponse, AWSError>;
|
342 | /**
|
343 | * Stops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
|
344 | */
|
345 | stopTrainingEntityRecognizer(params: Comprehend.Types.StopTrainingEntityRecognizerRequest, callback?: (err: AWSError, data: Comprehend.Types.StopTrainingEntityRecognizerResponse) => void): Request<Comprehend.Types.StopTrainingEntityRecognizerResponse, AWSError>;
|
346 | /**
|
347 | * Stops an entity recognizer training job while in progress. If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.
|
348 | */
|
349 | stopTrainingEntityRecognizer(callback?: (err: AWSError, data: Comprehend.Types.StopTrainingEntityRecognizerResponse) => void): Request<Comprehend.Types.StopTrainingEntityRecognizerResponse, AWSError>;
|
350 | }
|
351 | declare namespace Comprehend {
|
352 | export type AnyLengthString = string;
|
353 | export interface BatchDetectDominantLanguageItemResult {
|
354 | |
355 |
|
356 |
|
357 | Index?: Integer;
|
358 | |
359 |
|
360 |
|
361 | Languages?: ListOfDominantLanguages;
|
362 | }
|
363 | export interface BatchDetectDominantLanguageRequest {
|
364 | |
365 |
|
366 |
|
367 | TextList: StringList;
|
368 | }
|
369 | export interface BatchDetectDominantLanguageResponse {
|
370 | |
371 |
|
372 |
|
373 | ResultList: ListOfDetectDominantLanguageResult;
|
374 | |
375 |
|
376 |
|
377 | ErrorList: BatchItemErrorList;
|
378 | }
|
379 | export interface BatchDetectEntitiesItemResult {
|
380 | |
381 |
|
382 |
|
383 | Index?: Integer;
|
384 | |
385 |
|
386 |
|
387 | Entities?: ListOfEntities;
|
388 | }
|
389 | export interface BatchDetectEntitiesRequest {
|
390 | |
391 |
|
392 |
|
393 | TextList: StringList;
|
394 | |
395 |
|
396 |
|
397 | LanguageCode: LanguageCode;
|
398 | }
|
399 | export interface BatchDetectEntitiesResponse {
|
400 | |
401 |
|
402 |
|
403 | ResultList: ListOfDetectEntitiesResult;
|
404 | |
405 |
|
406 |
|
407 | ErrorList: BatchItemErrorList;
|
408 | }
|
409 | export interface BatchDetectKeyPhrasesItemResult {
|
410 | |
411 |
|
412 |
|
413 | Index?: Integer;
|
414 | |
415 |
|
416 |
|
417 | KeyPhrases?: ListOfKeyPhrases;
|
418 | }
|
419 | export interface BatchDetectKeyPhrasesRequest {
|
420 | |
421 |
|
422 |
|
423 | TextList: StringList;
|
424 | |
425 |
|
426 |
|
427 | LanguageCode: LanguageCode;
|
428 | }
|
429 | export interface BatchDetectKeyPhrasesResponse {
|
430 | |
431 |
|
432 |
|
433 | ResultList: ListOfDetectKeyPhrasesResult;
|
434 | |
435 |
|
436 |
|
437 | ErrorList: BatchItemErrorList;
|
438 | }
|
439 | export interface BatchDetectSentimentItemResult {
|
440 | |
441 |
|
442 |
|
443 | Index?: Integer;
|
444 | |
445 |
|
446 |
|
447 | Sentiment?: SentimentType;
|
448 | |
449 |
|
450 |
|
451 | SentimentScore?: SentimentScore;
|
452 | }
|
453 | export interface BatchDetectSentimentRequest {
|
454 | |
455 |
|
456 |
|
457 | TextList: StringList;
|
458 | |
459 |
|
460 |
|
461 | LanguageCode: LanguageCode;
|
462 | }
|
463 | export interface BatchDetectSentimentResponse {
|
464 | |
465 |
|
466 |
|
467 | ResultList: ListOfDetectSentimentResult;
|
468 | |
469 |
|
470 |
|
471 | ErrorList: BatchItemErrorList;
|
472 | }
|
473 | export interface BatchDetectSyntaxItemResult {
|
474 | |
475 |
|
476 |
|
477 | Index?: Integer;
|
478 | |
479 |
|
480 |
|
481 | SyntaxTokens?: ListOfSyntaxTokens;
|
482 | }
|
483 | export interface BatchDetectSyntaxRequest {
|
484 | |
485 |
|
486 |
|
487 | TextList: StringList;
|
488 | |
489 |
|
490 |
|
491 | LanguageCode: SyntaxLanguageCode;
|
492 | }
|
493 | export interface BatchDetectSyntaxResponse {
|
494 | |
495 |
|
496 |
|
497 | ResultList: ListOfDetectSyntaxResult;
|
498 | |
499 |
|
500 |
|
501 | ErrorList: BatchItemErrorList;
|
502 | }
|
503 | export interface BatchItemError {
|
504 | |
505 |
|
506 |
|
507 | Index?: Integer;
|
508 | |
509 |
|
510 |
|
511 | ErrorCode?: String;
|
512 | |
513 |
|
514 |
|
515 | ErrorMessage?: String;
|
516 | }
|
517 | export type BatchItemErrorList = BatchItemError[];
|
518 | export interface ClassifierEvaluationMetrics {
|
519 | |
520 |
|
521 |
|
522 | Accuracy?: Double;
|
523 | |
524 |
|
525 |
|
526 | Precision?: Double;
|
527 | |
528 |
|
529 |
|
530 | Recall?: Double;
|
531 | |
532 |
|
533 |
|
534 | F1Score?: Double;
|
535 | }
|
536 | export interface ClassifierMetadata {
|
537 | |
538 |
|
539 |
|
540 | NumberOfLabels?: Integer;
|
541 | |
542 |
|
543 |
|
544 | NumberOfTrainedDocuments?: Integer;
|
545 | |
546 |
|
547 |
|
548 | NumberOfTestDocuments?: Integer;
|
549 | |
550 |
|
551 |
|
552 | EvaluationMetrics?: ClassifierEvaluationMetrics;
|
553 | }
|
554 | export type ClientRequestTokenString = string;
|
555 | export type ComprehendArnName = string;
|
556 | export interface CreateDocumentClassifierRequest {
|
557 | |
558 |
|
559 |
|
560 | DocumentClassifierName: ComprehendArnName;
|
561 | |
562 |
|
563 |
|
564 | DataAccessRoleArn: IamRoleArn;
|
565 | |
566 |
|
567 |
|
568 | InputDataConfig: DocumentClassifierInputDataConfig;
|
569 | |
570 |
|
571 |
|
572 | ClientRequestToken?: ClientRequestTokenString;
|
573 | |
574 |
|
575 |
|
576 | LanguageCode: LanguageCode;
|
577 | }
|
578 | export interface CreateDocumentClassifierResponse {
|
579 | |
580 |
|
581 |
|
582 | DocumentClassifierArn?: DocumentClassifierArn;
|
583 | }
|
584 | export interface CreateEntityRecognizerRequest {
|
585 | |
586 |
|
587 |
|
588 | RecognizerName: ComprehendArnName;
|
589 | |
590 |
|
591 |
|
592 | DataAccessRoleArn: IamRoleArn;
|
593 | |
594 |
|
595 |
|
596 | InputDataConfig: EntityRecognizerInputDataConfig;
|
597 | |
598 |
|
599 |
|
600 | ClientRequestToken?: ClientRequestTokenString;
|
601 | |
602 |
|
603 |
|
604 | LanguageCode: LanguageCode;
|
605 | }
|
606 | export interface CreateEntityRecognizerResponse {
|
607 | |
608 |
|
609 |
|
610 | EntityRecognizerArn?: EntityRecognizerArn;
|
611 | }
|
612 | export interface DeleteDocumentClassifierRequest {
|
613 | |
614 |
|
615 |
|
616 | DocumentClassifierArn: DocumentClassifierArn;
|
617 | }
|
618 | export interface DeleteDocumentClassifierResponse {
|
619 | }
|
620 | export interface DeleteEntityRecognizerRequest {
|
621 | |
622 |
|
623 |
|
624 | EntityRecognizerArn: EntityRecognizerArn;
|
625 | }
|
626 | export interface DeleteEntityRecognizerResponse {
|
627 | }
|
628 | export interface DescribeDocumentClassificationJobRequest {
|
629 | |
630 |
|
631 |
|
632 | JobId: JobId;
|
633 | }
|
634 | export interface DescribeDocumentClassificationJobResponse {
|
635 | |
636 |
|
637 |
|
638 | DocumentClassificationJobProperties?: DocumentClassificationJobProperties;
|
639 | }
|
640 | export interface DescribeDocumentClassifierRequest {
|
641 | |
642 |
|
643 |
|
644 | DocumentClassifierArn: DocumentClassifierArn;
|
645 | }
|
646 | export interface DescribeDocumentClassifierResponse {
|
647 | |
648 |
|
649 |
|
650 | DocumentClassifierProperties?: DocumentClassifierProperties;
|
651 | }
|
652 | export interface DescribeDominantLanguageDetectionJobRequest {
|
653 | |
654 |
|
655 |
|
656 | JobId: JobId;
|
657 | }
|
658 | export interface DescribeDominantLanguageDetectionJobResponse {
|
659 | |
660 |
|
661 |
|
662 | DominantLanguageDetectionJobProperties?: DominantLanguageDetectionJobProperties;
|
663 | }
|
664 | export interface DescribeEntitiesDetectionJobRequest {
|
665 | |
666 |
|
667 |
|
668 | JobId: JobId;
|
669 | }
|
670 | export interface DescribeEntitiesDetectionJobResponse {
|
671 | |
672 |
|
673 |
|
674 | EntitiesDetectionJobProperties?: EntitiesDetectionJobProperties;
|
675 | }
|
676 | export interface DescribeEntityRecognizerRequest {
|
677 | |
678 |
|
679 |
|
680 | EntityRecognizerArn: EntityRecognizerArn;
|
681 | }
|
682 | export interface DescribeEntityRecognizerResponse {
|
683 | |
684 |
|
685 |
|
686 | EntityRecognizerProperties?: EntityRecognizerProperties;
|
687 | }
|
688 | export interface DescribeKeyPhrasesDetectionJobRequest {
|
689 | |
690 |
|
691 |
|
692 | JobId: JobId;
|
693 | }
|
694 | export interface DescribeKeyPhrasesDetectionJobResponse {
|
695 | |
696 |
|
697 |
|
698 | KeyPhrasesDetectionJobProperties?: KeyPhrasesDetectionJobProperties;
|
699 | }
|
700 | export interface DescribeSentimentDetectionJobRequest {
|
701 | |
702 |
|
703 |
|
704 | JobId: JobId;
|
705 | }
|
706 | export interface DescribeSentimentDetectionJobResponse {
|
707 | |
708 |
|
709 |
|
710 | SentimentDetectionJobProperties?: SentimentDetectionJobProperties;
|
711 | }
|
712 | export interface DescribeTopicsDetectionJobRequest {
|
713 | |
714 |
|
715 |
|
716 | JobId: JobId;
|
717 | }
|
718 | export interface DescribeTopicsDetectionJobResponse {
|
719 | |
720 |
|
721 |
|
722 | TopicsDetectionJobProperties?: TopicsDetectionJobProperties;
|
723 | }
|
724 | export interface DetectDominantLanguageRequest {
|
725 | |
726 |
|
727 |
|
728 | Text: String;
|
729 | }
|
730 | export interface DetectDominantLanguageResponse {
|
731 | |
732 |
|
733 |
|
734 | Languages?: ListOfDominantLanguages;
|
735 | }
|
736 | export interface DetectEntitiesRequest {
|
737 | |
738 |
|
739 |
|
740 | Text: String;
|
741 | |
742 |
|
743 |
|
744 | LanguageCode: LanguageCode;
|
745 | }
|
746 | export interface DetectEntitiesResponse {
|
747 | |
748 |
|
749 |
|
750 | Entities?: ListOfEntities;
|
751 | }
|
752 | export interface DetectKeyPhrasesRequest {
|
753 | |
754 |
|
755 |
|
756 | Text: String;
|
757 | |
758 |
|
759 |
|
760 | LanguageCode: LanguageCode;
|
761 | }
|
762 | export interface DetectKeyPhrasesResponse {
|
763 | |
764 |
|
765 |
|
766 | KeyPhrases?: ListOfKeyPhrases;
|
767 | }
|
768 | export interface DetectSentimentRequest {
|
769 | |
770 |
|
771 |
|
772 | Text: String;
|
773 | |
774 |
|
775 |
|
776 | LanguageCode: LanguageCode;
|
777 | }
|
778 | export interface DetectSentimentResponse {
|
779 | |
780 |
|
781 |
|
782 | Sentiment?: SentimentType;
|
783 | |
784 |
|
785 |
|
786 | SentimentScore?: SentimentScore;
|
787 | }
|
788 | export interface DetectSyntaxRequest {
|
789 | |
790 |
|
791 |
|
792 | Text: String;
|
793 | |
794 |
|
795 |
|
796 | LanguageCode: SyntaxLanguageCode;
|
797 | }
|
798 | export interface DetectSyntaxResponse {
|
799 | |
800 |
|
801 |
|
802 | SyntaxTokens?: ListOfSyntaxTokens;
|
803 | }
|
804 | export interface DocumentClassificationJobFilter {
|
805 | |
806 |
|
807 |
|
808 | JobName?: JobName;
|
809 | |
810 |
|
811 |
|
812 | JobStatus?: JobStatus;
|
813 | |
814 |
|
815 |
|
816 | SubmitTimeBefore?: Timestamp;
|
817 | |
818 |
|
819 |
|
820 | SubmitTimeAfter?: Timestamp;
|
821 | }
|
822 | export interface DocumentClassificationJobProperties {
|
823 | |
824 |
|
825 |
|
826 | JobId?: JobId;
|
827 | |
828 |
|
829 |
|
830 | JobName?: JobName;
|
831 | |
832 |
|
833 |
|
834 | JobStatus?: JobStatus;
|
835 | |
836 |
|
837 |
|
838 | Message?: AnyLengthString;
|
839 | |
840 |
|
841 |
|
842 | SubmitTime?: Timestamp;
|
843 | |
844 |
|
845 |
|
846 | EndTime?: Timestamp;
|
847 | |
848 |
|
849 |
|
850 | DocumentClassifierArn?: DocumentClassifierArn;
|
851 | |
852 |
|
853 |
|
854 | InputDataConfig?: InputDataConfig;
|
855 | |
856 |
|
857 |
|
858 | OutputDataConfig?: OutputDataConfig;
|
859 | |
860 |
|
861 |
|
862 | DataAccessRoleArn?: IamRoleArn;
|
863 | }
|
864 | export type DocumentClassificationJobPropertiesList = DocumentClassificationJobProperties[];
|
865 | export type DocumentClassifierArn = string;
|
866 | export interface DocumentClassifierFilter {
|
867 | |
868 |
|
869 |
|
870 | Status?: ModelStatus;
|
871 | |
872 |
|
873 |
|
874 | SubmitTimeBefore?: Timestamp;
|
875 | |
876 |
|
877 |
|
878 | SubmitTimeAfter?: Timestamp;
|
879 | }
|
880 | export interface DocumentClassifierInputDataConfig {
|
881 | |
882 |
|
883 |
|
884 | S3Uri: S3Uri;
|
885 | }
|
886 | export interface DocumentClassifierProperties {
|
887 | |
888 |
|
889 |
|
890 | DocumentClassifierArn?: DocumentClassifierArn;
|
891 | |
892 |
|
893 |
|
894 | LanguageCode?: LanguageCode;
|
895 | |
896 |
|
897 |
|
898 | Status?: ModelStatus;
|
899 | |
900 |
|
901 |
|
902 | Message?: AnyLengthString;
|
903 | |
904 |
|
905 |
|
906 | SubmitTime?: Timestamp;
|
907 | |
908 |
|
909 |
|
910 | EndTime?: Timestamp;
|
911 | |
912 |
|
913 |
|
914 | TrainingStartTime?: Timestamp;
|
915 | |
916 |
|
917 |
|
918 | TrainingEndTime?: Timestamp;
|
919 | |
920 |
|
921 |
|
922 | InputDataConfig?: DocumentClassifierInputDataConfig;
|
923 | |
924 |
|
925 |
|
926 | ClassifierMetadata?: ClassifierMetadata;
|
927 | |
928 |
|
929 |
|
930 | DataAccessRoleArn?: IamRoleArn;
|
931 | }
|
932 | export type DocumentClassifierPropertiesList = DocumentClassifierProperties[];
|
933 | export interface DominantLanguage {
|
934 | |
935 |
|
936 |
|
937 | LanguageCode?: String;
|
938 | |
939 |
|
940 |
|
941 | Score?: Float;
|
942 | }
|
943 | export interface DominantLanguageDetectionJobFilter {
|
944 | |
945 |
|
946 |
|
947 | JobName?: JobName;
|
948 | |
949 |
|
950 |
|
951 | JobStatus?: JobStatus;
|
952 | |
953 |
|
954 |
|
955 | SubmitTimeBefore?: Timestamp;
|
956 | |
957 |
|
958 |
|
959 | SubmitTimeAfter?: Timestamp;
|
960 | }
|
961 | export interface DominantLanguageDetectionJobProperties {
|
962 | |
963 |
|
964 |
|
965 | JobId?: JobId;
|
966 | |
967 |
|
968 |
|
969 | JobName?: JobName;
|
970 | |
971 |
|
972 |
|
973 | JobStatus?: JobStatus;
|
974 | |
975 |
|
976 |
|
977 | Message?: AnyLengthString;
|
978 | |
979 |
|
980 |
|
981 | SubmitTime?: Timestamp;
|
982 | |
983 |
|
984 |
|
985 | EndTime?: Timestamp;
|
986 | |
987 |
|
988 |
|
989 | InputDataConfig?: InputDataConfig;
|
990 | |
991 |
|
992 |
|
993 | OutputDataConfig?: OutputDataConfig;
|
994 | |
995 |
|
996 |
|
997 | DataAccessRoleArn?: IamRoleArn;
|
998 | }
|
999 | export type DominantLanguageDetectionJobPropertiesList = DominantLanguageDetectionJobProperties[];
|
1000 | export type Double = number;
|
1001 | export interface EntitiesDetectionJobFilter {
|
1002 | |
1003 |
|
1004 |
|
1005 | JobName?: JobName;
|
1006 | |
1007 |
|
1008 |
|
1009 | JobStatus?: JobStatus;
|
1010 | |
1011 |
|
1012 |
|
1013 | SubmitTimeBefore?: Timestamp;
|
1014 | |
1015 |
|
1016 |
|
1017 | SubmitTimeAfter?: Timestamp;
|
1018 | }
|
1019 | export interface EntitiesDetectionJobProperties {
|
1020 | |
1021 |
|
1022 |
|
1023 | JobId?: JobId;
|
1024 | |
1025 |
|
1026 |
|
1027 | JobName?: JobName;
|
1028 | |
1029 |
|
1030 |
|
1031 | JobStatus?: JobStatus;
|
1032 | |
1033 |
|
1034 |
|
1035 | Message?: AnyLengthString;
|
1036 | |
1037 |
|
1038 |
|
1039 | SubmitTime?: Timestamp;
|
1040 | |
1041 |
|
1042 |
|
1043 | EndTime?: Timestamp;
|
1044 | |
1045 |
|
1046 |
|
1047 | EntityRecognizerArn?: EntityRecognizerArn;
|
1048 | |
1049 |
|
1050 |
|
1051 | InputDataConfig?: InputDataConfig;
|
1052 | |
1053 |
|
1054 |
|
1055 | OutputDataConfig?: OutputDataConfig;
|
1056 | |
1057 |
|
1058 |
|
1059 | LanguageCode?: LanguageCode;
|
1060 | |
1061 |
|
1062 |
|
1063 | DataAccessRoleArn?: IamRoleArn;
|
1064 | }
|
1065 | export type EntitiesDetectionJobPropertiesList = EntitiesDetectionJobProperties[];
|
1066 | export interface Entity {
|
1067 | |
1068 |
|
1069 |
|
1070 | Score?: Float;
|
1071 | |
1072 |
|
1073 |
|
1074 | Type?: EntityType;
|
1075 | |
1076 |
|
1077 |
|
1078 | Text?: String;
|
1079 | |
1080 |
|
1081 |
|
1082 | BeginOffset?: Integer;
|
1083 | |
1084 |
|
1085 |
|
1086 | EndOffset?: Integer;
|
1087 | }
|
1088 | export interface EntityRecognizerAnnotations {
|
1089 | |
1090 |
|
1091 |
|
1092 | S3Uri: S3Uri;
|
1093 | }
|
1094 | export type EntityRecognizerArn = string;
|
1095 | export interface EntityRecognizerDocuments {
|
1096 | |
1097 |
|
1098 |
|
1099 | S3Uri: S3Uri;
|
1100 | }
|
1101 | export interface EntityRecognizerEntityList {
|
1102 | |
1103 |
|
1104 |
|
1105 | S3Uri: S3Uri;
|
1106 | }
|
1107 | export interface EntityRecognizerEvaluationMetrics {
|
1108 | |
1109 |
|
1110 |
|
1111 | Precision?: Double;
|
1112 | |
1113 |
|
1114 |
|
1115 | Recall?: Double;
|
1116 | |
1117 |
|
1118 |
|
1119 | F1Score?: Double;
|
1120 | }
|
1121 | export interface EntityRecognizerFilter {
|
1122 | |
1123 |
|
1124 |
|
1125 | Status?: ModelStatus;
|
1126 | |
1127 |
|
1128 |
|
1129 | SubmitTimeBefore?: Timestamp;
|
1130 | |
1131 |
|
1132 |
|
1133 | SubmitTimeAfter?: Timestamp;
|
1134 | }
|
1135 | export interface EntityRecognizerInputDataConfig {
|
1136 | |
1137 |
|
1138 |
|
1139 | EntityTypes: EntityTypesList;
|
1140 | |
1141 |
|
1142 |
|
1143 | Documents: EntityRecognizerDocuments;
|
1144 | |
1145 |
|
1146 |
|
1147 | Annotations?: EntityRecognizerAnnotations;
|
1148 | |
1149 |
|
1150 |
|
1151 | EntityList?: EntityRecognizerEntityList;
|
1152 | }
|
1153 | export interface EntityRecognizerMetadata {
|
1154 | |
1155 |
|
1156 |
|
1157 | NumberOfTrainedDocuments?: Integer;
|
1158 | |
1159 |
|
1160 |
|
1161 | NumberOfTestDocuments?: Integer;
|
1162 | |
1163 |
|
1164 |
|
1165 | EvaluationMetrics?: EntityRecognizerEvaluationMetrics;
|
1166 | |
1167 |
|
1168 |
|
1169 | EntityTypes?: EntityRecognizerMetadataEntityTypesList;
|
1170 | }
|
1171 | export type EntityRecognizerMetadataEntityTypesList = EntityRecognizerMetadataEntityTypesListItem[];
|
1172 | export interface EntityRecognizerMetadataEntityTypesListItem {
|
1173 | |
1174 |
|
1175 |
|
1176 | Type?: AnyLengthString;
|
1177 | }
|
1178 | export interface EntityRecognizerProperties {
|
1179 | |
1180 |
|
1181 |
|
1182 | EntityRecognizerArn?: EntityRecognizerArn;
|
1183 | |
1184 |
|
1185 |
|
1186 | LanguageCode?: LanguageCode;
|
1187 | |
1188 |
|
1189 |
|
1190 | Status?: ModelStatus;
|
1191 | |
1192 |
|
1193 |
|
1194 | Message?: AnyLengthString;
|
1195 | |
1196 |
|
1197 |
|
1198 | SubmitTime?: Timestamp;
|
1199 | |
1200 |
|
1201 |
|
1202 | EndTime?: Timestamp;
|
1203 | |
1204 |
|
1205 |
|
1206 | TrainingStartTime?: Timestamp;
|
1207 | |
1208 |
|
1209 |
|
1210 | TrainingEndTime?: Timestamp;
|
1211 | |
1212 |
|
1213 |
|
1214 | InputDataConfig?: EntityRecognizerInputDataConfig;
|
1215 | |
1216 |
|
1217 |
|
1218 | RecognizerMetadata?: EntityRecognizerMetadata;
|
1219 | |
1220 |
|
1221 |
|
1222 | DataAccessRoleArn?: IamRoleArn;
|
1223 | }
|
1224 | export type EntityRecognizerPropertiesList = EntityRecognizerProperties[];
|
1225 | export type EntityType = "PERSON"|"LOCATION"|"ORGANIZATION"|"COMMERCIAL_ITEM"|"EVENT"|"DATE"|"QUANTITY"|"TITLE"|"OTHER"|string;
|
1226 | export type EntityTypeName = string;
|
1227 | export type EntityTypesList = EntityTypesListItem[];
|
1228 | export interface EntityTypesListItem {
|
1229 | |
1230 |
|
1231 |
|
1232 | Type: EntityTypeName;
|
1233 | }
|
1234 | export type Float = number;
|
1235 | export type IamRoleArn = string;
|
1236 | export interface InputDataConfig {
|
1237 | |
1238 |
|
1239 |
|
1240 | S3Uri: S3Uri;
|
1241 | |
1242 |
|
1243 |
|
1244 | InputFormat?: InputFormat;
|
1245 | }
|
1246 | export type InputFormat = "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE"|string;
|
1247 | export type Integer = number;
|
1248 | export type JobId = string;
|
1249 | export type JobName = string;
|
1250 | export type JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED"|string;
|
1251 | export interface KeyPhrase {
|
1252 | |
1253 |
|
1254 |
|
1255 | Score?: Float;
|
1256 | |
1257 |
|
1258 |
|
1259 | Text?: String;
|
1260 | |
1261 |
|
1262 |
|
1263 | BeginOffset?: Integer;
|
1264 | |
1265 |
|
1266 |
|
1267 | EndOffset?: Integer;
|
1268 | }
|
1269 | export interface KeyPhrasesDetectionJobFilter {
|
1270 | |
1271 |
|
1272 |
|
1273 | JobName?: JobName;
|
1274 | |
1275 |
|
1276 |
|
1277 | JobStatus?: JobStatus;
|
1278 | |
1279 |
|
1280 |
|
1281 | SubmitTimeBefore?: Timestamp;
|
1282 | |
1283 |
|
1284 |
|
1285 | SubmitTimeAfter?: Timestamp;
|
1286 | }
|
1287 | export interface KeyPhrasesDetectionJobProperties {
|
1288 | |
1289 |
|
1290 |
|
1291 | JobId?: JobId;
|
1292 | |
1293 |
|
1294 |
|
1295 | JobName?: JobName;
|
1296 | |
1297 |
|
1298 |
|
1299 | JobStatus?: JobStatus;
|
1300 | |
1301 |
|
1302 |
|
1303 | Message?: AnyLengthString;
|
1304 | |
1305 |
|
1306 |
|
1307 | SubmitTime?: Timestamp;
|
1308 | |
1309 |
|
1310 |
|
1311 | EndTime?: Timestamp;
|
1312 | |
1313 |
|
1314 |
|
1315 | InputDataConfig?: InputDataConfig;
|
1316 | |
1317 |
|
1318 |
|
1319 | OutputDataConfig?: OutputDataConfig;
|
1320 | |
1321 |
|
1322 |
|
1323 | LanguageCode?: LanguageCode;
|
1324 | |
1325 |
|
1326 |
|
1327 | DataAccessRoleArn?: IamRoleArn;
|
1328 | }
|
1329 | export type KeyPhrasesDetectionJobPropertiesList = KeyPhrasesDetectionJobProperties[];
|
1330 | export type LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|string;
|
1331 | export interface ListDocumentClassificationJobsRequest {
|
1332 | |
1333 |
|
1334 |
|
1335 | Filter?: DocumentClassificationJobFilter;
|
1336 | |
1337 |
|
1338 |
|
1339 | NextToken?: String;
|
1340 | |
1341 |
|
1342 |
|
1343 | MaxResults?: MaxResultsInteger;
|
1344 | }
|
1345 | export interface ListDocumentClassificationJobsResponse {
|
1346 | |
1347 |
|
1348 |
|
1349 | DocumentClassificationJobPropertiesList?: DocumentClassificationJobPropertiesList;
|
1350 | |
1351 |
|
1352 |
|
1353 | NextToken?: String;
|
1354 | }
|
1355 | export interface ListDocumentClassifiersRequest {
|
1356 | |
1357 |
|
1358 |
|
1359 | Filter?: DocumentClassifierFilter;
|
1360 | |
1361 |
|
1362 |
|
1363 | NextToken?: String;
|
1364 | |
1365 |
|
1366 |
|
1367 | MaxResults?: MaxResultsInteger;
|
1368 | }
|
1369 | export interface ListDocumentClassifiersResponse {
|
1370 | |
1371 |
|
1372 |
|
1373 | DocumentClassifierPropertiesList?: DocumentClassifierPropertiesList;
|
1374 | |
1375 |
|
1376 |
|
1377 | NextToken?: String;
|
1378 | }
|
1379 | export interface ListDominantLanguageDetectionJobsRequest {
|
1380 | |
1381 |
|
1382 |
|
1383 | Filter?: DominantLanguageDetectionJobFilter;
|
1384 | |
1385 |
|
1386 |
|
1387 | NextToken?: String;
|
1388 | |
1389 |
|
1390 |
|
1391 | MaxResults?: MaxResultsInteger;
|
1392 | }
|
1393 | export interface ListDominantLanguageDetectionJobsResponse {
|
1394 | |
1395 |
|
1396 |
|
1397 | DominantLanguageDetectionJobPropertiesList?: DominantLanguageDetectionJobPropertiesList;
|
1398 | |
1399 |
|
1400 |
|
1401 | NextToken?: String;
|
1402 | }
|
1403 | export interface ListEntitiesDetectionJobsRequest {
|
1404 | |
1405 |
|
1406 |
|
1407 | Filter?: EntitiesDetectionJobFilter;
|
1408 | |
1409 |
|
1410 |
|
1411 | NextToken?: String;
|
1412 | |
1413 |
|
1414 |
|
1415 | MaxResults?: MaxResultsInteger;
|
1416 | }
|
1417 | export interface ListEntitiesDetectionJobsResponse {
|
1418 | |
1419 |
|
1420 |
|
1421 | EntitiesDetectionJobPropertiesList?: EntitiesDetectionJobPropertiesList;
|
1422 | |
1423 |
|
1424 |
|
1425 | NextToken?: String;
|
1426 | }
|
1427 | export interface ListEntityRecognizersRequest {
|
1428 | |
1429 |
|
1430 |
|
1431 | Filter?: EntityRecognizerFilter;
|
1432 | |
1433 |
|
1434 |
|
1435 | NextToken?: String;
|
1436 | |
1437 |
|
1438 |
|
1439 | MaxResults?: MaxResultsInteger;
|
1440 | }
|
1441 | export interface ListEntityRecognizersResponse {
|
1442 | |
1443 |
|
1444 |
|
1445 | EntityRecognizerPropertiesList?: EntityRecognizerPropertiesList;
|
1446 | |
1447 |
|
1448 |
|
1449 | NextToken?: String;
|
1450 | }
|
1451 | export interface ListKeyPhrasesDetectionJobsRequest {
|
1452 | |
1453 |
|
1454 |
|
1455 | Filter?: KeyPhrasesDetectionJobFilter;
|
1456 | |
1457 |
|
1458 |
|
1459 | NextToken?: String;
|
1460 | |
1461 |
|
1462 |
|
1463 | MaxResults?: MaxResultsInteger;
|
1464 | }
|
1465 | export interface ListKeyPhrasesDetectionJobsResponse {
|
1466 | |
1467 |
|
1468 |
|
1469 | KeyPhrasesDetectionJobPropertiesList?: KeyPhrasesDetectionJobPropertiesList;
|
1470 | |
1471 |
|
1472 |
|
1473 | NextToken?: String;
|
1474 | }
|
1475 | export type ListOfDetectDominantLanguageResult = BatchDetectDominantLanguageItemResult[];
|
1476 | export type ListOfDetectEntitiesResult = BatchDetectEntitiesItemResult[];
|
1477 | export type ListOfDetectKeyPhrasesResult = BatchDetectKeyPhrasesItemResult[];
|
1478 | export type ListOfDetectSentimentResult = BatchDetectSentimentItemResult[];
|
1479 | export type ListOfDetectSyntaxResult = BatchDetectSyntaxItemResult[];
|
1480 | export type ListOfDominantLanguages = DominantLanguage[];
|
1481 | export type ListOfEntities = Entity[];
|
1482 | export type ListOfKeyPhrases = KeyPhrase[];
|
1483 | export type ListOfSyntaxTokens = SyntaxToken[];
|
1484 | export interface ListSentimentDetectionJobsRequest {
|
1485 | |
1486 |
|
1487 |
|
1488 | Filter?: SentimentDetectionJobFilter;
|
1489 | |
1490 |
|
1491 |
|
1492 | NextToken?: String;
|
1493 | |
1494 |
|
1495 |
|
1496 | MaxResults?: MaxResultsInteger;
|
1497 | }
|
1498 | export interface ListSentimentDetectionJobsResponse {
|
1499 | |
1500 |
|
1501 |
|
1502 | SentimentDetectionJobPropertiesList?: SentimentDetectionJobPropertiesList;
|
1503 | |
1504 |
|
1505 |
|
1506 | NextToken?: String;
|
1507 | }
|
1508 | export interface ListTopicsDetectionJobsRequest {
|
1509 | |
1510 |
|
1511 |
|
1512 | Filter?: TopicsDetectionJobFilter;
|
1513 | |
1514 |
|
1515 |
|
1516 | NextToken?: String;
|
1517 | |
1518 |
|
1519 |
|
1520 | MaxResults?: MaxResultsInteger;
|
1521 | }
|
1522 | export interface ListTopicsDetectionJobsResponse {
|
1523 | |
1524 |
|
1525 |
|
1526 | TopicsDetectionJobPropertiesList?: TopicsDetectionJobPropertiesList;
|
1527 | |
1528 |
|
1529 |
|
1530 | NextToken?: String;
|
1531 | }
|
1532 | export type MaxResultsInteger = number;
|
1533 | export type ModelStatus = "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED"|string;
|
1534 | export type NumberOfTopicsInteger = number;
|
1535 | export interface OutputDataConfig {
|
1536 | |
1537 |
|
1538 |
|
1539 | S3Uri: S3Uri;
|
1540 | }
|
1541 | export interface PartOfSpeechTag {
|
1542 | |
1543 |
|
1544 |
|
1545 | Tag?: PartOfSpeechTagType;
|
1546 | |
1547 |
|
1548 |
|
1549 | Score?: Float;
|
1550 | }
|
1551 | export type PartOfSpeechTagType = "ADJ"|"ADP"|"ADV"|"AUX"|"CONJ"|"CCONJ"|"DET"|"INTJ"|"NOUN"|"NUM"|"O"|"PART"|"PRON"|"PROPN"|"PUNCT"|"SCONJ"|"SYM"|"VERB"|string;
|
1552 | export type S3Uri = string;
|
1553 | export interface SentimentDetectionJobFilter {
|
1554 | |
1555 |
|
1556 |
|
1557 | JobName?: JobName;
|
1558 | |
1559 |
|
1560 |
|
1561 | JobStatus?: JobStatus;
|
1562 | |
1563 |
|
1564 |
|
1565 | SubmitTimeBefore?: Timestamp;
|
1566 | |
1567 |
|
1568 |
|
1569 | SubmitTimeAfter?: Timestamp;
|
1570 | }
|
1571 | export interface SentimentDetectionJobProperties {
|
1572 | |
1573 |
|
1574 |
|
1575 | JobId?: JobId;
|
1576 | |
1577 |
|
1578 |
|
1579 | JobName?: JobName;
|
1580 | |
1581 |
|
1582 |
|
1583 | JobStatus?: JobStatus;
|
1584 | |
1585 |
|
1586 |
|
1587 | Message?: AnyLengthString;
|
1588 | |
1589 |
|
1590 |
|
1591 | SubmitTime?: Timestamp;
|
1592 | |
1593 |
|
1594 |
|
1595 | EndTime?: Timestamp;
|
1596 | |
1597 |
|
1598 |
|
1599 | InputDataConfig?: InputDataConfig;
|
1600 | |
1601 |
|
1602 |
|
1603 | OutputDataConfig?: OutputDataConfig;
|
1604 | |
1605 |
|
1606 |
|
1607 | LanguageCode?: LanguageCode;
|
1608 | |
1609 |
|
1610 |
|
1611 | DataAccessRoleArn?: IamRoleArn;
|
1612 | }
|
1613 | export type SentimentDetectionJobPropertiesList = SentimentDetectionJobProperties[];
|
1614 | export interface SentimentScore {
|
1615 | |
1616 |
|
1617 |
|
1618 | Positive?: Float;
|
1619 | |
1620 |
|
1621 |
|
1622 | Negative?: Float;
|
1623 | |
1624 |
|
1625 |
|
1626 | Neutral?: Float;
|
1627 | |
1628 |
|
1629 |
|
1630 | Mixed?: Float;
|
1631 | }
|
1632 | export type SentimentType = "POSITIVE"|"NEGATIVE"|"NEUTRAL"|"MIXED"|string;
|
1633 | export interface StartDocumentClassificationJobRequest {
|
1634 | |
1635 |
|
1636 |
|
1637 | JobName?: JobName;
|
1638 | |
1639 |
|
1640 |
|
1641 | DocumentClassifierArn: DocumentClassifierArn;
|
1642 | |
1643 |
|
1644 |
|
1645 | InputDataConfig: InputDataConfig;
|
1646 | |
1647 |
|
1648 |
|
1649 | OutputDataConfig: OutputDataConfig;
|
1650 | |
1651 |
|
1652 |
|
1653 | DataAccessRoleArn: IamRoleArn;
|
1654 | |
1655 |
|
1656 |
|
1657 | ClientRequestToken?: ClientRequestTokenString;
|
1658 | }
|
1659 | export interface StartDocumentClassificationJobResponse {
|
1660 | |
1661 |
|
1662 |
|
1663 | JobId?: JobId;
|
1664 | |
1665 |
|
1666 |
|
1667 | JobStatus?: JobStatus;
|
1668 | }
|
1669 | export interface StartDominantLanguageDetectionJobRequest {
|
1670 | |
1671 |
|
1672 |
|
1673 | InputDataConfig: InputDataConfig;
|
1674 | |
1675 |
|
1676 |
|
1677 | OutputDataConfig: OutputDataConfig;
|
1678 | |
1679 |
|
1680 |
|
1681 | DataAccessRoleArn: IamRoleArn;
|
1682 | |
1683 |
|
1684 |
|
1685 | JobName?: JobName;
|
1686 | |
1687 |
|
1688 |
|
1689 | ClientRequestToken?: ClientRequestTokenString;
|
1690 | }
|
1691 | export interface StartDominantLanguageDetectionJobResponse {
|
1692 | |
1693 |
|
1694 |
|
1695 | JobId?: JobId;
|
1696 | |
1697 |
|
1698 |
|
1699 | JobStatus?: JobStatus;
|
1700 | }
|
1701 | export interface StartEntitiesDetectionJobRequest {
|
1702 | |
1703 |
|
1704 |
|
1705 | InputDataConfig: InputDataConfig;
|
1706 | |
1707 |
|
1708 |
|
1709 | OutputDataConfig: OutputDataConfig;
|
1710 | |
1711 |
|
1712 |
|
1713 | DataAccessRoleArn: IamRoleArn;
|
1714 | |
1715 |
|
1716 |
|
1717 | JobName?: JobName;
|
1718 | |
1719 |
|
1720 |
|
1721 | EntityRecognizerArn?: EntityRecognizerArn;
|
1722 | |
1723 |
|
1724 |
|
1725 | LanguageCode: LanguageCode;
|
1726 | |
1727 |
|
1728 |
|
1729 | ClientRequestToken?: ClientRequestTokenString;
|
1730 | }
|
1731 | export interface StartEntitiesDetectionJobResponse {
|
1732 | |
1733 |
|
1734 |
|
1735 | JobId?: JobId;
|
1736 | |
1737 |
|
1738 |
|
1739 | JobStatus?: JobStatus;
|
1740 | }
|
1741 | export interface StartKeyPhrasesDetectionJobRequest {
|
1742 | |
1743 |
|
1744 |
|
1745 | InputDataConfig: InputDataConfig;
|
1746 | |
1747 |
|
1748 |
|
1749 | OutputDataConfig: OutputDataConfig;
|
1750 | |
1751 |
|
1752 |
|
1753 | DataAccessRoleArn: IamRoleArn;
|
1754 | |
1755 |
|
1756 |
|
1757 | JobName?: JobName;
|
1758 | |
1759 |
|
1760 |
|
1761 | LanguageCode: LanguageCode;
|
1762 | |
1763 |
|
1764 |
|
1765 | ClientRequestToken?: ClientRequestTokenString;
|
1766 | }
|
1767 | export interface StartKeyPhrasesDetectionJobResponse {
|
1768 | |
1769 |
|
1770 |
|
1771 | JobId?: JobId;
|
1772 | |
1773 |
|
1774 |
|
1775 | JobStatus?: JobStatus;
|
1776 | }
|
1777 | export interface StartSentimentDetectionJobRequest {
|
1778 | |
1779 |
|
1780 |
|
1781 | InputDataConfig: InputDataConfig;
|
1782 | |
1783 |
|
1784 |
|
1785 | OutputDataConfig: OutputDataConfig;
|
1786 | |
1787 |
|
1788 |
|
1789 | DataAccessRoleArn: IamRoleArn;
|
1790 | |
1791 |
|
1792 |
|
1793 | JobName?: JobName;
|
1794 | |
1795 |
|
1796 |
|
1797 | LanguageCode: LanguageCode;
|
1798 | |
1799 |
|
1800 |
|
1801 | ClientRequestToken?: ClientRequestTokenString;
|
1802 | }
|
1803 | export interface StartSentimentDetectionJobResponse {
|
1804 | |
1805 |
|
1806 |
|
1807 | JobId?: JobId;
|
1808 | |
1809 |
|
1810 |
|
1811 | JobStatus?: JobStatus;
|
1812 | }
|
1813 | export interface StartTopicsDetectionJobRequest {
|
1814 | |
1815 |
|
1816 |
|
1817 | InputDataConfig: InputDataConfig;
|
1818 | |
1819 |
|
1820 |
|
1821 | OutputDataConfig: OutputDataConfig;
|
1822 | |
1823 |
|
1824 |
|
1825 | DataAccessRoleArn: IamRoleArn;
|
1826 | |
1827 |
|
1828 |
|
1829 | JobName?: JobName;
|
1830 | |
1831 |
|
1832 |
|
1833 | NumberOfTopics?: NumberOfTopicsInteger;
|
1834 | |
1835 |
|
1836 |
|
1837 | ClientRequestToken?: ClientRequestTokenString;
|
1838 | }
|
1839 | export interface StartTopicsDetectionJobResponse {
|
1840 | |
1841 |
|
1842 |
|
1843 | JobId?: JobId;
|
1844 | |
1845 |
|
1846 |
|
1847 | JobStatus?: JobStatus;
|
1848 | }
|
1849 | export interface StopDominantLanguageDetectionJobRequest {
|
1850 | |
1851 |
|
1852 |
|
1853 | JobId: JobId;
|
1854 | }
|
1855 | export interface StopDominantLanguageDetectionJobResponse {
|
1856 | |
1857 |
|
1858 |
|
1859 | JobId?: JobId;
|
1860 | |
1861 |
|
1862 |
|
1863 | JobStatus?: JobStatus;
|
1864 | }
|
1865 | export interface StopEntitiesDetectionJobRequest {
|
1866 | |
1867 |
|
1868 |
|
1869 | JobId: JobId;
|
1870 | }
|
1871 | export interface StopEntitiesDetectionJobResponse {
|
1872 | |
1873 |
|
1874 |
|
1875 | JobId?: JobId;
|
1876 | |
1877 |
|
1878 |
|
1879 | JobStatus?: JobStatus;
|
1880 | }
|
1881 | export interface StopKeyPhrasesDetectionJobRequest {
|
1882 | |
1883 |
|
1884 |
|
1885 | JobId: JobId;
|
1886 | }
|
1887 | export interface StopKeyPhrasesDetectionJobResponse {
|
1888 | |
1889 |
|
1890 |
|
1891 | JobId?: JobId;
|
1892 | |
1893 |
|
1894 |
|
1895 | JobStatus?: JobStatus;
|
1896 | }
|
1897 | export interface StopSentimentDetectionJobRequest {
|
1898 | |
1899 |
|
1900 |
|
1901 | JobId: JobId;
|
1902 | }
|
1903 | export interface StopSentimentDetectionJobResponse {
|
1904 | |
1905 |
|
1906 |
|
1907 | JobId?: JobId;
|
1908 | |
1909 |
|
1910 |
|
1911 | JobStatus?: JobStatus;
|
1912 | }
|
1913 | export interface StopTrainingDocumentClassifierRequest {
|
1914 | |
1915 |
|
1916 |
|
1917 | DocumentClassifierArn: DocumentClassifierArn;
|
1918 | }
|
1919 | export interface StopTrainingDocumentClassifierResponse {
|
1920 | }
|
1921 | export interface StopTrainingEntityRecognizerRequest {
|
1922 | |
1923 |
|
1924 |
|
1925 | EntityRecognizerArn: EntityRecognizerArn;
|
1926 | }
|
1927 | export interface StopTrainingEntityRecognizerResponse {
|
1928 | }
|
1929 | export type String = string;
|
1930 | export type StringList = String[];
|
1931 | export type SyntaxLanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|string;
|
1932 | export interface SyntaxToken {
|
1933 | |
1934 |
|
1935 |
|
1936 | TokenId?: Integer;
|
1937 | |
1938 |
|
1939 |
|
1940 | Text?: String;
|
1941 | |
1942 |
|
1943 |
|
1944 | BeginOffset?: Integer;
|
1945 | |
1946 |
|
1947 |
|
1948 | EndOffset?: Integer;
|
1949 | |
1950 |
|
1951 |
|
1952 | PartOfSpeech?: PartOfSpeechTag;
|
1953 | }
|
1954 | export type Timestamp = Date;
|
1955 | export interface TopicsDetectionJobFilter {
|
1956 | |
1957 |
|
1958 |
|
1959 | JobName?: JobName;
|
1960 | |
1961 |
|
1962 |
|
1963 | JobStatus?: JobStatus;
|
1964 | |
1965 |
|
1966 |
|
1967 | SubmitTimeBefore?: Timestamp;
|
1968 | |
1969 |
|
1970 |
|
1971 | SubmitTimeAfter?: Timestamp;
|
1972 | }
|
1973 | export interface TopicsDetectionJobProperties {
|
1974 | |
1975 |
|
1976 |
|
1977 | JobId?: JobId;
|
1978 | |
1979 |
|
1980 |
|
1981 | JobName?: JobName;
|
1982 | |
1983 |
|
1984 |
|
1985 | JobStatus?: JobStatus;
|
1986 | |
1987 |
|
1988 |
|
1989 | Message?: AnyLengthString;
|
1990 | |
1991 |
|
1992 |
|
1993 | SubmitTime?: Timestamp;
|
1994 | |
1995 |
|
1996 |
|
1997 | EndTime?: Timestamp;
|
1998 | |
1999 |
|
2000 |
|
2001 | InputDataConfig?: InputDataConfig;
|
2002 | |
2003 |
|
2004 |
|
2005 | OutputDataConfig?: OutputDataConfig;
|
2006 | |
2007 |
|
2008 |
|
2009 | NumberOfTopics?: Integer;
|
2010 | }
|
2011 | export type TopicsDetectionJobPropertiesList = TopicsDetectionJobProperties[];
|
2012 | |
2013 |
|
2014 |
|
2015 | export type apiVersion = "2017-11-27"|"latest"|string;
|
2016 | export interface ClientApiVersions {
|
2017 | |
2018 |
|
2019 |
|
2020 | apiVersion?: apiVersion;
|
2021 | }
|
2022 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
2023 | |
2024 |
|
2025 |
|
2026 | export import Types = Comprehend;
|
2027 | }
|
2028 | export = Comprehend;
|