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