@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
|
@@ -165,7 +165,30 @@ declare type TranscribeClientResolvedConfigType = __SmithyResolvedConfiguration<
|
|
|
165
165
|
export interface TranscribeClientResolvedConfig extends TranscribeClientResolvedConfigType {
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
|
-
* <p>
|
|
168
|
+
* <p>Amazon Transcribe offers three main types of batch transcription:
|
|
169
|
+
* <b>Standard</b>, <b>Medical</b>, and
|
|
170
|
+
* <b>Call Analytics</b>.</p>
|
|
171
|
+
* <ul>
|
|
172
|
+
* <li>
|
|
173
|
+
* <p>
|
|
174
|
+
* <b>Standard transcriptions</b> are the most common
|
|
175
|
+
* option. Refer to for details.</p>
|
|
176
|
+
* </li>
|
|
177
|
+
* <li>
|
|
178
|
+
* <p>
|
|
179
|
+
* <b>Medical transcriptions</b> are tailored to medical
|
|
180
|
+
* professionals and incorporate medical terms. A common use case for this service is
|
|
181
|
+
* transcribing doctor-patient dialogue into after-visit notes. Refer to
|
|
182
|
+
* for details.</p>
|
|
183
|
+
* </li>
|
|
184
|
+
* <li>
|
|
185
|
+
* <p>
|
|
186
|
+
* <b>Call Analytics transcriptions</b> are designed for use
|
|
187
|
+
* with call center audio on two different channels; if you're looking for insight into customer
|
|
188
|
+
* service calls, use this option. Refer to for
|
|
189
|
+
* details.</p>
|
|
190
|
+
* </li>
|
|
191
|
+
* </ul>
|
|
169
192
|
*/
|
|
170
193
|
export declare class TranscribeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, TranscribeClientResolvedConfig> {
|
|
171
194
|
/**
|
|
@@ -7,13 +7,31 @@ export interface CreateCallAnalyticsCategoryCommandInput extends CreateCallAnaly
|
|
|
7
7
|
export interface CreateCallAnalyticsCategoryCommandOutput extends CreateCallAnalyticsCategoryResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
10
|
+
* <p>Creates a new Call Analytics category.</p>
|
|
11
|
+
* <p>All categories are automatically applied to your Call Analytics jobs. Note that in order to apply
|
|
12
|
+
* your categories to your jobs, you must create them before submitting your job request, as
|
|
13
|
+
* categories cannot be applied retroactively.</p>
|
|
14
|
+
* <p>Call Analytics categories are composed of rules. For each category, you must create
|
|
15
|
+
* between 1 and 20 rules. Rules can include these parameters: ,
|
|
16
|
+
* , , and
|
|
17
|
+
* .</p>
|
|
18
|
+
* <p>To update an existing category, see .</p>
|
|
19
|
+
* <p>To learn more about:</p>
|
|
20
|
+
* <ul>
|
|
21
|
+
* <li>
|
|
22
|
+
* <p>Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html">Creating categories</a>
|
|
23
|
+
* </p>
|
|
24
|
+
* </li>
|
|
25
|
+
* <li>
|
|
26
|
+
* <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
|
|
27
|
+
* criteria</a> and refer to the data type</p>
|
|
28
|
+
* </li>
|
|
29
|
+
* <li>
|
|
30
|
+
* <p>Call Analytics, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call
|
|
31
|
+
* Analytics</a>
|
|
32
|
+
* </p>
|
|
33
|
+
* </li>
|
|
34
|
+
* </ul>
|
|
17
35
|
* @example
|
|
18
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
37
|
* ```javascript
|
|
@@ -7,11 +7,24 @@ export interface CreateLanguageModelCommandInput extends CreateLanguageModelRequ
|
|
|
7
7
|
export interface CreateLanguageModelCommandOutput extends CreateLanguageModelResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new custom language model
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Creates a new custom language model.</p>
|
|
11
|
+
* <p>When creating a new language model, you must specify:</p>
|
|
12
|
+
* <ul>
|
|
13
|
+
* <li>
|
|
14
|
+
* <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample
|
|
15
|
+
* rates under 16,000 Hz) base model</p>
|
|
16
|
+
* </li>
|
|
17
|
+
* <li>
|
|
18
|
+
* <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
|
|
19
|
+
* </li>
|
|
20
|
+
* <li>
|
|
21
|
+
* <p>The language of your model</p>
|
|
22
|
+
* </li>
|
|
23
|
+
* <li>
|
|
24
|
+
* <p>A unique name for your model</p>
|
|
25
|
+
* </li>
|
|
26
|
+
* </ul>
|
|
27
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
|
|
15
28
|
* @example
|
|
16
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
30
|
* ```javascript
|
|
@@ -8,15 +8,17 @@ export interface CreateMedicalVocabularyCommandOutput extends CreateMedicalVocab
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a new custom medical vocabulary.</p>
|
|
11
|
-
* <p>
|
|
12
|
-
* your new entries, phrases, and terms into an S3 bucket. Note that this differs from
|
|
11
|
+
* <p>Prior to creating a new medical vocabulary, you must first upload a text file that contains
|
|
12
|
+
* your new entries, phrases, and terms into an Amazon S3 bucket. Note that this differs from
|
|
13
13
|
* , where you can include a list of terms within
|
|
14
|
-
* your request using the <code>Phrases</code> flag
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/
|
|
19
|
-
*
|
|
14
|
+
* your request using the <code>Phrases</code> flag; <code>CreateMedicalVocabulary</code>
|
|
15
|
+
* does not support the <code>Phrases</code> flag.</p>
|
|
16
|
+
* <p>Each language has a character set that contains all allowed characters for that specific
|
|
17
|
+
* language. If you use unsupported characters, your vocabulary request fails. Refer to
|
|
18
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
|
|
19
|
+
* Custom Vocabularies</a> to get the character set for your language.</p>
|
|
20
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
|
|
21
|
+
* vocabulary</a>.</p>
|
|
20
22
|
* @example
|
|
21
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
24
|
* ```javascript
|
|
@@ -8,11 +8,14 @@ export interface CreateVocabularyCommandOutput extends CreateVocabularyResponse,
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates a new custom vocabulary.</p>
|
|
11
|
-
* <p>When creating a new
|
|
12
|
-
*
|
|
13
|
-
* terms directly in your request using the <code>Phrases</code> flag.</p>
|
|
14
|
-
* <p>
|
|
15
|
-
*
|
|
11
|
+
* <p>When creating a new vocabulary, you can either upload a text file that contains your new
|
|
12
|
+
* entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request, or
|
|
13
|
+
* you can include a list of terms directly in your request using the <code>Phrases</code> flag.</p>
|
|
14
|
+
* <p>Each language has a character set that contains all allowed characters for that specific
|
|
15
|
+
* language. If you use unsupported characters, your vocabulary request fails. Refer to
|
|
16
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
|
|
17
|
+
* Custom Vocabularies</a> to get the character set for your language.</p>
|
|
18
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
|
|
16
19
|
* vocabulary</a>.</p>
|
|
17
20
|
* @example
|
|
18
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,9 +7,15 @@ export interface CreateVocabularyFilterCommandInput extends CreateVocabularyFilt
|
|
|
7
7
|
export interface CreateVocabularyFilterCommandOutput extends CreateVocabularyFilterResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Creates a new vocabulary filter
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Creates a new custom vocabulary filter.</p>
|
|
11
|
+
* <p>You can use vocabulary filters to mask, delete, or flag specific words from your transcript.
|
|
12
|
+
* Vocabulary filters are commonly used to mask profanity in transcripts.</p>
|
|
13
|
+
* <p>Each language has a character set that contains all allowed characters for that specific
|
|
14
|
+
* language. If you use unsupported characters, your vocabulary filter request fails. Refer to
|
|
15
|
+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
|
|
16
|
+
* Custom Vocabularies</a> to get the character set for your language.</p>
|
|
17
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
|
|
18
|
+
* words</a>.</p>
|
|
13
19
|
* @example
|
|
14
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
21
|
* ```javascript
|
|
@@ -7,8 +7,9 @@ export interface DeleteCallAnalyticsCategoryCommandInput extends DeleteCallAnaly
|
|
|
7
7
|
export interface DeleteCallAnalyticsCategoryCommandOutput extends DeleteCallAnalyticsCategoryResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a
|
|
11
|
-
*
|
|
10
|
+
* <p>Deletes a Call Analytics category. To use this operation, specify the name of the category
|
|
11
|
+
* you want to delete using <code>CategoryName</code>. Category names are case
|
|
12
|
+
* sensitive.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface DeleteCallAnalyticsJobCommandInput extends DeleteCallAnalyticsJ
|
|
|
7
7
|
export interface DeleteCallAnalyticsJobCommandOutput extends DeleteCallAnalyticsJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a
|
|
11
|
-
*
|
|
10
|
+
* <p>Deletes a Call Analytics job. To use this operation, specify the name of the job you want to
|
|
11
|
+
* delete using <code>CallAnalyticsJobName</code>. Job names are case sensitive.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -7,8 +7,9 @@ export interface DeleteLanguageModelCommandInput extends DeleteLanguageModelRequ
|
|
|
7
7
|
export interface DeleteLanguageModelCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a custom language model. To use this operation, specify the name of the
|
|
11
|
-
*
|
|
10
|
+
* <p>Deletes a custom language model. To use this operation, specify the name of the language
|
|
11
|
+
* model you want to delete using <code>ModelName</code>. Language model names are case
|
|
12
|
+
* sensitive.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface DeleteMedicalTranscriptionJobCommandInput extends DeleteMedical
|
|
|
7
7
|
export interface DeleteMedicalTranscriptionJobCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a medical transcription job,
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Deletes a medical transcription job. To use this operation, specify the name of the job you
|
|
11
|
+
* want to delete using <code>MedicalTranscriptionJobName</code>. Job names are case
|
|
12
|
+
* sensitive.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -8,7 +8,8 @@ export interface DeleteMedicalVocabularyCommandOutput extends __MetadataBearer {
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes a custom medical vocabulary. To use this operation, specify the name of the
|
|
11
|
-
* vocabulary you want to delete using <code>VocabularyName</code
|
|
11
|
+
* vocabulary you want to delete using <code>VocabularyName</code>. Vocabulary names are
|
|
12
|
+
* case sensitive.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -7,9 +7,8 @@ export interface DeleteTranscriptionJobCommandInput extends DeleteTranscriptionJ
|
|
|
7
7
|
export interface DeleteTranscriptionJobCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a transcription job,
|
|
11
|
-
*
|
|
12
|
-
* <code>TranscriptionJobName</code>.</p>
|
|
10
|
+
* <p>Deletes a transcription job. To use this operation, specify the name of the job you want to
|
|
11
|
+
* delete using <code>TranscriptionJobName</code>. Job names are case sensitive.</p>
|
|
13
12
|
* @example
|
|
14
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
14
|
* ```javascript
|
|
@@ -7,8 +7,9 @@ export interface DeleteVocabularyCommandInput extends DeleteVocabularyRequest {
|
|
|
7
7
|
export interface DeleteVocabularyCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary
|
|
11
|
-
*
|
|
10
|
+
* <p>Deletes a custom vocabulary. To use this operation, specify the name of the vocabulary you
|
|
11
|
+
* want to delete using <code>VocabularyName</code>. Vocabulary names are case
|
|
12
|
+
* sensitive.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -7,8 +7,9 @@ export interface DeleteVocabularyFilterCommandInput extends DeleteVocabularyFilt
|
|
|
7
7
|
export interface DeleteVocabularyFilterCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary
|
|
11
|
-
*
|
|
10
|
+
* <p>Deletes a vocabulary filter. To use this operation, specify the name of the vocabulary filter
|
|
11
|
+
* you want to delete using <code>VocabularyFilterName</code>. Vocabulary filter names are
|
|
12
|
+
* case sensitive.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -7,13 +7,15 @@ export interface DescribeLanguageModelCommandInput extends DescribeLanguageModel
|
|
|
7
7
|
export interface DescribeLanguageModelCommandOutput extends DescribeLanguageModelResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Provides information about
|
|
11
|
-
* Amazon Web Services account.</p>
|
|
10
|
+
* <p>Provides information about the specified custom language model.</p>
|
|
12
11
|
* <p>This operation also shows if the base language model you used to create your custom
|
|
13
|
-
* language model has been updated. If Amazon Transcribe has updated the base model, you
|
|
14
|
-
* new custom language model using the updated base model.</p>
|
|
12
|
+
* language model has been updated. If Amazon Transcribe has updated the base model, you
|
|
13
|
+
* can create a new custom language model using the updated base model.</p>
|
|
15
14
|
* <p>If you tried to create a new custom language model and the request wasn't successful,
|
|
16
|
-
* you can use
|
|
15
|
+
* you can use <code>DescribeLanguageModel</code> to help identify the reason for this
|
|
16
|
+
* failure.</p>
|
|
17
|
+
* <p>To get a list of your custom language models, use the
|
|
18
|
+
* operation.</p>
|
|
17
19
|
* @example
|
|
18
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
21
|
* ```javascript
|
|
@@ -7,7 +7,9 @@ export interface GetCallAnalyticsCategoryCommandInput extends GetCallAnalyticsCa
|
|
|
7
7
|
export interface GetCallAnalyticsCategoryCommandOutput extends GetCallAnalyticsCategoryResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Provides information about the specified Call Analytics category.</p>
|
|
11
|
+
* <p>To get a list of your Call Analytics categories, use the
|
|
12
|
+
* operation.</p>
|
|
11
13
|
* @example
|
|
12
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
15
|
* ```javascript
|
|
@@ -7,12 +7,17 @@ export interface GetCallAnalyticsJobCommandInput extends GetCallAnalyticsJobRequ
|
|
|
7
7
|
export interface GetCallAnalyticsJobCommandOutput extends GetCallAnalyticsJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
* <p>To view the job's status, refer to
|
|
12
|
-
*
|
|
13
|
-
* the URI specified in
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* <p>Provides information about the specified Call Analytics job.</p>
|
|
11
|
+
* <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status is
|
|
12
|
+
* <code>COMPLETED</code>, the job is finished. You can find your completed transcript at
|
|
13
|
+
* the URI specified in <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
14
|
+
* <code>FailureReason</code> provides details on why your transcription job failed.</p>
|
|
15
|
+
* <p>If you enabled personally identifiable information (PII) redaction, the redacted transcript
|
|
16
|
+
* appears at the location specified in <code>RedactedTranscriptFileUri</code>.</p>
|
|
17
|
+
* <p>If you chose to redact the audio in your media file, you can find your redacted media file
|
|
18
|
+
* at the location specified in <code>RedactedMediaFileUri</code>.</p>
|
|
19
|
+
* <p>To get a list of your Call Analytics jobs, use the
|
|
20
|
+
* operation.</p>
|
|
16
21
|
* @example
|
|
17
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
23
|
* ```javascript
|
|
@@ -7,10 +7,14 @@ export interface GetMedicalTranscriptionJobCommandInput extends GetMedicalTransc
|
|
|
7
7
|
export interface GetMedicalTranscriptionJobCommandOutput extends GetMedicalTranscriptionJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
* <p>To view the
|
|
12
|
-
* status is <code>COMPLETED</code>, the
|
|
13
|
-
*
|
|
10
|
+
* <p>Provides information about the specified medical transcription job.</p>
|
|
11
|
+
* <p>To view the status of the specified medical transcription job, check the
|
|
12
|
+
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the
|
|
13
|
+
* job is finished and you can find the results at the location specified in
|
|
14
|
+
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
15
|
+
* <code>FailureReason</code> provides details on why your transcription job failed.</p>
|
|
16
|
+
* <p>To get a list of your medical transcription jobs, use the
|
|
17
|
+
* operation.</p>
|
|
14
18
|
* @example
|
|
15
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
20
|
* ```javascript
|
|
@@ -7,7 +7,13 @@ export interface GetMedicalVocabularyCommandInput extends GetMedicalVocabularyRe
|
|
|
7
7
|
export interface GetMedicalVocabularyCommandOutput extends GetMedicalVocabularyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Provides information about the specified custom medical vocabulary.</p>
|
|
11
|
+
* <p>To view the status of the specified medical vocabulary, check the
|
|
12
|
+
* <code>VocabularyState</code> field. If the status is <code>READY</code>, your vocabulary
|
|
13
|
+
* is available to use. If the status is <code>FAILED</code>, <code>FailureReason</code> provides
|
|
14
|
+
* details on why your vocabulary failed.</p>
|
|
15
|
+
* <p>To get a list of your custom medical vocabularies, use the
|
|
16
|
+
* operation.</p>
|
|
11
17
|
* @example
|
|
12
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
19
|
* ```javascript
|
|
@@ -7,11 +7,16 @@ export interface GetTranscriptionJobCommandInput extends GetTranscriptionJobRequ
|
|
|
7
7
|
export interface GetTranscriptionJobCommandOutput extends GetTranscriptionJobResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Provides information about the specified transcription job.</p>
|
|
11
|
+
* <p>To view the status of the specified transcription job, check the
|
|
12
|
+
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the
|
|
13
|
+
* job is finished and you can find the results at the location specified in
|
|
14
|
+
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
15
|
+
* <code>FailureReason</code> provides details on why your transcription job failed.</p>
|
|
16
|
+
* <p>If you enabled content redaction, the redacted transcript
|
|
17
|
+
* can be found at the location specified in <code>RedactedTranscriptFileUri</code>.</p>
|
|
18
|
+
* <p>To get a list of your transcription jobs, use the
|
|
19
|
+
* operation.</p>
|
|
15
20
|
* @example
|
|
16
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
22
|
* ```javascript
|
|
@@ -7,7 +7,13 @@ export interface GetVocabularyCommandInput extends GetVocabularyRequest {
|
|
|
7
7
|
export interface GetVocabularyCommandOutput extends GetVocabularyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Provides information about the specified custom vocabulary.</p>
|
|
11
|
+
* <p>To view the status of the specified vocabulary, check the <code>VocabularyState</code>
|
|
12
|
+
* field. If the status is <code>READY</code>, your vocabulary is available to use. If the status
|
|
13
|
+
* is <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
14
|
+
* vocabulary failed.</p>
|
|
15
|
+
* <p>To get a list of your custom vocabularies, use the
|
|
16
|
+
* operation.</p>
|
|
11
17
|
* @example
|
|
12
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
19
|
* ```javascript
|
|
@@ -7,7 +7,13 @@ export interface GetVocabularyFilterCommandInput extends GetVocabularyFilterRequ
|
|
|
7
7
|
export interface GetVocabularyFilterCommandOutput extends GetVocabularyFilterResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Provides information about the specified custom vocabulary filter.</p>
|
|
11
|
+
* <p>To view the status of the specified vocabulary filter, check the <code>VocabularyState</code>
|
|
12
|
+
* field. If the status is <code>READY</code>, your vocabulary is available to use. If the status is
|
|
13
|
+
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your vocabulary
|
|
14
|
+
* filter failed.</p>
|
|
15
|
+
* <p>To get a list of your custom vocabulary filters, use the
|
|
16
|
+
* operation.</p>
|
|
11
17
|
* @example
|
|
12
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
19
|
* ```javascript
|
|
@@ -7,10 +7,9 @@ export interface ListCallAnalyticsCategoriesCommandInput extends ListCallAnalyti
|
|
|
7
7
|
export interface ListCallAnalyticsCategoriesCommandOutput extends ListCallAnalyticsCategoriesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Provides
|
|
11
|
-
*
|
|
12
|
-
* operation
|
|
13
|
-
* it.</p>
|
|
10
|
+
* <p>Provides a list of Call Analytics categories, including all rules that make up each category.</p>
|
|
11
|
+
* <p>To get detailed information about a specific Call Analytics category, use the
|
|
12
|
+
* operation.</p>
|
|
14
13
|
* @example
|
|
15
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
15
|
* ```javascript
|
|
@@ -7,7 +7,10 @@ export interface ListCallAnalyticsJobsCommandInput extends ListCallAnalyticsJobs
|
|
|
7
7
|
export interface ListCallAnalyticsJobsCommandOutput extends ListCallAnalyticsJobsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Provides a list of Call Analytics jobs that match the specified criteria. If no criteria are
|
|
11
|
+
* specified, all Call Analytics jobs are returned.</p>
|
|
12
|
+
* <p>To get detailed information about a specific Call Analytics job, use the
|
|
13
|
+
* operation.</p>
|
|
11
14
|
* @example
|
|
12
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
16
|
* ```javascript
|
|
@@ -7,10 +7,10 @@ export interface ListLanguageModelsCommandInput extends ListLanguageModelsReques
|
|
|
7
7
|
export interface ListLanguageModelsCommandOutput extends ListLanguageModelsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Provides
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
10
|
+
* <p>Provides a list of custom language models that match the specified criteria. If no criteria
|
|
11
|
+
* are specified, all language models are returned.</p>
|
|
12
|
+
* <p>To get detailed information about a specific custom language model, use the
|
|
13
|
+
* operation.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -7,8 +7,10 @@ export interface ListMedicalTranscriptionJobsCommandInput extends ListMedicalTra
|
|
|
7
7
|
export interface ListMedicalTranscriptionJobsCommandOutput extends ListMedicalTranscriptionJobsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
10
|
+
* <p>Provides a list of medical transcription jobs that match the specified criteria. If no criteria are
|
|
11
|
+
* specified, all medical transcription jobs are returned.</p>
|
|
12
|
+
* <p>To get detailed information about a specific medical transcription job, use the
|
|
13
|
+
* operation.</p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
16
|
* ```javascript
|
|
@@ -7,8 +7,10 @@ export interface ListMedicalVocabulariesCommandInput extends ListMedicalVocabula
|
|
|
7
7
|
export interface ListMedicalVocabulariesCommandOutput extends ListMedicalVocabulariesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
10
|
+
* <p>Provides a list of custom medical vocabularies that match the specified criteria. If no
|
|
11
|
+
* criteria are specified, all custom medical vocabularies are returned.</p>
|
|
12
|
+
* <p>To get detailed information about a specific custom medical vocabulary, use the
|
|
13
|
+
* operation.</p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
16
|
* ```javascript
|
|
@@ -7,7 +7,9 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
|
|
|
7
7
|
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Lists all tags associated with
|
|
10
|
+
* <p>Lists all tags associated with the specified transcription job, vocabulary, model, or
|
|
11
|
+
* resource.</p>
|
|
12
|
+
* <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>
|
|
11
13
|
* @example
|
|
12
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
15
|
* ```javascript
|
|
@@ -7,7 +7,10 @@ export interface ListTranscriptionJobsCommandInput extends ListTranscriptionJobs
|
|
|
7
7
|
export interface ListTranscriptionJobsCommandOutput extends ListTranscriptionJobsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Provides a list of transcription jobs that match the specified criteria. If no criteria are
|
|
11
|
+
* specified, all transcription jobs are returned.</p>
|
|
12
|
+
* <p>To get detailed information about a specific transcription job, use the
|
|
13
|
+
* operation.</p>
|
|
11
14
|
* @example
|
|
12
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
16
|
* ```javascript
|
|
@@ -7,8 +7,10 @@ export interface ListVocabulariesCommandInput extends ListVocabulariesRequest {
|
|
|
7
7
|
export interface ListVocabulariesCommandOutput extends ListVocabulariesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
10
|
+
* <p>Provides a list of custom vocabularies that match the specified criteria. If no criteria are
|
|
11
|
+
* specified, all custom vocabularies are returned.</p>
|
|
12
|
+
* <p>To get detailed information about a specific custom vocabulary, use the
|
|
13
|
+
* operation.</p>
|
|
12
14
|
* @example
|
|
13
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
16
|
* ```javascript
|
|
@@ -7,7 +7,10 @@ export interface ListVocabularyFiltersCommandInput extends ListVocabularyFilters
|
|
|
7
7
|
export interface ListVocabularyFiltersCommandOutput extends ListVocabularyFiltersResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>Provides a list of custom vocabulary filters that match the specified criteria. If no
|
|
11
|
+
* criteria are specified, all custom vocabularies are returned.</p>
|
|
12
|
+
* <p>To get detailed information about a specific custom vocabulary filter, use the
|
|
13
|
+
* operation.</p>
|
|
11
14
|
* @example
|
|
12
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
16
|
* ```javascript
|