@aws-sdk/client-comprehend 3.312.0 → 3.316.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/Comprehend.js +88 -1176
- package/dist-cjs/models/models_0.js +10 -2
- package/dist-cjs/protocols/Aws_json1_1.js +1268 -2840
- package/dist-es/Comprehend.js +88 -1176
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/protocols/Aws_json1_1.js +1269 -2841
- package/dist-types/Comprehend.d.ts +94 -369
- package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +16 -4
- package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +4 -0
- package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +4 -0
- package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +1 -1
- package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +122 -53
- package/dist-types/models/models_1.d.ts +46 -0
- package/dist-types/ts3.4/Comprehend.d.ts +4 -1
- package/dist-types/ts3.4/commands/StopPiiEntitiesDetectionJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopSentimentDetectionJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +25 -14
- package/dist-types/ts3.4/models/models_1.d.ts +14 -0
- package/package.json +6 -6
|
@@ -84,793 +84,518 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
84
84
|
import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "./commands/UpdateEndpointCommand";
|
|
85
85
|
import { UpdateFlywheelCommandInput, UpdateFlywheelCommandOutput } from "./commands/UpdateFlywheelCommand";
|
|
86
86
|
import { ComprehendClient } from "./ComprehendClient";
|
|
87
|
-
|
|
88
|
-
* @public
|
|
89
|
-
* <p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
|
|
90
|
-
* Use these actions to determine the topics contained in your documents, the topics they
|
|
91
|
-
* discuss, the predominant sentiment expressed in them, the predominant language used, and
|
|
92
|
-
* more.</p>
|
|
93
|
-
*/
|
|
94
|
-
export declare class Comprehend extends ComprehendClient {
|
|
87
|
+
export interface Comprehend {
|
|
95
88
|
/**
|
|
96
|
-
* @
|
|
97
|
-
* <p>Determines the dominant language of the input text for a batch of documents. For a list
|
|
98
|
-
* of languages that Amazon Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>.
|
|
99
|
-
* </p>
|
|
89
|
+
* @see {@link BatchDetectDominantLanguageCommand}
|
|
100
90
|
*/
|
|
101
91
|
batchDetectDominantLanguage(args: BatchDetectDominantLanguageCommandInput, options?: __HttpHandlerOptions): Promise<BatchDetectDominantLanguageCommandOutput>;
|
|
102
92
|
batchDetectDominantLanguage(args: BatchDetectDominantLanguageCommandInput, cb: (err: any, data?: BatchDetectDominantLanguageCommandOutput) => void): void;
|
|
103
93
|
batchDetectDominantLanguage(args: BatchDetectDominantLanguageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectDominantLanguageCommandOutput) => void): void;
|
|
104
94
|
/**
|
|
105
|
-
* @
|
|
106
|
-
* <p>Inspects the text of a batch of documents for named entities and returns information
|
|
107
|
-
* about them. For more information about named entities, see
|
|
108
|
-
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide.
|
|
109
|
-
* </p>
|
|
95
|
+
* @see {@link BatchDetectEntitiesCommand}
|
|
110
96
|
*/
|
|
111
97
|
batchDetectEntities(args: BatchDetectEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<BatchDetectEntitiesCommandOutput>;
|
|
112
98
|
batchDetectEntities(args: BatchDetectEntitiesCommandInput, cb: (err: any, data?: BatchDetectEntitiesCommandOutput) => void): void;
|
|
113
99
|
batchDetectEntities(args: BatchDetectEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectEntitiesCommandOutput) => void): void;
|
|
114
100
|
/**
|
|
115
|
-
* @
|
|
116
|
-
* <p>Detects the key noun phrases found in a batch of documents.</p>
|
|
101
|
+
* @see {@link BatchDetectKeyPhrasesCommand}
|
|
117
102
|
*/
|
|
118
103
|
batchDetectKeyPhrases(args: BatchDetectKeyPhrasesCommandInput, options?: __HttpHandlerOptions): Promise<BatchDetectKeyPhrasesCommandOutput>;
|
|
119
104
|
batchDetectKeyPhrases(args: BatchDetectKeyPhrasesCommandInput, cb: (err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void): void;
|
|
120
105
|
batchDetectKeyPhrases(args: BatchDetectKeyPhrasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void): void;
|
|
121
106
|
/**
|
|
122
|
-
* @
|
|
123
|
-
* <p>Inspects a batch of documents and returns an inference of the prevailing sentiment,
|
|
124
|
-
* <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>,
|
|
125
|
-
* in each one.</p>
|
|
107
|
+
* @see {@link BatchDetectSentimentCommand}
|
|
126
108
|
*/
|
|
127
109
|
batchDetectSentiment(args: BatchDetectSentimentCommandInput, options?: __HttpHandlerOptions): Promise<BatchDetectSentimentCommandOutput>;
|
|
128
110
|
batchDetectSentiment(args: BatchDetectSentimentCommandInput, cb: (err: any, data?: BatchDetectSentimentCommandOutput) => void): void;
|
|
129
111
|
batchDetectSentiment(args: BatchDetectSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectSentimentCommandOutput) => void): void;
|
|
130
112
|
/**
|
|
131
|
-
* @
|
|
132
|
-
* <p>Inspects the text of a batch of documents for the syntax and part of speech of the words
|
|
133
|
-
* in the document and returns information about them. For more information, see
|
|
134
|
-
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide.
|
|
135
|
-
* </p>
|
|
113
|
+
* @see {@link BatchDetectSyntaxCommand}
|
|
136
114
|
*/
|
|
137
115
|
batchDetectSyntax(args: BatchDetectSyntaxCommandInput, options?: __HttpHandlerOptions): Promise<BatchDetectSyntaxCommandOutput>;
|
|
138
116
|
batchDetectSyntax(args: BatchDetectSyntaxCommandInput, cb: (err: any, data?: BatchDetectSyntaxCommandOutput) => void): void;
|
|
139
117
|
batchDetectSyntax(args: BatchDetectSyntaxCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectSyntaxCommandOutput) => void): void;
|
|
140
118
|
/**
|
|
141
|
-
* @
|
|
142
|
-
* <p>Inspects a batch of documents and returns a sentiment analysis
|
|
143
|
-
* for each entity identified in the documents.</p>
|
|
144
|
-
* <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
|
|
119
|
+
* @see {@link BatchDetectTargetedSentimentCommand}
|
|
145
120
|
*/
|
|
146
121
|
batchDetectTargetedSentiment(args: BatchDetectTargetedSentimentCommandInput, options?: __HttpHandlerOptions): Promise<BatchDetectTargetedSentimentCommandOutput>;
|
|
147
122
|
batchDetectTargetedSentiment(args: BatchDetectTargetedSentimentCommandInput, cb: (err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void): void;
|
|
148
123
|
batchDetectTargetedSentiment(args: BatchDetectTargetedSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void): void;
|
|
149
124
|
/**
|
|
150
|
-
* @
|
|
151
|
-
* <p>Creates a new document classification request to analyze a single document in real-time,
|
|
152
|
-
* using a previously created and trained custom model and an endpoint.</p>
|
|
153
|
-
* <p>You can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
|
|
154
|
-
* <p>If the system detects errors while processing a page in the input document,
|
|
155
|
-
* the API response includes an entry in <code>Errors</code> that describes the errors.</p>
|
|
156
|
-
* <p>If the system detects a document-level error in your input document, the API returns an
|
|
157
|
-
* <code>InvalidRequestException</code> error response.
|
|
158
|
-
* For details about this exception, see
|
|
159
|
-
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html">
|
|
160
|
-
* Errors in semi-structured documents</a> in the Comprehend Developer Guide.
|
|
161
|
-
* </p>
|
|
125
|
+
* @see {@link ClassifyDocumentCommand}
|
|
162
126
|
*/
|
|
163
127
|
classifyDocument(args: ClassifyDocumentCommandInput, options?: __HttpHandlerOptions): Promise<ClassifyDocumentCommandOutput>;
|
|
164
128
|
classifyDocument(args: ClassifyDocumentCommandInput, cb: (err: any, data?: ClassifyDocumentCommandOutput) => void): void;
|
|
165
129
|
classifyDocument(args: ClassifyDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClassifyDocumentCommandOutput) => void): void;
|
|
166
130
|
/**
|
|
167
|
-
* @
|
|
168
|
-
* <p>Analyzes input text for the presence of personally identifiable information (PII) and
|
|
169
|
-
* returns the labels of identified PII entity types such as name, address, bank account number,
|
|
170
|
-
* or phone number.</p>
|
|
131
|
+
* @see {@link ContainsPiiEntitiesCommand}
|
|
171
132
|
*/
|
|
172
133
|
containsPiiEntities(args: ContainsPiiEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<ContainsPiiEntitiesCommandOutput>;
|
|
173
134
|
containsPiiEntities(args: ContainsPiiEntitiesCommandInput, cb: (err: any, data?: ContainsPiiEntitiesCommandOutput) => void): void;
|
|
174
135
|
containsPiiEntities(args: ContainsPiiEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ContainsPiiEntitiesCommandOutput) => void): void;
|
|
175
136
|
/**
|
|
176
|
-
* @
|
|
177
|
-
* <p>Creates a dataset to upload training or test data for a model associated with a flywheel.
|
|
178
|
-
* For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
179
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
137
|
+
* @see {@link CreateDatasetCommand}
|
|
180
138
|
*/
|
|
181
139
|
createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
|
|
182
140
|
createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
183
141
|
createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
184
142
|
/**
|
|
185
|
-
* @
|
|
186
|
-
* <p>Creates a new document classifier that you can use to categorize documents. To create a
|
|
187
|
-
* classifier, you provide a set of training documents that labeled with the categories that you
|
|
188
|
-
* want to use. After the classifier is trained you can use it to categorize a set of labeled
|
|
189
|
-
* documents into the categories. For more information, see
|
|
190
|
-
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html">Document Classification</a> in the Comprehend Developer Guide.
|
|
191
|
-
* </p>
|
|
143
|
+
* @see {@link CreateDocumentClassifierCommand}
|
|
192
144
|
*/
|
|
193
145
|
createDocumentClassifier(args: CreateDocumentClassifierCommandInput, options?: __HttpHandlerOptions): Promise<CreateDocumentClassifierCommandOutput>;
|
|
194
146
|
createDocumentClassifier(args: CreateDocumentClassifierCommandInput, cb: (err: any, data?: CreateDocumentClassifierCommandOutput) => void): void;
|
|
195
147
|
createDocumentClassifier(args: CreateDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDocumentClassifierCommandOutput) => void): void;
|
|
196
148
|
/**
|
|
197
|
-
* @
|
|
198
|
-
* <p>Creates a model-specific endpoint for synchronous inference for a previously trained
|
|
199
|
-
* custom model
|
|
200
|
-
* For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
|
|
149
|
+
* @see {@link CreateEndpointCommand}
|
|
201
150
|
*/
|
|
202
151
|
createEndpoint(args: CreateEndpointCommandInput, options?: __HttpHandlerOptions): Promise<CreateEndpointCommandOutput>;
|
|
203
152
|
createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void;
|
|
204
153
|
createEndpoint(args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void;
|
|
205
154
|
/**
|
|
206
|
-
* @
|
|
207
|
-
* <p>Creates an entity recognizer using submitted files. After your
|
|
208
|
-
* <code>CreateEntityRecognizer</code> request is submitted, you can check job status using the
|
|
209
|
-
* <code>DescribeEntityRecognizer</code> API. </p>
|
|
155
|
+
* @see {@link CreateEntityRecognizerCommand}
|
|
210
156
|
*/
|
|
211
157
|
createEntityRecognizer(args: CreateEntityRecognizerCommandInput, options?: __HttpHandlerOptions): Promise<CreateEntityRecognizerCommandOutput>;
|
|
212
158
|
createEntityRecognizer(args: CreateEntityRecognizerCommandInput, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void): void;
|
|
213
159
|
createEntityRecognizer(args: CreateEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void): void;
|
|
214
160
|
/**
|
|
215
|
-
* @
|
|
216
|
-
* <p>A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification
|
|
217
|
-
* or custom entity recognition. You can create a flywheel to start with an existing trained model, or
|
|
218
|
-
* Comprehend can create and train a new model.</p>
|
|
219
|
-
* <p>When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training
|
|
220
|
-
* data and test data for all versions of the model.</p>
|
|
221
|
-
* <p>To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's
|
|
222
|
-
* training data and test data into the flywheel's data lake.</p>
|
|
223
|
-
* <p>To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data)
|
|
224
|
-
* when you create the flywheel.</p>
|
|
225
|
-
* <p>For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
226
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
161
|
+
* @see {@link CreateFlywheelCommand}
|
|
227
162
|
*/
|
|
228
163
|
createFlywheel(args: CreateFlywheelCommandInput, options?: __HttpHandlerOptions): Promise<CreateFlywheelCommandOutput>;
|
|
229
164
|
createFlywheel(args: CreateFlywheelCommandInput, cb: (err: any, data?: CreateFlywheelCommandOutput) => void): void;
|
|
230
165
|
createFlywheel(args: CreateFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlywheelCommandOutput) => void): void;
|
|
231
166
|
/**
|
|
232
|
-
* @
|
|
233
|
-
* <p>Deletes a previously created document classifier</p>
|
|
234
|
-
* <p>Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
|
|
235
|
-
* If an active inference job is using the model, a <code>ResourceInUseException</code> will be
|
|
236
|
-
* returned.</p>
|
|
237
|
-
* <p>This is an asynchronous action that puts the classifier into a DELETING state, and it is
|
|
238
|
-
* then removed by a background job. Once removed, the classifier disappears from your account
|
|
239
|
-
* and is no longer available for use. </p>
|
|
167
|
+
* @see {@link DeleteDocumentClassifierCommand}
|
|
240
168
|
*/
|
|
241
169
|
deleteDocumentClassifier(args: DeleteDocumentClassifierCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDocumentClassifierCommandOutput>;
|
|
242
170
|
deleteDocumentClassifier(args: DeleteDocumentClassifierCommandInput, cb: (err: any, data?: DeleteDocumentClassifierCommandOutput) => void): void;
|
|
243
171
|
deleteDocumentClassifier(args: DeleteDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentClassifierCommandOutput) => void): void;
|
|
244
172
|
/**
|
|
245
|
-
* @
|
|
246
|
-
* <p>Deletes a model-specific endpoint for a previously-trained custom model. All endpoints
|
|
247
|
-
* must be deleted in order for the model to be deleted.
|
|
248
|
-
* For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
|
|
173
|
+
* @see {@link DeleteEndpointCommand}
|
|
249
174
|
*/
|
|
250
175
|
deleteEndpoint(args: DeleteEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEndpointCommandOutput>;
|
|
251
176
|
deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
|
|
252
177
|
deleteEndpoint(args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
|
|
253
178
|
/**
|
|
254
|
-
* @
|
|
255
|
-
* <p>Deletes an entity recognizer.</p>
|
|
256
|
-
* <p>Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
|
|
257
|
-
* If an active inference job is using the model, a <code>ResourceInUseException</code> will be
|
|
258
|
-
* returned.</p>
|
|
259
|
-
* <p>This is an asynchronous action that puts the recognizer into a DELETING state, and it is
|
|
260
|
-
* then removed by a background job. Once removed, the recognizer disappears from your account
|
|
261
|
-
* and is no longer available for use. </p>
|
|
179
|
+
* @see {@link DeleteEntityRecognizerCommand}
|
|
262
180
|
*/
|
|
263
181
|
deleteEntityRecognizer(args: DeleteEntityRecognizerCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEntityRecognizerCommandOutput>;
|
|
264
182
|
deleteEntityRecognizer(args: DeleteEntityRecognizerCommandInput, cb: (err: any, data?: DeleteEntityRecognizerCommandOutput) => void): void;
|
|
265
183
|
deleteEntityRecognizer(args: DeleteEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEntityRecognizerCommandOutput) => void): void;
|
|
266
184
|
/**
|
|
267
|
-
* @
|
|
268
|
-
* <p>Deletes a flywheel. When you delete the flywheel, Amazon Comprehend
|
|
269
|
-
* does not delete the data lake or the model associated with the flywheel.</p>
|
|
270
|
-
* <p>For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
271
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
185
|
+
* @see {@link DeleteFlywheelCommand}
|
|
272
186
|
*/
|
|
273
187
|
deleteFlywheel(args: DeleteFlywheelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFlywheelCommandOutput>;
|
|
274
188
|
deleteFlywheel(args: DeleteFlywheelCommandInput, cb: (err: any, data?: DeleteFlywheelCommandOutput) => void): void;
|
|
275
189
|
deleteFlywheel(args: DeleteFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlywheelCommandOutput) => void): void;
|
|
276
190
|
/**
|
|
277
|
-
* @
|
|
278
|
-
* <p>Deletes a resource-based policy that is attached to a custom model.</p>
|
|
191
|
+
* @see {@link DeleteResourcePolicyCommand}
|
|
279
192
|
*/
|
|
280
193
|
deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
|
|
281
194
|
deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
|
|
282
195
|
deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
|
|
283
196
|
/**
|
|
284
|
-
* @
|
|
285
|
-
* <p>Returns information about the dataset that you specify.
|
|
286
|
-
* For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
287
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
197
|
+
* @see {@link DescribeDatasetCommand}
|
|
288
198
|
*/
|
|
289
199
|
describeDataset(args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetCommandOutput>;
|
|
290
200
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
291
201
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
292
202
|
/**
|
|
293
|
-
* @
|
|
294
|
-
* <p>Gets the properties associated with a document classification job. Use this operation to
|
|
295
|
-
* get the status of a classification job.</p>
|
|
203
|
+
* @see {@link DescribeDocumentClassificationJobCommand}
|
|
296
204
|
*/
|
|
297
205
|
describeDocumentClassificationJob(args: DescribeDocumentClassificationJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDocumentClassificationJobCommandOutput>;
|
|
298
206
|
describeDocumentClassificationJob(args: DescribeDocumentClassificationJobCommandInput, cb: (err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void): void;
|
|
299
207
|
describeDocumentClassificationJob(args: DescribeDocumentClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void): void;
|
|
300
208
|
/**
|
|
301
|
-
* @
|
|
302
|
-
* <p>Gets the properties associated with a document classifier.</p>
|
|
209
|
+
* @see {@link DescribeDocumentClassifierCommand}
|
|
303
210
|
*/
|
|
304
211
|
describeDocumentClassifier(args: DescribeDocumentClassifierCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDocumentClassifierCommandOutput>;
|
|
305
212
|
describeDocumentClassifier(args: DescribeDocumentClassifierCommandInput, cb: (err: any, data?: DescribeDocumentClassifierCommandOutput) => void): void;
|
|
306
213
|
describeDocumentClassifier(args: DescribeDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentClassifierCommandOutput) => void): void;
|
|
307
214
|
/**
|
|
308
|
-
* @
|
|
309
|
-
* <p>Gets the properties associated with a dominant language detection job. Use this operation
|
|
310
|
-
* to get the status of a detection job.</p>
|
|
215
|
+
* @see {@link DescribeDominantLanguageDetectionJobCommand}
|
|
311
216
|
*/
|
|
312
217
|
describeDominantLanguageDetectionJob(args: DescribeDominantLanguageDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDominantLanguageDetectionJobCommandOutput>;
|
|
313
218
|
describeDominantLanguageDetectionJob(args: DescribeDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void): void;
|
|
314
219
|
describeDominantLanguageDetectionJob(args: DescribeDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void): void;
|
|
315
220
|
/**
|
|
316
|
-
* @
|
|
317
|
-
* <p>Gets the properties associated with a specific endpoint. Use this operation to get the
|
|
318
|
-
* status of an endpoint.
|
|
319
|
-
* For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
|
|
221
|
+
* @see {@link DescribeEndpointCommand}
|
|
320
222
|
*/
|
|
321
223
|
describeEndpoint(args: DescribeEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEndpointCommandOutput>;
|
|
322
224
|
describeEndpoint(args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void): void;
|
|
323
225
|
describeEndpoint(args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => void): void;
|
|
324
226
|
/**
|
|
325
|
-
* @
|
|
326
|
-
* <p>Gets the properties associated with an entities detection job. Use this operation to get
|
|
327
|
-
* the status of a detection job.</p>
|
|
227
|
+
* @see {@link DescribeEntitiesDetectionJobCommand}
|
|
328
228
|
*/
|
|
329
229
|
describeEntitiesDetectionJob(args: DescribeEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEntitiesDetectionJobCommandOutput>;
|
|
330
230
|
describeEntitiesDetectionJob(args: DescribeEntitiesDetectionJobCommandInput, cb: (err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void): void;
|
|
331
231
|
describeEntitiesDetectionJob(args: DescribeEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void): void;
|
|
332
232
|
/**
|
|
333
|
-
* @
|
|
334
|
-
* <p>Provides details about an entity recognizer including status, S3 buckets containing
|
|
335
|
-
* training data, recognizer metadata, metrics, and so on.</p>
|
|
233
|
+
* @see {@link DescribeEntityRecognizerCommand}
|
|
336
234
|
*/
|
|
337
235
|
describeEntityRecognizer(args: DescribeEntityRecognizerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEntityRecognizerCommandOutput>;
|
|
338
236
|
describeEntityRecognizer(args: DescribeEntityRecognizerCommandInput, cb: (err: any, data?: DescribeEntityRecognizerCommandOutput) => void): void;
|
|
339
237
|
describeEntityRecognizer(args: DescribeEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityRecognizerCommandOutput) => void): void;
|
|
340
238
|
/**
|
|
341
|
-
* @
|
|
342
|
-
* <p>Gets the status and details of an events detection job.</p>
|
|
239
|
+
* @see {@link DescribeEventsDetectionJobCommand}
|
|
343
240
|
*/
|
|
344
241
|
describeEventsDetectionJob(args: DescribeEventsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsDetectionJobCommandOutput>;
|
|
345
242
|
describeEventsDetectionJob(args: DescribeEventsDetectionJobCommandInput, cb: (err: any, data?: DescribeEventsDetectionJobCommandOutput) => void): void;
|
|
346
243
|
describeEventsDetectionJob(args: DescribeEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsDetectionJobCommandOutput) => void): void;
|
|
347
244
|
/**
|
|
348
|
-
* @
|
|
349
|
-
* <p>Provides configuration information about the flywheel. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
350
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
245
|
+
* @see {@link DescribeFlywheelCommand}
|
|
351
246
|
*/
|
|
352
247
|
describeFlywheel(args: DescribeFlywheelCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFlywheelCommandOutput>;
|
|
353
248
|
describeFlywheel(args: DescribeFlywheelCommandInput, cb: (err: any, data?: DescribeFlywheelCommandOutput) => void): void;
|
|
354
249
|
describeFlywheel(args: DescribeFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlywheelCommandOutput) => void): void;
|
|
355
250
|
/**
|
|
356
|
-
* @
|
|
357
|
-
* <p>Retrieve the configuration properties of a flywheel iteration.
|
|
358
|
-
* For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
359
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
251
|
+
* @see {@link DescribeFlywheelIterationCommand}
|
|
360
252
|
*/
|
|
361
253
|
describeFlywheelIteration(args: DescribeFlywheelIterationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFlywheelIterationCommandOutput>;
|
|
362
254
|
describeFlywheelIteration(args: DescribeFlywheelIterationCommandInput, cb: (err: any, data?: DescribeFlywheelIterationCommandOutput) => void): void;
|
|
363
255
|
describeFlywheelIteration(args: DescribeFlywheelIterationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlywheelIterationCommandOutput) => void): void;
|
|
364
256
|
/**
|
|
365
|
-
* @
|
|
366
|
-
* <p>Gets the properties associated with a key phrases detection job. Use this operation to get
|
|
367
|
-
* the status of a detection job.</p>
|
|
257
|
+
* @see {@link DescribeKeyPhrasesDetectionJobCommand}
|
|
368
258
|
*/
|
|
369
259
|
describeKeyPhrasesDetectionJob(args: DescribeKeyPhrasesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeKeyPhrasesDetectionJobCommandOutput>;
|
|
370
260
|
describeKeyPhrasesDetectionJob(args: DescribeKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void): void;
|
|
371
261
|
describeKeyPhrasesDetectionJob(args: DescribeKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void): void;
|
|
372
262
|
/**
|
|
373
|
-
* @
|
|
374
|
-
* <p>Gets the properties associated with a PII entities detection job. For example, you can use
|
|
375
|
-
* this operation to get the job status.</p>
|
|
263
|
+
* @see {@link DescribePiiEntitiesDetectionJobCommand}
|
|
376
264
|
*/
|
|
377
265
|
describePiiEntitiesDetectionJob(args: DescribePiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribePiiEntitiesDetectionJobCommandOutput>;
|
|
378
266
|
describePiiEntitiesDetectionJob(args: DescribePiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void): void;
|
|
379
267
|
describePiiEntitiesDetectionJob(args: DescribePiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void): void;
|
|
380
268
|
/**
|
|
381
|
-
* @
|
|
382
|
-
* <p>Gets the details of a resource-based policy that is attached to a custom model, including
|
|
383
|
-
* the JSON body of the policy.</p>
|
|
269
|
+
* @see {@link DescribeResourcePolicyCommand}
|
|
384
270
|
*/
|
|
385
271
|
describeResourcePolicy(args: DescribeResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DescribeResourcePolicyCommandOutput>;
|
|
386
272
|
describeResourcePolicy(args: DescribeResourcePolicyCommandInput, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void): void;
|
|
387
273
|
describeResourcePolicy(args: DescribeResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void): void;
|
|
388
274
|
/**
|
|
389
|
-
* @
|
|
390
|
-
* <p>Gets the properties associated with a sentiment detection job. Use this operation to get
|
|
391
|
-
* the status of a detection job.</p>
|
|
275
|
+
* @see {@link DescribeSentimentDetectionJobCommand}
|
|
392
276
|
*/
|
|
393
277
|
describeSentimentDetectionJob(args: DescribeSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSentimentDetectionJobCommandOutput>;
|
|
394
278
|
describeSentimentDetectionJob(args: DescribeSentimentDetectionJobCommandInput, cb: (err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void): void;
|
|
395
279
|
describeSentimentDetectionJob(args: DescribeSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void): void;
|
|
396
280
|
/**
|
|
397
|
-
* @
|
|
398
|
-
* <p>Gets the properties associated with a targeted sentiment detection job. Use this operation
|
|
399
|
-
* to get the status of the job.</p>
|
|
281
|
+
* @see {@link DescribeTargetedSentimentDetectionJobCommand}
|
|
400
282
|
*/
|
|
401
283
|
describeTargetedSentimentDetectionJob(args: DescribeTargetedSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTargetedSentimentDetectionJobCommandOutput>;
|
|
402
284
|
describeTargetedSentimentDetectionJob(args: DescribeTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void): void;
|
|
403
285
|
describeTargetedSentimentDetectionJob(args: DescribeTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void): void;
|
|
404
286
|
/**
|
|
405
|
-
* @
|
|
406
|
-
* <p>Gets the properties associated with a topic detection job. Use this operation to get
|
|
407
|
-
* the status of a detection job.</p>
|
|
287
|
+
* @see {@link DescribeTopicsDetectionJobCommand}
|
|
408
288
|
*/
|
|
409
289
|
describeTopicsDetectionJob(args: DescribeTopicsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTopicsDetectionJobCommandOutput>;
|
|
410
290
|
describeTopicsDetectionJob(args: DescribeTopicsDetectionJobCommandInput, cb: (err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void): void;
|
|
411
291
|
describeTopicsDetectionJob(args: DescribeTopicsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void): void;
|
|
412
292
|
/**
|
|
413
|
-
* @
|
|
414
|
-
* <p>Determines the dominant language of the input text. For a list of languages that Amazon
|
|
415
|
-
* Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>. </p>
|
|
293
|
+
* @see {@link DetectDominantLanguageCommand}
|
|
416
294
|
*/
|
|
417
295
|
detectDominantLanguage(args: DetectDominantLanguageCommandInput, options?: __HttpHandlerOptions): Promise<DetectDominantLanguageCommandOutput>;
|
|
418
296
|
detectDominantLanguage(args: DetectDominantLanguageCommandInput, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void): void;
|
|
419
297
|
detectDominantLanguage(args: DetectDominantLanguageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void): void;
|
|
420
298
|
/**
|
|
421
|
-
* @
|
|
422
|
-
* <p>Detects named entities in input text when you use the pre-trained model.
|
|
423
|
-
* Detects custom entities if you have a custom entity recognition model. </p>
|
|
424
|
-
* <p>
|
|
425
|
-
* When detecting named entities using the pre-trained model, use plain text as the input.
|
|
426
|
-
* For more information about named entities, see
|
|
427
|
-
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide.</p>
|
|
428
|
-
* <p>When you use a custom entity recognition model,
|
|
429
|
-
* you can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
|
|
430
|
-
* <p>If the system detects errors while processing a page in the input document, the API response
|
|
431
|
-
* includes an entry in <code>Errors</code> for each error. </p>
|
|
432
|
-
* <p>If the system detects a document-level error in your input document, the API returns an
|
|
433
|
-
* <code>InvalidRequestException</code> error response.
|
|
434
|
-
* For details about this exception, see
|
|
435
|
-
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html">
|
|
436
|
-
* Errors in semi-structured documents</a> in the Comprehend Developer Guide.
|
|
437
|
-
* </p>
|
|
299
|
+
* @see {@link DetectEntitiesCommand}
|
|
438
300
|
*/
|
|
439
301
|
detectEntities(args: DetectEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<DetectEntitiesCommandOutput>;
|
|
440
302
|
detectEntities(args: DetectEntitiesCommandInput, cb: (err: any, data?: DetectEntitiesCommandOutput) => void): void;
|
|
441
303
|
detectEntities(args: DetectEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectEntitiesCommandOutput) => void): void;
|
|
442
304
|
/**
|
|
443
|
-
* @
|
|
444
|
-
* <p>Detects the key noun phrases found in the text. </p>
|
|
305
|
+
* @see {@link DetectKeyPhrasesCommand}
|
|
445
306
|
*/
|
|
446
307
|
detectKeyPhrases(args: DetectKeyPhrasesCommandInput, options?: __HttpHandlerOptions): Promise<DetectKeyPhrasesCommandOutput>;
|
|
447
308
|
detectKeyPhrases(args: DetectKeyPhrasesCommandInput, cb: (err: any, data?: DetectKeyPhrasesCommandOutput) => void): void;
|
|
448
309
|
detectKeyPhrases(args: DetectKeyPhrasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectKeyPhrasesCommandOutput) => void): void;
|
|
449
310
|
/**
|
|
450
|
-
* @
|
|
451
|
-
* <p>Inspects the input text for entities that contain personally identifiable information
|
|
452
|
-
* (PII) and returns information about them.</p>
|
|
311
|
+
* @see {@link DetectPiiEntitiesCommand}
|
|
453
312
|
*/
|
|
454
313
|
detectPiiEntities(args: DetectPiiEntitiesCommandInput, options?: __HttpHandlerOptions): Promise<DetectPiiEntitiesCommandOutput>;
|
|
455
314
|
detectPiiEntities(args: DetectPiiEntitiesCommandInput, cb: (err: any, data?: DetectPiiEntitiesCommandOutput) => void): void;
|
|
456
315
|
detectPiiEntities(args: DetectPiiEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectPiiEntitiesCommandOutput) => void): void;
|
|
457
316
|
/**
|
|
458
|
-
* @
|
|
459
|
-
* <p>Inspects text and returns an inference of the prevailing sentiment
|
|
460
|
-
* (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>). </p>
|
|
317
|
+
* @see {@link DetectSentimentCommand}
|
|
461
318
|
*/
|
|
462
319
|
detectSentiment(args: DetectSentimentCommandInput, options?: __HttpHandlerOptions): Promise<DetectSentimentCommandOutput>;
|
|
463
320
|
detectSentiment(args: DetectSentimentCommandInput, cb: (err: any, data?: DetectSentimentCommandOutput) => void): void;
|
|
464
321
|
detectSentiment(args: DetectSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectSentimentCommandOutput) => void): void;
|
|
465
322
|
/**
|
|
466
|
-
* @
|
|
467
|
-
* <p>Inspects text for syntax and the part of speech of words in the document. For more
|
|
468
|
-
* information, see
|
|
469
|
-
* <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide.
|
|
470
|
-
* </p>
|
|
323
|
+
* @see {@link DetectSyntaxCommand}
|
|
471
324
|
*/
|
|
472
325
|
detectSyntax(args: DetectSyntaxCommandInput, options?: __HttpHandlerOptions): Promise<DetectSyntaxCommandOutput>;
|
|
473
326
|
detectSyntax(args: DetectSyntaxCommandInput, cb: (err: any, data?: DetectSyntaxCommandOutput) => void): void;
|
|
474
327
|
detectSyntax(args: DetectSyntaxCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectSyntaxCommandOutput) => void): void;
|
|
475
328
|
/**
|
|
476
|
-
* @
|
|
477
|
-
* <p>Inspects the input text and returns a sentiment analysis for each entity identified in the text.</p>
|
|
478
|
-
* <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
|
|
329
|
+
* @see {@link DetectTargetedSentimentCommand}
|
|
479
330
|
*/
|
|
480
331
|
detectTargetedSentiment(args: DetectTargetedSentimentCommandInput, options?: __HttpHandlerOptions): Promise<DetectTargetedSentimentCommandOutput>;
|
|
481
332
|
detectTargetedSentiment(args: DetectTargetedSentimentCommandInput, cb: (err: any, data?: DetectTargetedSentimentCommandOutput) => void): void;
|
|
482
333
|
detectTargetedSentiment(args: DetectTargetedSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectTargetedSentimentCommandOutput) => void): void;
|
|
483
334
|
/**
|
|
484
|
-
* @
|
|
485
|
-
* <p>Creates a new custom model that replicates a source custom model that you import. The
|
|
486
|
-
* source model can be in your Amazon Web Services account or another one.</p>
|
|
487
|
-
* <p>If the source model is in another Amazon Web Services account, then it must have a resource-based policy
|
|
488
|
-
* that authorizes you to import it.</p>
|
|
489
|
-
* <p>The source model must be in the same Amazon Web Services Region that you're using when you import. You
|
|
490
|
-
* can't import a model that's in a different Region.</p>
|
|
335
|
+
* @see {@link ImportModelCommand}
|
|
491
336
|
*/
|
|
492
337
|
importModel(args: ImportModelCommandInput, options?: __HttpHandlerOptions): Promise<ImportModelCommandOutput>;
|
|
493
338
|
importModel(args: ImportModelCommandInput, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
|
|
494
339
|
importModel(args: ImportModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
|
|
495
340
|
/**
|
|
496
|
-
* @
|
|
497
|
-
* <p>List the datasets that you have configured in this Region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
498
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
341
|
+
* @see {@link ListDatasetsCommand}
|
|
499
342
|
*/
|
|
500
343
|
listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
|
|
501
344
|
listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
502
345
|
listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
|
|
503
346
|
/**
|
|
504
|
-
* @
|
|
505
|
-
* <p>Gets a list of the documentation classification jobs that you have submitted.</p>
|
|
347
|
+
* @see {@link ListDocumentClassificationJobsCommand}
|
|
506
348
|
*/
|
|
507
349
|
listDocumentClassificationJobs(args: ListDocumentClassificationJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDocumentClassificationJobsCommandOutput>;
|
|
508
350
|
listDocumentClassificationJobs(args: ListDocumentClassificationJobsCommandInput, cb: (err: any, data?: ListDocumentClassificationJobsCommandOutput) => void): void;
|
|
509
351
|
listDocumentClassificationJobs(args: ListDocumentClassificationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassificationJobsCommandOutput) => void): void;
|
|
510
352
|
/**
|
|
511
|
-
* @
|
|
512
|
-
* <p>Gets a list of the document classifiers that you have created.</p>
|
|
353
|
+
* @see {@link ListDocumentClassifiersCommand}
|
|
513
354
|
*/
|
|
514
355
|
listDocumentClassifiers(args: ListDocumentClassifiersCommandInput, options?: __HttpHandlerOptions): Promise<ListDocumentClassifiersCommandOutput>;
|
|
515
356
|
listDocumentClassifiers(args: ListDocumentClassifiersCommandInput, cb: (err: any, data?: ListDocumentClassifiersCommandOutput) => void): void;
|
|
516
357
|
listDocumentClassifiers(args: ListDocumentClassifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassifiersCommandOutput) => void): void;
|
|
517
358
|
/**
|
|
518
|
-
* @
|
|
519
|
-
* <p>Gets a list of summaries of the document classifiers that you have created</p>
|
|
359
|
+
* @see {@link ListDocumentClassifierSummariesCommand}
|
|
520
360
|
*/
|
|
521
361
|
listDocumentClassifierSummaries(args: ListDocumentClassifierSummariesCommandInput, options?: __HttpHandlerOptions): Promise<ListDocumentClassifierSummariesCommandOutput>;
|
|
522
362
|
listDocumentClassifierSummaries(args: ListDocumentClassifierSummariesCommandInput, cb: (err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void): void;
|
|
523
363
|
listDocumentClassifierSummaries(args: ListDocumentClassifierSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void): void;
|
|
524
364
|
/**
|
|
525
|
-
* @
|
|
526
|
-
* <p>Gets a list of the dominant language detection jobs that you have submitted.</p>
|
|
365
|
+
* @see {@link ListDominantLanguageDetectionJobsCommand}
|
|
527
366
|
*/
|
|
528
367
|
listDominantLanguageDetectionJobs(args: ListDominantLanguageDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDominantLanguageDetectionJobsCommandOutput>;
|
|
529
368
|
listDominantLanguageDetectionJobs(args: ListDominantLanguageDetectionJobsCommandInput, cb: (err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void): void;
|
|
530
369
|
listDominantLanguageDetectionJobs(args: ListDominantLanguageDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void): void;
|
|
531
370
|
/**
|
|
532
|
-
* @
|
|
533
|
-
* <p>Gets a list of all existing endpoints that you've created.
|
|
534
|
-
* For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
|
|
371
|
+
* @see {@link ListEndpointsCommand}
|
|
535
372
|
*/
|
|
536
373
|
listEndpoints(args: ListEndpointsCommandInput, options?: __HttpHandlerOptions): Promise<ListEndpointsCommandOutput>;
|
|
537
374
|
listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void;
|
|
538
375
|
listEndpoints(args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void;
|
|
539
376
|
/**
|
|
540
|
-
* @
|
|
541
|
-
* <p>Gets a list of the entity detection jobs that you have submitted.</p>
|
|
377
|
+
* @see {@link ListEntitiesDetectionJobsCommand}
|
|
542
378
|
*/
|
|
543
379
|
listEntitiesDetectionJobs(args: ListEntitiesDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListEntitiesDetectionJobsCommandOutput>;
|
|
544
380
|
listEntitiesDetectionJobs(args: ListEntitiesDetectionJobsCommandInput, cb: (err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void): void;
|
|
545
381
|
listEntitiesDetectionJobs(args: ListEntitiesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void): void;
|
|
546
382
|
/**
|
|
547
|
-
* @
|
|
548
|
-
* <p>Gets a list of the properties of all entity recognizers that you created, including
|
|
549
|
-
* recognizers currently in training. Allows you to filter the list of recognizers based on
|
|
550
|
-
* criteria such as status and submission time. This call returns up to 500 entity recognizers in
|
|
551
|
-
* the list, with a default number of 100 recognizers in the list.</p>
|
|
552
|
-
* <p>The results of this list are not in any particular order. Please get the list and sort
|
|
553
|
-
* locally if needed.</p>
|
|
383
|
+
* @see {@link ListEntityRecognizersCommand}
|
|
554
384
|
*/
|
|
555
385
|
listEntityRecognizers(args: ListEntityRecognizersCommandInput, options?: __HttpHandlerOptions): Promise<ListEntityRecognizersCommandOutput>;
|
|
556
386
|
listEntityRecognizers(args: ListEntityRecognizersCommandInput, cb: (err: any, data?: ListEntityRecognizersCommandOutput) => void): void;
|
|
557
387
|
listEntityRecognizers(args: ListEntityRecognizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityRecognizersCommandOutput) => void): void;
|
|
558
388
|
/**
|
|
559
|
-
* @
|
|
560
|
-
* <p>Gets a list of summaries for the entity recognizers that you have created.</p>
|
|
389
|
+
* @see {@link ListEntityRecognizerSummariesCommand}
|
|
561
390
|
*/
|
|
562
391
|
listEntityRecognizerSummaries(args: ListEntityRecognizerSummariesCommandInput, options?: __HttpHandlerOptions): Promise<ListEntityRecognizerSummariesCommandOutput>;
|
|
563
392
|
listEntityRecognizerSummaries(args: ListEntityRecognizerSummariesCommandInput, cb: (err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void): void;
|
|
564
393
|
listEntityRecognizerSummaries(args: ListEntityRecognizerSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void): void;
|
|
565
394
|
/**
|
|
566
|
-
* @
|
|
567
|
-
* <p>Gets a list of the events detection jobs that you have submitted.</p>
|
|
395
|
+
* @see {@link ListEventsDetectionJobsCommand}
|
|
568
396
|
*/
|
|
569
397
|
listEventsDetectionJobs(args: ListEventsDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListEventsDetectionJobsCommandOutput>;
|
|
570
398
|
listEventsDetectionJobs(args: ListEventsDetectionJobsCommandInput, cb: (err: any, data?: ListEventsDetectionJobsCommandOutput) => void): void;
|
|
571
399
|
listEventsDetectionJobs(args: ListEventsDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventsDetectionJobsCommandOutput) => void): void;
|
|
572
400
|
/**
|
|
573
|
-
* @
|
|
574
|
-
* <p>Information about the history of a flywheel iteration.
|
|
575
|
-
* For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
576
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
401
|
+
* @see {@link ListFlywheelIterationHistoryCommand}
|
|
577
402
|
*/
|
|
578
403
|
listFlywheelIterationHistory(args: ListFlywheelIterationHistoryCommandInput, options?: __HttpHandlerOptions): Promise<ListFlywheelIterationHistoryCommandOutput>;
|
|
579
404
|
listFlywheelIterationHistory(args: ListFlywheelIterationHistoryCommandInput, cb: (err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void): void;
|
|
580
405
|
listFlywheelIterationHistory(args: ListFlywheelIterationHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void): void;
|
|
581
406
|
/**
|
|
582
|
-
* @
|
|
583
|
-
* <p>Gets a list of the flywheels that you have created.</p>
|
|
407
|
+
* @see {@link ListFlywheelsCommand}
|
|
584
408
|
*/
|
|
585
409
|
listFlywheels(args: ListFlywheelsCommandInput, options?: __HttpHandlerOptions): Promise<ListFlywheelsCommandOutput>;
|
|
586
410
|
listFlywheels(args: ListFlywheelsCommandInput, cb: (err: any, data?: ListFlywheelsCommandOutput) => void): void;
|
|
587
411
|
listFlywheels(args: ListFlywheelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlywheelsCommandOutput) => void): void;
|
|
588
412
|
/**
|
|
589
|
-
* @
|
|
590
|
-
* <p>Get a list of key phrase detection jobs that you have submitted.</p>
|
|
413
|
+
* @see {@link ListKeyPhrasesDetectionJobsCommand}
|
|
591
414
|
*/
|
|
592
415
|
listKeyPhrasesDetectionJobs(args: ListKeyPhrasesDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListKeyPhrasesDetectionJobsCommandOutput>;
|
|
593
416
|
listKeyPhrasesDetectionJobs(args: ListKeyPhrasesDetectionJobsCommandInput, cb: (err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void): void;
|
|
594
417
|
listKeyPhrasesDetectionJobs(args: ListKeyPhrasesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void): void;
|
|
595
418
|
/**
|
|
596
|
-
* @
|
|
597
|
-
* <p>Gets a list of the PII entity detection jobs that you have submitted.</p>
|
|
419
|
+
* @see {@link ListPiiEntitiesDetectionJobsCommand}
|
|
598
420
|
*/
|
|
599
421
|
listPiiEntitiesDetectionJobs(args: ListPiiEntitiesDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListPiiEntitiesDetectionJobsCommandOutput>;
|
|
600
422
|
listPiiEntitiesDetectionJobs(args: ListPiiEntitiesDetectionJobsCommandInput, cb: (err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void): void;
|
|
601
423
|
listPiiEntitiesDetectionJobs(args: ListPiiEntitiesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void): void;
|
|
602
424
|
/**
|
|
603
|
-
* @
|
|
604
|
-
* <p>Gets a list of sentiment detection jobs that you have submitted.</p>
|
|
425
|
+
* @see {@link ListSentimentDetectionJobsCommand}
|
|
605
426
|
*/
|
|
606
427
|
listSentimentDetectionJobs(args: ListSentimentDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListSentimentDetectionJobsCommandOutput>;
|
|
607
428
|
listSentimentDetectionJobs(args: ListSentimentDetectionJobsCommandInput, cb: (err: any, data?: ListSentimentDetectionJobsCommandOutput) => void): void;
|
|
608
429
|
listSentimentDetectionJobs(args: ListSentimentDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSentimentDetectionJobsCommandOutput) => void): void;
|
|
609
430
|
/**
|
|
610
|
-
* @
|
|
611
|
-
* <p>Lists all tags associated with a given Amazon Comprehend resource. </p>
|
|
431
|
+
* @see {@link ListTagsForResourceCommand}
|
|
612
432
|
*/
|
|
613
433
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
614
434
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
615
435
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
616
436
|
/**
|
|
617
|
-
* @
|
|
618
|
-
* <p>Gets a list of targeted sentiment detection jobs that you have submitted.</p>
|
|
437
|
+
* @see {@link ListTargetedSentimentDetectionJobsCommand}
|
|
619
438
|
*/
|
|
620
439
|
listTargetedSentimentDetectionJobs(args: ListTargetedSentimentDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListTargetedSentimentDetectionJobsCommandOutput>;
|
|
621
440
|
listTargetedSentimentDetectionJobs(args: ListTargetedSentimentDetectionJobsCommandInput, cb: (err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void): void;
|
|
622
441
|
listTargetedSentimentDetectionJobs(args: ListTargetedSentimentDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void): void;
|
|
623
442
|
/**
|
|
624
|
-
* @
|
|
625
|
-
* <p>Gets a list of the topic detection jobs that you have submitted.</p>
|
|
443
|
+
* @see {@link ListTopicsDetectionJobsCommand}
|
|
626
444
|
*/
|
|
627
445
|
listTopicsDetectionJobs(args: ListTopicsDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListTopicsDetectionJobsCommandOutput>;
|
|
628
446
|
listTopicsDetectionJobs(args: ListTopicsDetectionJobsCommandInput, cb: (err: any, data?: ListTopicsDetectionJobsCommandOutput) => void): void;
|
|
629
447
|
listTopicsDetectionJobs(args: ListTopicsDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicsDetectionJobsCommandOutput) => void): void;
|
|
630
448
|
/**
|
|
631
|
-
* @
|
|
632
|
-
* <p>Attaches a resource-based policy to a custom model. You can use this policy to authorize
|
|
633
|
-
* an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon
|
|
634
|
-
* Comprehend in their account.</p>
|
|
449
|
+
* @see {@link PutResourcePolicyCommand}
|
|
635
450
|
*/
|
|
636
451
|
putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
|
|
637
452
|
putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
|
|
638
453
|
putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
|
|
639
454
|
/**
|
|
640
|
-
* @
|
|
641
|
-
* <p>Starts an asynchronous document classification job. Use the
|
|
642
|
-
* <code>DescribeDocumentClassificationJob</code>
|
|
643
|
-
* operation to track the progress of the job.</p>
|
|
455
|
+
* @see {@link StartDocumentClassificationJobCommand}
|
|
644
456
|
*/
|
|
645
457
|
startDocumentClassificationJob(args: StartDocumentClassificationJobCommandInput, options?: __HttpHandlerOptions): Promise<StartDocumentClassificationJobCommandOutput>;
|
|
646
458
|
startDocumentClassificationJob(args: StartDocumentClassificationJobCommandInput, cb: (err: any, data?: StartDocumentClassificationJobCommandOutput) => void): void;
|
|
647
459
|
startDocumentClassificationJob(args: StartDocumentClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentClassificationJobCommandOutput) => void): void;
|
|
648
460
|
/**
|
|
649
|
-
* @
|
|
650
|
-
* <p>Starts an asynchronous dominant language detection job for a collection of documents. Use
|
|
651
|
-
* the operation to track the status
|
|
652
|
-
* of a job.</p>
|
|
461
|
+
* @see {@link StartDominantLanguageDetectionJobCommand}
|
|
653
462
|
*/
|
|
654
463
|
startDominantLanguageDetectionJob(args: StartDominantLanguageDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartDominantLanguageDetectionJobCommandOutput>;
|
|
655
464
|
startDominantLanguageDetectionJob(args: StartDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void): void;
|
|
656
465
|
startDominantLanguageDetectionJob(args: StartDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void): void;
|
|
657
466
|
/**
|
|
658
|
-
* @
|
|
659
|
-
* <p>Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.</p>
|
|
660
|
-
* <p>This API can be used for either standard entity detection or custom entity recognition. In
|
|
661
|
-
* order to be used for custom entity recognition, the optional <code>EntityRecognizerArn</code>
|
|
662
|
-
* must be used in order to provide access to the recognizer being used to detect the custom
|
|
663
|
-
* entity.</p>
|
|
467
|
+
* @see {@link StartEntitiesDetectionJobCommand}
|
|
664
468
|
*/
|
|
665
469
|
startEntitiesDetectionJob(args: StartEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartEntitiesDetectionJobCommandOutput>;
|
|
666
470
|
startEntitiesDetectionJob(args: StartEntitiesDetectionJobCommandInput, cb: (err: any, data?: StartEntitiesDetectionJobCommandOutput) => void): void;
|
|
667
471
|
startEntitiesDetectionJob(args: StartEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEntitiesDetectionJobCommandOutput) => void): void;
|
|
668
472
|
/**
|
|
669
|
-
* @
|
|
670
|
-
* <p>Starts an asynchronous event detection job for a collection of documents.</p>
|
|
473
|
+
* @see {@link StartEventsDetectionJobCommand}
|
|
671
474
|
*/
|
|
672
475
|
startEventsDetectionJob(args: StartEventsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartEventsDetectionJobCommandOutput>;
|
|
673
476
|
startEventsDetectionJob(args: StartEventsDetectionJobCommandInput, cb: (err: any, data?: StartEventsDetectionJobCommandOutput) => void): void;
|
|
674
477
|
startEventsDetectionJob(args: StartEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEventsDetectionJobCommandOutput) => void): void;
|
|
675
478
|
/**
|
|
676
|
-
* @
|
|
677
|
-
* <p>Start the flywheel iteration.This operation uses any new datasets to train a new model version.
|
|
678
|
-
* For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
|
|
679
|
-
* Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
|
|
479
|
+
* @see {@link StartFlywheelIterationCommand}
|
|
680
480
|
*/
|
|
681
481
|
startFlywheelIteration(args: StartFlywheelIterationCommandInput, options?: __HttpHandlerOptions): Promise<StartFlywheelIterationCommandOutput>;
|
|
682
482
|
startFlywheelIteration(args: StartFlywheelIterationCommandInput, cb: (err: any, data?: StartFlywheelIterationCommandOutput) => void): void;
|
|
683
483
|
startFlywheelIteration(args: StartFlywheelIterationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFlywheelIterationCommandOutput) => void): void;
|
|
684
484
|
/**
|
|
685
|
-
* @
|
|
686
|
-
* <p>Starts an asynchronous key phrase detection job for a collection of documents. Use the
|
|
687
|
-
* operation to track the status of a
|
|
688
|
-
* job.</p>
|
|
485
|
+
* @see {@link StartKeyPhrasesDetectionJobCommand}
|
|
689
486
|
*/
|
|
690
487
|
startKeyPhrasesDetectionJob(args: StartKeyPhrasesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartKeyPhrasesDetectionJobCommandOutput>;
|
|
691
488
|
startKeyPhrasesDetectionJob(args: StartKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void): void;
|
|
692
489
|
startKeyPhrasesDetectionJob(args: StartKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void): void;
|
|
693
490
|
/**
|
|
694
|
-
* @
|
|
695
|
-
* <p>Starts an asynchronous PII entity detection job for a collection of documents.</p>
|
|
491
|
+
* @see {@link StartPiiEntitiesDetectionJobCommand}
|
|
696
492
|
*/
|
|
697
493
|
startPiiEntitiesDetectionJob(args: StartPiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartPiiEntitiesDetectionJobCommandOutput>;
|
|
698
494
|
startPiiEntitiesDetectionJob(args: StartPiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void): void;
|
|
699
495
|
startPiiEntitiesDetectionJob(args: StartPiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void): void;
|
|
700
496
|
/**
|
|
701
|
-
* @
|
|
702
|
-
* <p>Starts an asynchronous sentiment detection job for a collection of documents. Use the
|
|
703
|
-
* operation to track the status of a
|
|
704
|
-
* job.</p>
|
|
497
|
+
* @see {@link StartSentimentDetectionJobCommand}
|
|
705
498
|
*/
|
|
706
499
|
startSentimentDetectionJob(args: StartSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartSentimentDetectionJobCommandOutput>;
|
|
707
500
|
startSentimentDetectionJob(args: StartSentimentDetectionJobCommandInput, cb: (err: any, data?: StartSentimentDetectionJobCommandOutput) => void): void;
|
|
708
501
|
startSentimentDetectionJob(args: StartSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSentimentDetectionJobCommandOutput) => void): void;
|
|
709
502
|
/**
|
|
710
|
-
* @
|
|
711
|
-
* <p>Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
|
|
712
|
-
* <code>DescribeTargetedSentimentDetectionJob</code> operation to track the status of a
|
|
713
|
-
* job.</p>
|
|
503
|
+
* @see {@link StartTargetedSentimentDetectionJobCommand}
|
|
714
504
|
*/
|
|
715
505
|
startTargetedSentimentDetectionJob(args: StartTargetedSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartTargetedSentimentDetectionJobCommandOutput>;
|
|
716
506
|
startTargetedSentimentDetectionJob(args: StartTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void): void;
|
|
717
507
|
startTargetedSentimentDetectionJob(args: StartTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void): void;
|
|
718
508
|
/**
|
|
719
|
-
* @
|
|
720
|
-
* <p>Starts an asynchronous topic detection job. Use the
|
|
721
|
-
* <code>DescribeTopicDetectionJob</code> operation to track the status of a job.</p>
|
|
509
|
+
* @see {@link StartTopicsDetectionJobCommand}
|
|
722
510
|
*/
|
|
723
511
|
startTopicsDetectionJob(args: StartTopicsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartTopicsDetectionJobCommandOutput>;
|
|
724
512
|
startTopicsDetectionJob(args: StartTopicsDetectionJobCommandInput, cb: (err: any, data?: StartTopicsDetectionJobCommandOutput) => void): void;
|
|
725
513
|
startTopicsDetectionJob(args: StartTopicsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTopicsDetectionJobCommandOutput) => void): void;
|
|
726
514
|
/**
|
|
727
|
-
* @
|
|
728
|
-
* <p>Stops a dominant language detection job in progress.</p>
|
|
729
|
-
* <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put
|
|
730
|
-
* into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
|
|
731
|
-
* is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the
|
|
732
|
-
* <code>STOPPED</code> state.</p>
|
|
733
|
-
* <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the
|
|
734
|
-
* <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400
|
|
735
|
-
* Internal Request Exception. </p>
|
|
736
|
-
* <p>When a job is stopped, any documents already processed are written to the output
|
|
737
|
-
* location.</p>
|
|
515
|
+
* @see {@link StopDominantLanguageDetectionJobCommand}
|
|
738
516
|
*/
|
|
739
517
|
stopDominantLanguageDetectionJob(args: StopDominantLanguageDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopDominantLanguageDetectionJobCommandOutput>;
|
|
740
518
|
stopDominantLanguageDetectionJob(args: StopDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void): void;
|
|
741
519
|
stopDominantLanguageDetectionJob(args: StopDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void): void;
|
|
742
520
|
/**
|
|
743
|
-
* @
|
|
744
|
-
* <p>Stops an entities detection job in progress.</p>
|
|
745
|
-
* <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put
|
|
746
|
-
* into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
|
|
747
|
-
* is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the
|
|
748
|
-
* <code>STOPPED</code> state.</p>
|
|
749
|
-
* <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the
|
|
750
|
-
* <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400
|
|
751
|
-
* Internal Request Exception. </p>
|
|
752
|
-
* <p>When a job is stopped, any documents already processed are written to the output
|
|
753
|
-
* location.</p>
|
|
521
|
+
* @see {@link StopEntitiesDetectionJobCommand}
|
|
754
522
|
*/
|
|
755
523
|
stopEntitiesDetectionJob(args: StopEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopEntitiesDetectionJobCommandOutput>;
|
|
756
524
|
stopEntitiesDetectionJob(args: StopEntitiesDetectionJobCommandInput, cb: (err: any, data?: StopEntitiesDetectionJobCommandOutput) => void): void;
|
|
757
525
|
stopEntitiesDetectionJob(args: StopEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEntitiesDetectionJobCommandOutput) => void): void;
|
|
758
526
|
/**
|
|
759
|
-
* @
|
|
760
|
-
* <p>Stops an events detection job in progress.</p>
|
|
527
|
+
* @see {@link StopEventsDetectionJobCommand}
|
|
761
528
|
*/
|
|
762
529
|
stopEventsDetectionJob(args: StopEventsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopEventsDetectionJobCommandOutput>;
|
|
763
530
|
stopEventsDetectionJob(args: StopEventsDetectionJobCommandInput, cb: (err: any, data?: StopEventsDetectionJobCommandOutput) => void): void;
|
|
764
531
|
stopEventsDetectionJob(args: StopEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEventsDetectionJobCommandOutput) => void): void;
|
|
765
532
|
/**
|
|
766
|
-
* @
|
|
767
|
-
* <p>Stops a key phrases detection job in progress.</p>
|
|
768
|
-
* <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put
|
|
769
|
-
* into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
|
|
770
|
-
* is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the
|
|
771
|
-
* <code>STOPPED</code> state.</p>
|
|
772
|
-
* <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the
|
|
773
|
-
* <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400
|
|
774
|
-
* Internal Request Exception. </p>
|
|
775
|
-
* <p>When a job is stopped, any documents already processed are written to the output
|
|
776
|
-
* location.</p>
|
|
533
|
+
* @see {@link StopKeyPhrasesDetectionJobCommand}
|
|
777
534
|
*/
|
|
778
535
|
stopKeyPhrasesDetectionJob(args: StopKeyPhrasesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopKeyPhrasesDetectionJobCommandOutput>;
|
|
779
536
|
stopKeyPhrasesDetectionJob(args: StopKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void): void;
|
|
780
537
|
stopKeyPhrasesDetectionJob(args: StopKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void): void;
|
|
781
538
|
/**
|
|
782
|
-
* @
|
|
783
|
-
* <p>Stops a PII entities detection job in progress.</p>
|
|
539
|
+
* @see {@link StopPiiEntitiesDetectionJobCommand}
|
|
784
540
|
*/
|
|
785
541
|
stopPiiEntitiesDetectionJob(args: StopPiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopPiiEntitiesDetectionJobCommandOutput>;
|
|
786
542
|
stopPiiEntitiesDetectionJob(args: StopPiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void): void;
|
|
787
543
|
stopPiiEntitiesDetectionJob(args: StopPiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void): void;
|
|
788
544
|
/**
|
|
789
|
-
* @
|
|
790
|
-
* <p>Stops a sentiment detection job in progress.</p>
|
|
791
|
-
* <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put
|
|
792
|
-
* into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
|
|
793
|
-
* is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the
|
|
794
|
-
* <code>STOPPED</code> state.</p>
|
|
795
|
-
* <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the
|
|
796
|
-
* <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400
|
|
797
|
-
* Internal Request Exception. </p>
|
|
798
|
-
* <p>When a job is stopped, any documents already processed are written to the output
|
|
799
|
-
* location.</p>
|
|
545
|
+
* @see {@link StopSentimentDetectionJobCommand}
|
|
800
546
|
*/
|
|
801
547
|
stopSentimentDetectionJob(args: StopSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopSentimentDetectionJobCommandOutput>;
|
|
802
548
|
stopSentimentDetectionJob(args: StopSentimentDetectionJobCommandInput, cb: (err: any, data?: StopSentimentDetectionJobCommandOutput) => void): void;
|
|
803
549
|
stopSentimentDetectionJob(args: StopSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSentimentDetectionJobCommandOutput) => void): void;
|
|
804
550
|
/**
|
|
805
|
-
* @
|
|
806
|
-
* <p>Stops a targeted sentiment detection job in progress.</p>
|
|
807
|
-
* <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put
|
|
808
|
-
* into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
|
|
809
|
-
* is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the
|
|
810
|
-
* <code>STOPPED</code> state.</p>
|
|
811
|
-
* <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the
|
|
812
|
-
* <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400
|
|
813
|
-
* Internal Request Exception. </p>
|
|
814
|
-
* <p>When a job is stopped, any documents already processed are written to the output
|
|
815
|
-
* location.</p>
|
|
551
|
+
* @see {@link StopTargetedSentimentDetectionJobCommand}
|
|
816
552
|
*/
|
|
817
553
|
stopTargetedSentimentDetectionJob(args: StopTargetedSentimentDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopTargetedSentimentDetectionJobCommandOutput>;
|
|
818
554
|
stopTargetedSentimentDetectionJob(args: StopTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void): void;
|
|
819
555
|
stopTargetedSentimentDetectionJob(args: StopTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void): void;
|
|
820
556
|
/**
|
|
821
|
-
* @
|
|
822
|
-
* <p>Stops a document classifier training job while in progress.</p>
|
|
823
|
-
* <p>If the training job state is <code>TRAINING</code>, the job is marked for termination and
|
|
824
|
-
* put into the <code>STOP_REQUESTED</code> state. If the training job completes before it can be
|
|
825
|
-
* stopped, it is put into the <code>TRAINED</code>; otherwise the training job is stopped and
|
|
826
|
-
* put into the <code>STOPPED</code> state and the service sends back an HTTP 200 response with
|
|
827
|
-
* an empty HTTP body. </p>
|
|
557
|
+
* @see {@link StopTrainingDocumentClassifierCommand}
|
|
828
558
|
*/
|
|
829
559
|
stopTrainingDocumentClassifier(args: StopTrainingDocumentClassifierCommandInput, options?: __HttpHandlerOptions): Promise<StopTrainingDocumentClassifierCommandOutput>;
|
|
830
560
|
stopTrainingDocumentClassifier(args: StopTrainingDocumentClassifierCommandInput, cb: (err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void): void;
|
|
831
561
|
stopTrainingDocumentClassifier(args: StopTrainingDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void): void;
|
|
832
562
|
/**
|
|
833
|
-
* @
|
|
834
|
-
* <p>Stops an entity recognizer training job while in progress.</p>
|
|
835
|
-
* <p>If the training job state is <code>TRAINING</code>, the job is marked for termination and
|
|
836
|
-
* put into the <code>STOP_REQUESTED</code> state. If the training job completes before it can be
|
|
837
|
-
* stopped, it is put into the <code>TRAINED</code>; otherwise the training job is stopped and
|
|
838
|
-
* putted into the <code>STOPPED</code> state and the service sends back an HTTP 200 response
|
|
839
|
-
* with an empty HTTP body.</p>
|
|
563
|
+
* @see {@link StopTrainingEntityRecognizerCommand}
|
|
840
564
|
*/
|
|
841
565
|
stopTrainingEntityRecognizer(args: StopTrainingEntityRecognizerCommandInput, options?: __HttpHandlerOptions): Promise<StopTrainingEntityRecognizerCommandOutput>;
|
|
842
566
|
stopTrainingEntityRecognizer(args: StopTrainingEntityRecognizerCommandInput, cb: (err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void): void;
|
|
843
567
|
stopTrainingEntityRecognizer(args: StopTrainingEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void): void;
|
|
844
568
|
/**
|
|
845
|
-
* @
|
|
846
|
-
* <p>Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair
|
|
847
|
-
* that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with
|
|
848
|
-
* "Sales" as the key might be added to a resource to indicate its use by the sales department.
|
|
849
|
-
* </p>
|
|
569
|
+
* @see {@link TagResourceCommand}
|
|
850
570
|
*/
|
|
851
571
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
852
572
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
853
573
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
854
574
|
/**
|
|
855
|
-
* @
|
|
856
|
-
* <p>Removes a specific tag associated with an Amazon Comprehend resource. </p>
|
|
575
|
+
* @see {@link UntagResourceCommand}
|
|
857
576
|
*/
|
|
858
577
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
859
578
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
860
579
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
861
580
|
/**
|
|
862
|
-
* @
|
|
863
|
-
* <p>Updates information about the specified endpoint.
|
|
864
|
-
* For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
|
|
581
|
+
* @see {@link UpdateEndpointCommand}
|
|
865
582
|
*/
|
|
866
583
|
updateEndpoint(args: UpdateEndpointCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEndpointCommandOutput>;
|
|
867
584
|
updateEndpoint(args: UpdateEndpointCommandInput, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void;
|
|
868
585
|
updateEndpoint(args: UpdateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void;
|
|
869
586
|
/**
|
|
870
|
-
* @
|
|
871
|
-
* <p>Update the configuration information for an existing flywheel.</p>
|
|
587
|
+
* @see {@link UpdateFlywheelCommand}
|
|
872
588
|
*/
|
|
873
589
|
updateFlywheel(args: UpdateFlywheelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFlywheelCommandOutput>;
|
|
874
590
|
updateFlywheel(args: UpdateFlywheelCommandInput, cb: (err: any, data?: UpdateFlywheelCommandOutput) => void): void;
|
|
875
591
|
updateFlywheel(args: UpdateFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFlywheelCommandOutput) => void): void;
|
|
876
592
|
}
|
|
593
|
+
/**
|
|
594
|
+
* @public
|
|
595
|
+
* <p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
|
|
596
|
+
* Use these actions to determine the topics contained in your documents, the topics they
|
|
597
|
+
* discuss, the predominant sentiment expressed in them, the predominant language used, and
|
|
598
|
+
* more.</p>
|
|
599
|
+
*/
|
|
600
|
+
export declare class Comprehend extends ComprehendClient implements Comprehend {
|
|
601
|
+
}
|