@aws-sdk/client-transcribe 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/Transcribe.js +43 -546
- package/dist-cjs/protocols/Aws_json1_1.js +383 -1405
- package/dist-es/Transcribe.js +43 -546
- package/dist-es/protocols/Aws_json1_1.js +385 -1407
- package/dist-types/Transcribe.d.ts +68 -395
- package/dist-types/ts3.4/Transcribe.d.ts +4 -1
- package/package.json +6 -6
|
@@ -39,593 +39,266 @@ import { UpdateMedicalVocabularyCommandInput, UpdateMedicalVocabularyCommandOutp
|
|
|
39
39
|
import { UpdateVocabularyCommandInput, UpdateVocabularyCommandOutput } from "./commands/UpdateVocabularyCommand";
|
|
40
40
|
import { UpdateVocabularyFilterCommandInput, UpdateVocabularyFilterCommandOutput } from "./commands/UpdateVocabularyFilterCommand";
|
|
41
41
|
import { TranscribeClient } from "./TranscribeClient";
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
* <b>Call Analytics</b>.</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>
|
|
49
|
-
* <b>Standard transcriptions</b> are the most common
|
|
50
|
-
* option. Refer to for details.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <b>Medical transcriptions</b> are tailored to
|
|
55
|
-
* medical professionals and incorporate medical terms. A common use case for this
|
|
56
|
-
* service is transcribing doctor-patient dialogue into after-visit notes. Refer to
|
|
57
|
-
* for details.</p>
|
|
58
|
-
* </li>
|
|
59
|
-
* <li>
|
|
60
|
-
* <p>
|
|
61
|
-
* <b>Call Analytics transcriptions</b> are designed
|
|
62
|
-
* for use with call center audio on two different channels; if you're looking for
|
|
63
|
-
* insight into customer service calls, use this option. Refer to for details.</p>
|
|
64
|
-
* </li>
|
|
65
|
-
* </ul>
|
|
66
|
-
*/
|
|
67
|
-
export declare class Transcribe extends TranscribeClient {
|
|
68
|
-
/**
|
|
69
|
-
* @public
|
|
70
|
-
* <p>Creates a new Call Analytics category.</p>
|
|
71
|
-
* <p>All categories are automatically applied to your Call Analytics transcriptions. Note that in
|
|
72
|
-
* order to apply categories to your transcriptions, you must create them before submitting your
|
|
73
|
-
* transcription request, as categories cannot be applied retroactively.</p>
|
|
74
|
-
* <p>When creating a new category, you can use the <code>InputType</code> parameter to
|
|
75
|
-
* label the category as a <code>POST_CALL</code> or a <code>REAL_TIME</code> category.
|
|
76
|
-
* <code>POST_CALL</code> categories can only be applied to post-call transcriptions and
|
|
77
|
-
* <code>REAL_TIME</code> categories can only be applied to real-time transcriptions. If you
|
|
78
|
-
* do not include <code>InputType</code>, your category is created as a
|
|
79
|
-
* <code>POST_CALL</code> category by default.</p>
|
|
80
|
-
* <p>Call Analytics categories are composed of rules. For each category, you must create
|
|
81
|
-
* between 1 and 20 rules. Rules can include these parameters: , , , and .</p>
|
|
82
|
-
* <p>To update an existing category, see .</p>
|
|
83
|
-
* <p>To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for post-call
|
|
84
|
-
* transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
|
|
85
|
-
* real-time transcriptions</a>.</p>
|
|
42
|
+
export interface Transcribe {
|
|
43
|
+
/**
|
|
44
|
+
* @see {@link CreateCallAnalyticsCategoryCommand}
|
|
86
45
|
*/
|
|
87
46
|
createCallAnalyticsCategory(args: CreateCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions): Promise<CreateCallAnalyticsCategoryCommandOutput>;
|
|
88
47
|
createCallAnalyticsCategory(args: CreateCallAnalyticsCategoryCommandInput, cb: (err: any, data?: CreateCallAnalyticsCategoryCommandOutput) => void): void;
|
|
89
48
|
createCallAnalyticsCategory(args: CreateCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCallAnalyticsCategoryCommandOutput) => void): void;
|
|
90
49
|
/**
|
|
91
|
-
* @
|
|
92
|
-
* <p>Creates a new custom language model.</p>
|
|
93
|
-
* <p>When creating a new custom language model, you must specify:</p>
|
|
94
|
-
* <ul>
|
|
95
|
-
* <li>
|
|
96
|
-
* <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband
|
|
97
|
-
* (audio sample rates under 16,000 Hz) base model</p>
|
|
98
|
-
* </li>
|
|
99
|
-
* <li>
|
|
100
|
-
* <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
|
|
101
|
-
* </li>
|
|
102
|
-
* <li>
|
|
103
|
-
* <p>The language of your model</p>
|
|
104
|
-
* </li>
|
|
105
|
-
* <li>
|
|
106
|
-
* <p>A unique name for your model</p>
|
|
107
|
-
* </li>
|
|
108
|
-
* </ul>
|
|
50
|
+
* @see {@link CreateLanguageModelCommand}
|
|
109
51
|
*/
|
|
110
52
|
createLanguageModel(args: CreateLanguageModelCommandInput, options?: __HttpHandlerOptions): Promise<CreateLanguageModelCommandOutput>;
|
|
111
53
|
createLanguageModel(args: CreateLanguageModelCommandInput, cb: (err: any, data?: CreateLanguageModelCommandOutput) => void): void;
|
|
112
54
|
createLanguageModel(args: CreateLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLanguageModelCommandOutput) => void): void;
|
|
113
55
|
/**
|
|
114
|
-
* @
|
|
115
|
-
* <p>Creates a new custom medical vocabulary.</p>
|
|
116
|
-
* <p>Before creating a new custom medical vocabulary, you must first upload a text file
|
|
117
|
-
* that contains your vocabulary table into an Amazon S3 bucket.
|
|
118
|
-
* Note that this differs from , where you can
|
|
119
|
-
* include a list of terms within your request using the <code>Phrases</code> flag;
|
|
120
|
-
* <code>CreateMedicalVocabulary</code> does not support the <code>Phrases</code>
|
|
121
|
-
* flag and only accepts vocabularies in table format.</p>
|
|
122
|
-
* <p>Each language has a character set that contains all allowed characters for that
|
|
123
|
-
* specific language. If you use unsupported characters, your custom vocabulary request
|
|
124
|
-
* fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your
|
|
125
|
-
* language.</p>
|
|
126
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
|
|
127
|
-
* vocabularies</a>.</p>
|
|
56
|
+
* @see {@link CreateMedicalVocabularyCommand}
|
|
128
57
|
*/
|
|
129
58
|
createMedicalVocabulary(args: CreateMedicalVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<CreateMedicalVocabularyCommandOutput>;
|
|
130
59
|
createMedicalVocabulary(args: CreateMedicalVocabularyCommandInput, cb: (err: any, data?: CreateMedicalVocabularyCommandOutput) => void): void;
|
|
131
60
|
createMedicalVocabulary(args: CreateMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMedicalVocabularyCommandOutput) => void): void;
|
|
132
61
|
/**
|
|
133
|
-
* @
|
|
134
|
-
* <p>Creates a new custom vocabulary.</p>
|
|
135
|
-
* <p>When creating a new custom vocabulary, you can either upload a text file that contains
|
|
136
|
-
* your new entries, phrases, and terms into an Amazon S3 bucket and include the
|
|
137
|
-
* URI in your request. Or you can include a list of terms directly in your request using
|
|
138
|
-
* the <code>Phrases</code> flag.</p>
|
|
139
|
-
* <p>Each language has a character set that contains all allowed characters for that
|
|
140
|
-
* specific language. If you use unsupported characters, your custom vocabulary request
|
|
141
|
-
* fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom Vocabularies</a> to get the character set for your
|
|
142
|
-
* language.</p>
|
|
143
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
|
|
144
|
-
* vocabularies</a>.</p>
|
|
62
|
+
* @see {@link CreateVocabularyCommand}
|
|
145
63
|
*/
|
|
146
64
|
createVocabulary(args: CreateVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<CreateVocabularyCommandOutput>;
|
|
147
65
|
createVocabulary(args: CreateVocabularyCommandInput, cb: (err: any, data?: CreateVocabularyCommandOutput) => void): void;
|
|
148
66
|
createVocabulary(args: CreateVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVocabularyCommandOutput) => void): void;
|
|
149
67
|
/**
|
|
150
|
-
* @
|
|
151
|
-
* <p>Creates a new custom vocabulary filter.</p>
|
|
152
|
-
* <p>You can use custom vocabulary filters to mask, delete, or flag specific words from
|
|
153
|
-
* your transcript. Custom vocabulary filters are commonly used to mask profanity in
|
|
154
|
-
* transcripts.</p>
|
|
155
|
-
* <p>Each language has a character set that contains all allowed characters for that
|
|
156
|
-
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
157
|
-
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
158
|
-
* Vocabularies</a> to get the character set for your language.</p>
|
|
159
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Vocabulary
|
|
160
|
-
* filtering</a>.</p>
|
|
68
|
+
* @see {@link CreateVocabularyFilterCommand}
|
|
161
69
|
*/
|
|
162
70
|
createVocabularyFilter(args: CreateVocabularyFilterCommandInput, options?: __HttpHandlerOptions): Promise<CreateVocabularyFilterCommandOutput>;
|
|
163
71
|
createVocabularyFilter(args: CreateVocabularyFilterCommandInput, cb: (err: any, data?: CreateVocabularyFilterCommandOutput) => void): void;
|
|
164
72
|
createVocabularyFilter(args: CreateVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVocabularyFilterCommandOutput) => void): void;
|
|
165
73
|
/**
|
|
166
|
-
* @
|
|
167
|
-
* <p>Deletes a Call Analytics category. To use this operation, specify the name of the
|
|
168
|
-
* category you want to delete using <code>CategoryName</code>. Category names are case
|
|
169
|
-
* sensitive.</p>
|
|
74
|
+
* @see {@link DeleteCallAnalyticsCategoryCommand}
|
|
170
75
|
*/
|
|
171
76
|
deleteCallAnalyticsCategory(args: DeleteCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCallAnalyticsCategoryCommandOutput>;
|
|
172
77
|
deleteCallAnalyticsCategory(args: DeleteCallAnalyticsCategoryCommandInput, cb: (err: any, data?: DeleteCallAnalyticsCategoryCommandOutput) => void): void;
|
|
173
78
|
deleteCallAnalyticsCategory(args: DeleteCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCallAnalyticsCategoryCommandOutput) => void): void;
|
|
174
79
|
/**
|
|
175
|
-
* @
|
|
176
|
-
* <p>Deletes a Call Analytics job. To use this operation, specify the name of the job you
|
|
177
|
-
* want to delete using <code>CallAnalyticsJobName</code>. Job names are case
|
|
178
|
-
* sensitive.</p>
|
|
80
|
+
* @see {@link DeleteCallAnalyticsJobCommand}
|
|
179
81
|
*/
|
|
180
82
|
deleteCallAnalyticsJob(args: DeleteCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCallAnalyticsJobCommandOutput>;
|
|
181
83
|
deleteCallAnalyticsJob(args: DeleteCallAnalyticsJobCommandInput, cb: (err: any, data?: DeleteCallAnalyticsJobCommandOutput) => void): void;
|
|
182
84
|
deleteCallAnalyticsJob(args: DeleteCallAnalyticsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCallAnalyticsJobCommandOutput) => void): void;
|
|
183
85
|
/**
|
|
184
|
-
* @
|
|
185
|
-
* <p>Deletes a custom language model. To use this operation, specify the name of the
|
|
186
|
-
* language model you want to delete using <code>ModelName</code>. custom language model
|
|
187
|
-
* names are case sensitive.</p>
|
|
86
|
+
* @see {@link DeleteLanguageModelCommand}
|
|
188
87
|
*/
|
|
189
88
|
deleteLanguageModel(args: DeleteLanguageModelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLanguageModelCommandOutput>;
|
|
190
89
|
deleteLanguageModel(args: DeleteLanguageModelCommandInput, cb: (err: any, data?: DeleteLanguageModelCommandOutput) => void): void;
|
|
191
90
|
deleteLanguageModel(args: DeleteLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLanguageModelCommandOutput) => void): void;
|
|
192
91
|
/**
|
|
193
|
-
* @
|
|
194
|
-
* <p>Deletes a medical transcription job. To use this operation, specify the name of the
|
|
195
|
-
* job you want to delete using <code>MedicalTranscriptionJobName</code>. Job names are
|
|
196
|
-
* case sensitive.</p>
|
|
92
|
+
* @see {@link DeleteMedicalTranscriptionJobCommand}
|
|
197
93
|
*/
|
|
198
94
|
deleteMedicalTranscriptionJob(args: DeleteMedicalTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMedicalTranscriptionJobCommandOutput>;
|
|
199
95
|
deleteMedicalTranscriptionJob(args: DeleteMedicalTranscriptionJobCommandInput, cb: (err: any, data?: DeleteMedicalTranscriptionJobCommandOutput) => void): void;
|
|
200
96
|
deleteMedicalTranscriptionJob(args: DeleteMedicalTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMedicalTranscriptionJobCommandOutput) => void): void;
|
|
201
97
|
/**
|
|
202
|
-
* @
|
|
203
|
-
* <p>Deletes a custom medical vocabulary. To use this operation, specify the name of the
|
|
204
|
-
* custom vocabulary you want to delete using <code>VocabularyName</code>. Custom
|
|
205
|
-
* vocabulary names are case sensitive.</p>
|
|
98
|
+
* @see {@link DeleteMedicalVocabularyCommand}
|
|
206
99
|
*/
|
|
207
100
|
deleteMedicalVocabulary(args: DeleteMedicalVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMedicalVocabularyCommandOutput>;
|
|
208
101
|
deleteMedicalVocabulary(args: DeleteMedicalVocabularyCommandInput, cb: (err: any, data?: DeleteMedicalVocabularyCommandOutput) => void): void;
|
|
209
102
|
deleteMedicalVocabulary(args: DeleteMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMedicalVocabularyCommandOutput) => void): void;
|
|
210
103
|
/**
|
|
211
|
-
* @
|
|
212
|
-
* <p>Deletes a transcription job. To use this operation, specify the name of the job you
|
|
213
|
-
* want to delete using <code>TranscriptionJobName</code>. Job names are case
|
|
214
|
-
* sensitive.</p>
|
|
104
|
+
* @see {@link DeleteTranscriptionJobCommand}
|
|
215
105
|
*/
|
|
216
106
|
deleteTranscriptionJob(args: DeleteTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTranscriptionJobCommandOutput>;
|
|
217
107
|
deleteTranscriptionJob(args: DeleteTranscriptionJobCommandInput, cb: (err: any, data?: DeleteTranscriptionJobCommandOutput) => void): void;
|
|
218
108
|
deleteTranscriptionJob(args: DeleteTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTranscriptionJobCommandOutput) => void): void;
|
|
219
109
|
/**
|
|
220
|
-
* @
|
|
221
|
-
* <p>Deletes a custom vocabulary. To use this operation, specify the name of the custom
|
|
222
|
-
* vocabulary you want to delete using <code>VocabularyName</code>. Custom vocabulary names
|
|
223
|
-
* are case sensitive.</p>
|
|
110
|
+
* @see {@link DeleteVocabularyCommand}
|
|
224
111
|
*/
|
|
225
112
|
deleteVocabulary(args: DeleteVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVocabularyCommandOutput>;
|
|
226
113
|
deleteVocabulary(args: DeleteVocabularyCommandInput, cb: (err: any, data?: DeleteVocabularyCommandOutput) => void): void;
|
|
227
114
|
deleteVocabulary(args: DeleteVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVocabularyCommandOutput) => void): void;
|
|
228
115
|
/**
|
|
229
|
-
* @
|
|
230
|
-
* <p>Deletes a custom vocabulary filter. To use this operation, specify the name of the
|
|
231
|
-
* custom vocabulary filter you want to delete using <code>VocabularyFilterName</code>.
|
|
232
|
-
* Custom vocabulary filter names are case sensitive.</p>
|
|
116
|
+
* @see {@link DeleteVocabularyFilterCommand}
|
|
233
117
|
*/
|
|
234
118
|
deleteVocabularyFilter(args: DeleteVocabularyFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVocabularyFilterCommandOutput>;
|
|
235
119
|
deleteVocabularyFilter(args: DeleteVocabularyFilterCommandInput, cb: (err: any, data?: DeleteVocabularyFilterCommandOutput) => void): void;
|
|
236
120
|
deleteVocabularyFilter(args: DeleteVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVocabularyFilterCommandOutput) => void): void;
|
|
237
121
|
/**
|
|
238
|
-
* @
|
|
239
|
-
* <p>Provides information about the specified custom language model.</p>
|
|
240
|
-
* <p>This operation also shows if the base language model that you used to create your
|
|
241
|
-
* custom language model has been updated. If Amazon Transcribe has updated the base
|
|
242
|
-
* model, you can create a new custom language model using the updated base model.</p>
|
|
243
|
-
* <p>If you tried to create a new custom language model and the request wasn't successful,
|
|
244
|
-
* you can use <code>DescribeLanguageModel</code> to help identify the reason for this
|
|
245
|
-
* failure.</p>
|
|
122
|
+
* @see {@link DescribeLanguageModelCommand}
|
|
246
123
|
*/
|
|
247
124
|
describeLanguageModel(args: DescribeLanguageModelCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLanguageModelCommandOutput>;
|
|
248
125
|
describeLanguageModel(args: DescribeLanguageModelCommandInput, cb: (err: any, data?: DescribeLanguageModelCommandOutput) => void): void;
|
|
249
126
|
describeLanguageModel(args: DescribeLanguageModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLanguageModelCommandOutput) => void): void;
|
|
250
127
|
/**
|
|
251
|
-
* @
|
|
252
|
-
* <p>Provides information about the specified Call Analytics category.</p>
|
|
253
|
-
* <p>To get a list of your Call Analytics categories, use the operation.</p>
|
|
128
|
+
* @see {@link GetCallAnalyticsCategoryCommand}
|
|
254
129
|
*/
|
|
255
130
|
getCallAnalyticsCategory(args: GetCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions): Promise<GetCallAnalyticsCategoryCommandOutput>;
|
|
256
131
|
getCallAnalyticsCategory(args: GetCallAnalyticsCategoryCommandInput, cb: (err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void): void;
|
|
257
132
|
getCallAnalyticsCategory(args: GetCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallAnalyticsCategoryCommandOutput) => void): void;
|
|
258
133
|
/**
|
|
259
|
-
* @
|
|
260
|
-
* <p>Provides information about the specified Call Analytics job.</p>
|
|
261
|
-
* <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
|
|
262
|
-
* is <code>COMPLETED</code>, the job is finished. You can find your completed transcript
|
|
263
|
-
* at the URI specified in <code>TranscriptFileUri</code>. If the status is
|
|
264
|
-
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
265
|
-
* transcription job failed.</p>
|
|
266
|
-
* <p>If you enabled personally identifiable information (PII) redaction, the redacted
|
|
267
|
-
* transcript appears at the location specified in
|
|
268
|
-
* <code>RedactedTranscriptFileUri</code>.</p>
|
|
269
|
-
* <p>If you chose to redact the audio in your media file, you can find your redacted media
|
|
270
|
-
* file at the location specified in <code>RedactedMediaFileUri</code>.</p>
|
|
271
|
-
* <p>To get a list of your Call Analytics jobs, use the operation.</p>
|
|
134
|
+
* @see {@link GetCallAnalyticsJobCommand}
|
|
272
135
|
*/
|
|
273
136
|
getCallAnalyticsJob(args: GetCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions): Promise<GetCallAnalyticsJobCommandOutput>;
|
|
274
137
|
getCallAnalyticsJob(args: GetCallAnalyticsJobCommandInput, cb: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void): void;
|
|
275
138
|
getCallAnalyticsJob(args: GetCallAnalyticsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCallAnalyticsJobCommandOutput) => void): void;
|
|
276
139
|
/**
|
|
277
|
-
* @
|
|
278
|
-
* <p>Provides information about the specified medical transcription job.</p>
|
|
279
|
-
* <p>To view the status of the specified medical transcription job, check the
|
|
280
|
-
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
281
|
-
* the job is finished. You can find the results at the location specified in
|
|
282
|
-
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
283
|
-
* <code>FailureReason</code> provides details on why your transcription job
|
|
284
|
-
* failed.</p>
|
|
285
|
-
* <p>To get a list of your medical transcription jobs, use the operation.</p>
|
|
140
|
+
* @see {@link GetMedicalTranscriptionJobCommand}
|
|
286
141
|
*/
|
|
287
142
|
getMedicalTranscriptionJob(args: GetMedicalTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<GetMedicalTranscriptionJobCommandOutput>;
|
|
288
143
|
getMedicalTranscriptionJob(args: GetMedicalTranscriptionJobCommandInput, cb: (err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void): void;
|
|
289
144
|
getMedicalTranscriptionJob(args: GetMedicalTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMedicalTranscriptionJobCommandOutput) => void): void;
|
|
290
145
|
/**
|
|
291
|
-
* @
|
|
292
|
-
* <p>Provides information about the specified custom medical vocabulary.</p>
|
|
293
|
-
* <p>To view the status of the specified custom medical vocabulary, check the
|
|
294
|
-
* <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
|
|
295
|
-
* vocabulary is available to use. If the status is <code>FAILED</code>,
|
|
296
|
-
* <code>FailureReason</code> provides details on why your vocabulary failed.</p>
|
|
297
|
-
* <p>To get a list of your custom medical vocabularies, use the operation.</p>
|
|
146
|
+
* @see {@link GetMedicalVocabularyCommand}
|
|
298
147
|
*/
|
|
299
148
|
getMedicalVocabulary(args: GetMedicalVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<GetMedicalVocabularyCommandOutput>;
|
|
300
149
|
getMedicalVocabulary(args: GetMedicalVocabularyCommandInput, cb: (err: any, data?: GetMedicalVocabularyCommandOutput) => void): void;
|
|
301
150
|
getMedicalVocabulary(args: GetMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMedicalVocabularyCommandOutput) => void): void;
|
|
302
151
|
/**
|
|
303
|
-
* @
|
|
304
|
-
* <p>Provides information about the specified transcription job.</p>
|
|
305
|
-
* <p>To view the status of the specified transcription job, check the
|
|
306
|
-
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
307
|
-
* the job is finished. You can find the results at the location specified in
|
|
308
|
-
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
309
|
-
* <code>FailureReason</code> provides details on why your transcription job
|
|
310
|
-
* failed.</p>
|
|
311
|
-
* <p>If you enabled content redaction, the redacted transcript can be found at the location
|
|
312
|
-
* specified in <code>RedactedTranscriptFileUri</code>.</p>
|
|
313
|
-
* <p>To get a list of your transcription jobs, use the operation.</p>
|
|
152
|
+
* @see {@link GetTranscriptionJobCommand}
|
|
314
153
|
*/
|
|
315
154
|
getTranscriptionJob(args: GetTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<GetTranscriptionJobCommandOutput>;
|
|
316
155
|
getTranscriptionJob(args: GetTranscriptionJobCommandInput, cb: (err: any, data?: GetTranscriptionJobCommandOutput) => void): void;
|
|
317
156
|
getTranscriptionJob(args: GetTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTranscriptionJobCommandOutput) => void): void;
|
|
318
157
|
/**
|
|
319
|
-
* @
|
|
320
|
-
* <p>Provides information about the specified custom vocabulary.</p>
|
|
321
|
-
* <p>To view the status of the specified custom vocabulary, check the
|
|
322
|
-
* <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
|
|
323
|
-
* vocabulary is available to use. If the status is <code>FAILED</code>,
|
|
324
|
-
* <code>FailureReason</code> provides details on why your custom vocabulary
|
|
325
|
-
* failed.</p>
|
|
326
|
-
* <p>To get a list of your custom vocabularies, use the operation.</p>
|
|
158
|
+
* @see {@link GetVocabularyCommand}
|
|
327
159
|
*/
|
|
328
160
|
getVocabulary(args: GetVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<GetVocabularyCommandOutput>;
|
|
329
161
|
getVocabulary(args: GetVocabularyCommandInput, cb: (err: any, data?: GetVocabularyCommandOutput) => void): void;
|
|
330
162
|
getVocabulary(args: GetVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVocabularyCommandOutput) => void): void;
|
|
331
163
|
/**
|
|
332
|
-
* @
|
|
333
|
-
* <p>Provides information about the specified custom vocabulary filter.</p>
|
|
334
|
-
* <p>To get a list of your custom vocabulary filters, use the operation.</p>
|
|
164
|
+
* @see {@link GetVocabularyFilterCommand}
|
|
335
165
|
*/
|
|
336
166
|
getVocabularyFilter(args: GetVocabularyFilterCommandInput, options?: __HttpHandlerOptions): Promise<GetVocabularyFilterCommandOutput>;
|
|
337
167
|
getVocabularyFilter(args: GetVocabularyFilterCommandInput, cb: (err: any, data?: GetVocabularyFilterCommandOutput) => void): void;
|
|
338
168
|
getVocabularyFilter(args: GetVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetVocabularyFilterCommandOutput) => void): void;
|
|
339
169
|
/**
|
|
340
|
-
* @
|
|
341
|
-
* <p>Provides a list of Call Analytics categories, including all rules that make up each
|
|
342
|
-
* category.</p>
|
|
343
|
-
* <p>To get detailed information about a specific Call Analytics category, use the operation.</p>
|
|
170
|
+
* @see {@link ListCallAnalyticsCategoriesCommand}
|
|
344
171
|
*/
|
|
345
172
|
listCallAnalyticsCategories(args: ListCallAnalyticsCategoriesCommandInput, options?: __HttpHandlerOptions): Promise<ListCallAnalyticsCategoriesCommandOutput>;
|
|
346
173
|
listCallAnalyticsCategories(args: ListCallAnalyticsCategoriesCommandInput, cb: (err: any, data?: ListCallAnalyticsCategoriesCommandOutput) => void): void;
|
|
347
174
|
listCallAnalyticsCategories(args: ListCallAnalyticsCategoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCallAnalyticsCategoriesCommandOutput) => void): void;
|
|
348
175
|
/**
|
|
349
|
-
* @
|
|
350
|
-
* <p>Provides a list of Call Analytics jobs that match the specified criteria. If no
|
|
351
|
-
* criteria are specified, all Call Analytics jobs are returned.</p>
|
|
352
|
-
* <p>To get detailed information about a specific Call Analytics job, use the operation.</p>
|
|
176
|
+
* @see {@link ListCallAnalyticsJobsCommand}
|
|
353
177
|
*/
|
|
354
178
|
listCallAnalyticsJobs(args: ListCallAnalyticsJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListCallAnalyticsJobsCommandOutput>;
|
|
355
179
|
listCallAnalyticsJobs(args: ListCallAnalyticsJobsCommandInput, cb: (err: any, data?: ListCallAnalyticsJobsCommandOutput) => void): void;
|
|
356
180
|
listCallAnalyticsJobs(args: ListCallAnalyticsJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCallAnalyticsJobsCommandOutput) => void): void;
|
|
357
181
|
/**
|
|
358
|
-
* @
|
|
359
|
-
* <p>Provides a list of custom language models that match the specified criteria. If no
|
|
360
|
-
* criteria are specified, all custom language models are returned.</p>
|
|
361
|
-
* <p>To get detailed information about a specific custom language model, use the operation.</p>
|
|
182
|
+
* @see {@link ListLanguageModelsCommand}
|
|
362
183
|
*/
|
|
363
184
|
listLanguageModels(args: ListLanguageModelsCommandInput, options?: __HttpHandlerOptions): Promise<ListLanguageModelsCommandOutput>;
|
|
364
185
|
listLanguageModels(args: ListLanguageModelsCommandInput, cb: (err: any, data?: ListLanguageModelsCommandOutput) => void): void;
|
|
365
186
|
listLanguageModels(args: ListLanguageModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLanguageModelsCommandOutput) => void): void;
|
|
366
187
|
/**
|
|
367
|
-
* @
|
|
368
|
-
* <p>Provides a list of medical transcription jobs that match the specified criteria. If no
|
|
369
|
-
* criteria are specified, all medical transcription jobs are returned.</p>
|
|
370
|
-
* <p>To get detailed information about a specific medical transcription job, use the operation.</p>
|
|
188
|
+
* @see {@link ListMedicalTranscriptionJobsCommand}
|
|
371
189
|
*/
|
|
372
190
|
listMedicalTranscriptionJobs(args: ListMedicalTranscriptionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListMedicalTranscriptionJobsCommandOutput>;
|
|
373
191
|
listMedicalTranscriptionJobs(args: ListMedicalTranscriptionJobsCommandInput, cb: (err: any, data?: ListMedicalTranscriptionJobsCommandOutput) => void): void;
|
|
374
192
|
listMedicalTranscriptionJobs(args: ListMedicalTranscriptionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMedicalTranscriptionJobsCommandOutput) => void): void;
|
|
375
193
|
/**
|
|
376
|
-
* @
|
|
377
|
-
* <p>Provides a list of custom medical vocabularies that match the specified criteria. If
|
|
378
|
-
* no criteria are specified, all custom medical vocabularies are returned.</p>
|
|
379
|
-
* <p>To get detailed information about a specific custom medical vocabulary, use the operation.</p>
|
|
194
|
+
* @see {@link ListMedicalVocabulariesCommand}
|
|
380
195
|
*/
|
|
381
196
|
listMedicalVocabularies(args: ListMedicalVocabulariesCommandInput, options?: __HttpHandlerOptions): Promise<ListMedicalVocabulariesCommandOutput>;
|
|
382
197
|
listMedicalVocabularies(args: ListMedicalVocabulariesCommandInput, cb: (err: any, data?: ListMedicalVocabulariesCommandOutput) => void): void;
|
|
383
198
|
listMedicalVocabularies(args: ListMedicalVocabulariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMedicalVocabulariesCommandOutput) => void): void;
|
|
384
199
|
/**
|
|
385
|
-
* @
|
|
386
|
-
* <p>Lists all tags associated with the specified transcription job, vocabulary, model, or
|
|
387
|
-
* resource.</p>
|
|
388
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
389
|
-
* resources</a>.</p>
|
|
200
|
+
* @see {@link ListTagsForResourceCommand}
|
|
390
201
|
*/
|
|
391
202
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
392
203
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
393
204
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
394
205
|
/**
|
|
395
|
-
* @
|
|
396
|
-
* <p>Provides a list of transcription jobs that match the specified criteria. If no
|
|
397
|
-
* criteria are specified, all transcription jobs are returned.</p>
|
|
398
|
-
* <p>To get detailed information about a specific transcription job, use the operation.</p>
|
|
206
|
+
* @see {@link ListTranscriptionJobsCommand}
|
|
399
207
|
*/
|
|
400
208
|
listTranscriptionJobs(args: ListTranscriptionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListTranscriptionJobsCommandOutput>;
|
|
401
209
|
listTranscriptionJobs(args: ListTranscriptionJobsCommandInput, cb: (err: any, data?: ListTranscriptionJobsCommandOutput) => void): void;
|
|
402
210
|
listTranscriptionJobs(args: ListTranscriptionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTranscriptionJobsCommandOutput) => void): void;
|
|
403
211
|
/**
|
|
404
|
-
* @
|
|
405
|
-
* <p>Provides a list of custom vocabularies that match the specified criteria. If no
|
|
406
|
-
* criteria are specified, all custom vocabularies are returned.</p>
|
|
407
|
-
* <p>To get detailed information about a specific custom vocabulary, use the operation.</p>
|
|
212
|
+
* @see {@link ListVocabulariesCommand}
|
|
408
213
|
*/
|
|
409
214
|
listVocabularies(args: ListVocabulariesCommandInput, options?: __HttpHandlerOptions): Promise<ListVocabulariesCommandOutput>;
|
|
410
215
|
listVocabularies(args: ListVocabulariesCommandInput, cb: (err: any, data?: ListVocabulariesCommandOutput) => void): void;
|
|
411
216
|
listVocabularies(args: ListVocabulariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVocabulariesCommandOutput) => void): void;
|
|
412
217
|
/**
|
|
413
|
-
* @
|
|
414
|
-
* <p>Provides a list of custom vocabulary filters that match the specified criteria. If no
|
|
415
|
-
* criteria are specified, all custom vocabularies are returned.</p>
|
|
416
|
-
* <p>To get detailed information about a specific custom vocabulary filter, use the operation.</p>
|
|
218
|
+
* @see {@link ListVocabularyFiltersCommand}
|
|
417
219
|
*/
|
|
418
220
|
listVocabularyFilters(args: ListVocabularyFiltersCommandInput, options?: __HttpHandlerOptions): Promise<ListVocabularyFiltersCommandOutput>;
|
|
419
221
|
listVocabularyFilters(args: ListVocabularyFiltersCommandInput, cb: (err: any, data?: ListVocabularyFiltersCommandOutput) => void): void;
|
|
420
222
|
listVocabularyFilters(args: ListVocabularyFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListVocabularyFiltersCommandOutput) => void): void;
|
|
421
223
|
/**
|
|
422
|
-
* @
|
|
423
|
-
* <p>Transcribes the audio from a customer service call and applies any additional Request
|
|
424
|
-
* Parameters you choose to include in your request.</p>
|
|
425
|
-
* <p>In addition to many standard transcription features, Call Analytics provides you with
|
|
426
|
-
* call characteristics, call summarization, speaker sentiment, and optional redaction of
|
|
427
|
-
* your text transcript and your audio file. You can also apply custom categories to flag
|
|
428
|
-
* specified conditions. To learn more about these features and insights, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call
|
|
429
|
-
* center audio with Call Analytics</a>.</p>
|
|
430
|
-
* <p>If you want to apply categories to your Call Analytics job, you must create them
|
|
431
|
-
* before submitting your job request. Categories cannot be retroactively applied to a job.
|
|
432
|
-
* To create a new category, use the
|
|
433
|
-
* operation. To learn more about Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html">Creating categories for post-call
|
|
434
|
-
* transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
|
|
435
|
-
* real-time transcriptions</a>.</p>
|
|
436
|
-
* <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media
|
|
437
|
-
* file into an Amazon S3 bucket; you can then specify the Amazon S3
|
|
438
|
-
* location of the file using the <code>Media</code> parameter.</p>
|
|
439
|
-
* <p>Note that job queuing is enabled by default for Call Analytics jobs.</p>
|
|
440
|
-
* <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>
|
|
441
|
-
* request:</p>
|
|
442
|
-
* <ul>
|
|
443
|
-
* <li>
|
|
444
|
-
* <p>
|
|
445
|
-
* <code>region</code>: The Amazon Web Services Region where you are making your
|
|
446
|
-
* request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and
|
|
447
|
-
* quotas</a>.</p>
|
|
448
|
-
* </li>
|
|
449
|
-
* <li>
|
|
450
|
-
* <p>
|
|
451
|
-
* <code>CallAnalyticsJobName</code>: A custom name that you create for your
|
|
452
|
-
* transcription job that's unique within your Amazon Web Services account.</p>
|
|
453
|
-
* </li>
|
|
454
|
-
* <li>
|
|
455
|
-
* <p>
|
|
456
|
-
* <code>DataAccessRoleArn</code>: The Amazon Resource Name (ARN) of an IAM role
|
|
457
|
-
* that has permissions to access the Amazon S3 bucket that contains your
|
|
458
|
-
* input files.</p>
|
|
459
|
-
* </li>
|
|
460
|
-
* <li>
|
|
461
|
-
* <p>
|
|
462
|
-
* <code>Media</code> (<code>MediaFileUri</code> or
|
|
463
|
-
* <code>RedactedMediaFileUri</code>): The Amazon S3 location of your
|
|
464
|
-
* media file.</p>
|
|
465
|
-
* </li>
|
|
466
|
-
* </ul>
|
|
467
|
-
* <note>
|
|
468
|
-
* <p>With Call Analytics, you can redact the audio contained in your media file by
|
|
469
|
-
* including <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>,
|
|
470
|
-
* to specify the location of your input audio. If you choose to redact your audio, you
|
|
471
|
-
* can find your redacted media at the location specified in the
|
|
472
|
-
* <code>RedactedMediaFileUri</code> field of your response.</p>
|
|
473
|
-
* </note>
|
|
224
|
+
* @see {@link StartCallAnalyticsJobCommand}
|
|
474
225
|
*/
|
|
475
226
|
startCallAnalyticsJob(args: StartCallAnalyticsJobCommandInput, options?: __HttpHandlerOptions): Promise<StartCallAnalyticsJobCommandOutput>;
|
|
476
227
|
startCallAnalyticsJob(args: StartCallAnalyticsJobCommandInput, cb: (err: any, data?: StartCallAnalyticsJobCommandOutput) => void): void;
|
|
477
228
|
startCallAnalyticsJob(args: StartCallAnalyticsJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCallAnalyticsJobCommandOutput) => void): void;
|
|
478
229
|
/**
|
|
479
|
-
* @
|
|
480
|
-
* <p>Transcribes the audio from a medical dictation or conversation and applies any
|
|
481
|
-
* additional Request Parameters you choose to include in your request.</p>
|
|
482
|
-
* <p>In addition to many standard transcription features, Amazon Transcribe Medical
|
|
483
|
-
* provides you with a robust medical vocabulary and, optionally, content identification,
|
|
484
|
-
* which adds flags to personal health information (PHI). To learn more about these
|
|
485
|
-
* features, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html">How Amazon Transcribe Medical
|
|
486
|
-
* works</a>.</p>
|
|
487
|
-
* <p>To make a <code>StartMedicalTranscriptionJob</code> request, you must first upload
|
|
488
|
-
* your media file into an Amazon S3 bucket; you can then specify the S3 location
|
|
489
|
-
* of the file using the <code>Media</code> parameter.</p>
|
|
490
|
-
* <p>You must include the following parameters in your
|
|
491
|
-
* <code>StartMedicalTranscriptionJob</code> request:</p>
|
|
492
|
-
* <ul>
|
|
493
|
-
* <li>
|
|
494
|
-
* <p>
|
|
495
|
-
* <code>region</code>: The Amazon Web Services Region where you are making your
|
|
496
|
-
* request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and
|
|
497
|
-
* quotas</a>.</p>
|
|
498
|
-
* </li>
|
|
499
|
-
* <li>
|
|
500
|
-
* <p>
|
|
501
|
-
* <code>MedicalTranscriptionJobName</code>: A custom name you create for your
|
|
502
|
-
* transcription job that is unique within your Amazon Web Services account.</p>
|
|
503
|
-
* </li>
|
|
504
|
-
* <li>
|
|
505
|
-
* <p>
|
|
506
|
-
* <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location
|
|
507
|
-
* of your media file.</p>
|
|
508
|
-
* </li>
|
|
509
|
-
* <li>
|
|
510
|
-
* <p>
|
|
511
|
-
* <code>LanguageCode</code>: This must be <code>en-US</code>.</p>
|
|
512
|
-
* </li>
|
|
513
|
-
* <li>
|
|
514
|
-
* <p>
|
|
515
|
-
* <code>OutputBucketName</code>: The Amazon S3 bucket where you want
|
|
516
|
-
* your transcript stored. If you want your output stored in a sub-folder of this
|
|
517
|
-
* bucket, you must also include <code>OutputKey</code>.</p>
|
|
518
|
-
* </li>
|
|
519
|
-
* <li>
|
|
520
|
-
* <p>
|
|
521
|
-
* <code>Specialty</code>: This must be <code>PRIMARYCARE</code>.</p>
|
|
522
|
-
* </li>
|
|
523
|
-
* <li>
|
|
524
|
-
* <p>
|
|
525
|
-
* <code>Type</code>: Choose whether your audio is a conversation or a
|
|
526
|
-
* dictation.</p>
|
|
527
|
-
* </li>
|
|
528
|
-
* </ul>
|
|
230
|
+
* @see {@link StartMedicalTranscriptionJobCommand}
|
|
529
231
|
*/
|
|
530
232
|
startMedicalTranscriptionJob(args: StartMedicalTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartMedicalTranscriptionJobCommandOutput>;
|
|
531
233
|
startMedicalTranscriptionJob(args: StartMedicalTranscriptionJobCommandInput, cb: (err: any, data?: StartMedicalTranscriptionJobCommandOutput) => void): void;
|
|
532
234
|
startMedicalTranscriptionJob(args: StartMedicalTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMedicalTranscriptionJobCommandOutput) => void): void;
|
|
533
235
|
/**
|
|
534
|
-
* @
|
|
535
|
-
* <p>Transcribes the audio from a media file and applies any additional Request Parameters
|
|
536
|
-
* you choose to include in your request.</p>
|
|
537
|
-
* <p>To make a <code>StartTranscriptionJob</code> request, you must first upload your media
|
|
538
|
-
* file into an Amazon S3 bucket; you can then specify the Amazon S3
|
|
539
|
-
* location of the file using the <code>Media</code> parameter.</p>
|
|
540
|
-
* <p>You must include the following parameters in your <code>StartTranscriptionJob</code>
|
|
541
|
-
* request:</p>
|
|
542
|
-
* <ul>
|
|
543
|
-
* <li>
|
|
544
|
-
* <p>
|
|
545
|
-
* <code>region</code>: The Amazon Web Services Region where you are making your
|
|
546
|
-
* request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html">Amazon Transcribe endpoints and
|
|
547
|
-
* quotas</a>.</p>
|
|
548
|
-
* </li>
|
|
549
|
-
* <li>
|
|
550
|
-
* <p>
|
|
551
|
-
* <code>TranscriptionJobName</code>: A custom name you create for your
|
|
552
|
-
* transcription job that is unique within your Amazon Web Services account.</p>
|
|
553
|
-
* </li>
|
|
554
|
-
* <li>
|
|
555
|
-
* <p>
|
|
556
|
-
* <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location
|
|
557
|
-
* of your media file.</p>
|
|
558
|
-
* </li>
|
|
559
|
-
* <li>
|
|
560
|
-
* <p>One of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or
|
|
561
|
-
* <code>IdentifyMultipleLanguages</code>: If you know the language of your
|
|
562
|
-
* media file, specify it using the <code>LanguageCode</code> parameter; you can
|
|
563
|
-
* find all valid language codes in the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
564
|
-
* languages</a> table. If you don't know the languages spoken in your
|
|
565
|
-
* media, use either <code>IdentifyLanguage</code> or
|
|
566
|
-
* <code>IdentifyMultipleLanguages</code> and let Amazon Transcribe identify
|
|
567
|
-
* the languages for you.</p>
|
|
568
|
-
* </li>
|
|
569
|
-
* </ul>
|
|
236
|
+
* @see {@link StartTranscriptionJobCommand}
|
|
570
237
|
*/
|
|
571
238
|
startTranscriptionJob(args: StartTranscriptionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartTranscriptionJobCommandOutput>;
|
|
572
239
|
startTranscriptionJob(args: StartTranscriptionJobCommandInput, cb: (err: any, data?: StartTranscriptionJobCommandOutput) => void): void;
|
|
573
240
|
startTranscriptionJob(args: StartTranscriptionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTranscriptionJobCommandOutput) => void): void;
|
|
574
241
|
/**
|
|
575
|
-
* @
|
|
576
|
-
* <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
|
|
577
|
-
* resource.</p>
|
|
578
|
-
* <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
|
|
579
|
-
* resources</a>.</p>
|
|
242
|
+
* @see {@link TagResourceCommand}
|
|
580
243
|
*/
|
|
581
244
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
582
245
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
583
246
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
584
247
|
/**
|
|
585
|
-
* @
|
|
586
|
-
* <p>Removes the specified tags from the specified Amazon Transcribe resource.</p>
|
|
587
|
-
* <p>If you include <code>UntagResource</code> in your request, you must also include
|
|
588
|
-
* <code>ResourceArn</code> and <code>TagKeys</code>.</p>
|
|
248
|
+
* @see {@link UntagResourceCommand}
|
|
589
249
|
*/
|
|
590
250
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
591
251
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
592
252
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
593
253
|
/**
|
|
594
|
-
* @
|
|
595
|
-
* <p>Updates the specified Call Analytics category with new rules. Note that the
|
|
596
|
-
* <code>UpdateCallAnalyticsCategory</code> operation overwrites all existing rules
|
|
597
|
-
* contained in the specified category. You cannot append additional rules onto an existing
|
|
598
|
-
* category.</p>
|
|
599
|
-
* <p>To create a new category, see .</p>
|
|
254
|
+
* @see {@link UpdateCallAnalyticsCategoryCommand}
|
|
600
255
|
*/
|
|
601
256
|
updateCallAnalyticsCategory(args: UpdateCallAnalyticsCategoryCommandInput, options?: __HttpHandlerOptions): Promise<UpdateCallAnalyticsCategoryCommandOutput>;
|
|
602
257
|
updateCallAnalyticsCategory(args: UpdateCallAnalyticsCategoryCommandInput, cb: (err: any, data?: UpdateCallAnalyticsCategoryCommandOutput) => void): void;
|
|
603
258
|
updateCallAnalyticsCategory(args: UpdateCallAnalyticsCategoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCallAnalyticsCategoryCommandOutput) => void): void;
|
|
604
259
|
/**
|
|
605
|
-
* @
|
|
606
|
-
* <p>Updates an existing custom medical vocabulary with new values. This operation
|
|
607
|
-
* overwrites all existing information with your new values; you cannot append new terms
|
|
608
|
-
* onto an existing custom vocabulary.</p>
|
|
260
|
+
* @see {@link UpdateMedicalVocabularyCommand}
|
|
609
261
|
*/
|
|
610
262
|
updateMedicalVocabulary(args: UpdateMedicalVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMedicalVocabularyCommandOutput>;
|
|
611
263
|
updateMedicalVocabulary(args: UpdateMedicalVocabularyCommandInput, cb: (err: any, data?: UpdateMedicalVocabularyCommandOutput) => void): void;
|
|
612
264
|
updateMedicalVocabulary(args: UpdateMedicalVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMedicalVocabularyCommandOutput) => void): void;
|
|
613
265
|
/**
|
|
614
|
-
* @
|
|
615
|
-
* <p>Updates an existing custom vocabulary with new values. This operation overwrites all
|
|
616
|
-
* existing information with your new values; you cannot append new terms onto an existing
|
|
617
|
-
* custom vocabulary.</p>
|
|
266
|
+
* @see {@link UpdateVocabularyCommand}
|
|
618
267
|
*/
|
|
619
268
|
updateVocabulary(args: UpdateVocabularyCommandInput, options?: __HttpHandlerOptions): Promise<UpdateVocabularyCommandOutput>;
|
|
620
269
|
updateVocabulary(args: UpdateVocabularyCommandInput, cb: (err: any, data?: UpdateVocabularyCommandOutput) => void): void;
|
|
621
270
|
updateVocabulary(args: UpdateVocabularyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVocabularyCommandOutput) => void): void;
|
|
622
271
|
/**
|
|
623
|
-
* @
|
|
624
|
-
* <p>Updates an existing custom vocabulary filter with a new list of words. The new list
|
|
625
|
-
* you provide overwrites all previous entries; you cannot append new terms onto an
|
|
626
|
-
* existing custom vocabulary filter.</p>
|
|
272
|
+
* @see {@link UpdateVocabularyFilterCommand}
|
|
627
273
|
*/
|
|
628
274
|
updateVocabularyFilter(args: UpdateVocabularyFilterCommandInput, options?: __HttpHandlerOptions): Promise<UpdateVocabularyFilterCommandOutput>;
|
|
629
275
|
updateVocabularyFilter(args: UpdateVocabularyFilterCommandInput, cb: (err: any, data?: UpdateVocabularyFilterCommandOutput) => void): void;
|
|
630
276
|
updateVocabularyFilter(args: UpdateVocabularyFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVocabularyFilterCommandOutput) => void): void;
|
|
631
277
|
}
|
|
278
|
+
/**
|
|
279
|
+
* @public
|
|
280
|
+
* <p>Amazon Transcribe offers three main types of batch transcription: <b>Standard</b>, <b>Medical</b>, and
|
|
281
|
+
* <b>Call Analytics</b>.</p>
|
|
282
|
+
* <ul>
|
|
283
|
+
* <li>
|
|
284
|
+
* <p>
|
|
285
|
+
* <b>Standard transcriptions</b> are the most common
|
|
286
|
+
* option. Refer to for details.</p>
|
|
287
|
+
* </li>
|
|
288
|
+
* <li>
|
|
289
|
+
* <p>
|
|
290
|
+
* <b>Medical transcriptions</b> are tailored to
|
|
291
|
+
* medical professionals and incorporate medical terms. A common use case for this
|
|
292
|
+
* service is transcribing doctor-patient dialogue into after-visit notes. Refer to
|
|
293
|
+
* for details.</p>
|
|
294
|
+
* </li>
|
|
295
|
+
* <li>
|
|
296
|
+
* <p>
|
|
297
|
+
* <b>Call Analytics transcriptions</b> are designed
|
|
298
|
+
* for use with call center audio on two different channels; if you're looking for
|
|
299
|
+
* insight into customer service calls, use this option. Refer to for details.</p>
|
|
300
|
+
* </li>
|
|
301
|
+
* </ul>
|
|
302
|
+
*/
|
|
303
|
+
export declare class Transcribe extends TranscribeClient implements Transcribe {
|
|
304
|
+
}
|