@aws-sdk/client-transcribe 3.234.0 → 3.236.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/endpoint/ruleset.js +4 -409
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-es/endpoint/ruleset.js +4 -409
- package/dist-es/models/models_0.js +2 -0
- package/dist-types/Transcribe.d.ts +82 -82
- package/dist-types/TranscribeClient.d.ts +4 -4
- package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +5 -5
- package/dist-types/commands/CreateLanguageModelCommand.d.ts +6 -6
- package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +3 -3
- package/dist-types/commands/CreateVocabularyCommand.d.ts +3 -3
- package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +3 -3
- package/dist-types/commands/DescribeLanguageModelCommand.d.ts +2 -2
- package/dist-types/commands/GetCallAnalyticsCategoryCommand.d.ts +1 -1
- package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +4 -4
- package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +2 -2
- package/dist-types/commands/GetMedicalVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/GetTranscriptionJobCommand.d.ts +3 -3
- package/dist-types/commands/GetVocabularyCommand.d.ts +2 -2
- package/dist-types/commands/GetVocabularyFilterCommand.d.ts +1 -1
- package/dist-types/commands/ListCallAnalyticsCategoriesCommand.d.ts +1 -1
- package/dist-types/commands/ListCallAnalyticsJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListLanguageModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTranscriptionJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListVocabulariesCommand.d.ts +1 -1
- package/dist-types/commands/ListVocabularyFiltersCommand.d.ts +1 -1
- package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts +11 -11
- package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +11 -11
- package/dist-types/commands/StartTranscriptionJobCommand.d.ts +7 -7
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +386 -384
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +4 -4
|
@@ -9,17 +9,17 @@ export interface CreateMedicalVocabularyCommandOutput extends CreateMedicalVocab
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new custom medical vocabulary.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Before creating a new custom medical vocabulary, you must first upload a text file
|
|
13
13
|
* that contains your new entries, phrases, and terms into an Amazon S3 bucket.
|
|
14
14
|
* Note that this differs from , where you can
|
|
15
15
|
* include a list of terms within your request using the <code>Phrases</code> flag;
|
|
16
16
|
* <code>CreateMedicalVocabulary</code> does not support the <code>Phrases</code>
|
|
17
17
|
* flag.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
19
19
|
* specific language. If you use unsupported characters, your custom vocabulary request
|
|
20
20
|
* 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
|
|
21
21
|
* language.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
|
|
23
23
|
* vocabularies</a>.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,15 +9,15 @@ export interface CreateVocabularyCommandOutput extends CreateVocabularyResponse,
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new custom vocabulary.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>When creating a new custom vocabulary, you can either upload a text file that contains
|
|
13
13
|
* your new entries, phrases, and terms into an Amazon S3 bucket and include the
|
|
14
14
|
* URI in your request. Or you can include a list of terms directly in your request using
|
|
15
15
|
* the <code>Phrases</code> flag.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
17
17
|
* specific language. If you use unsupported characters, your custom vocabulary request
|
|
18
18
|
* 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
|
|
19
19
|
* language.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html">Custom
|
|
21
21
|
* vocabularies</a>.</p>
|
|
22
22
|
* @example
|
|
23
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,14 +9,14 @@ export interface CreateVocabularyFilterCommandOutput extends CreateVocabularyFil
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a new custom vocabulary filter.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You can use custom vocabulary filters to mask, delete, or flag specific words from
|
|
13
13
|
* your transcript. Custom vocabulary filters are commonly used to mask profanity in
|
|
14
14
|
* transcripts.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Each language has a character set that contains all allowed characters for that
|
|
16
16
|
* specific language. If you use unsupported characters, your custom vocabulary filter
|
|
17
17
|
* request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
|
|
18
18
|
* Vocabularies</a> to get the character set for your language.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Vocabulary
|
|
20
20
|
* filtering</a>.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,10 +9,10 @@ export interface DescribeLanguageModelCommandOutput extends DescribeLanguageMode
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified custom language model.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>This operation also shows if the base language model that you used to create your
|
|
13
13
|
* custom language model has been updated. If Amazon Transcribe has updated the base
|
|
14
14
|
* model, you can create a new custom language model using the updated base model.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>If you tried to create a new custom language model and the request wasn't successful,
|
|
16
16
|
* you can use <code>DescribeLanguageModel</code> to help identify the reason for this
|
|
17
17
|
* failure.</p>
|
|
18
18
|
* @example
|
|
@@ -9,7 +9,7 @@ export interface GetCallAnalyticsCategoryCommandOutput extends GetCallAnalyticsC
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified Call Analytics category.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To get a list of your Call Analytics categories, use the operation.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -9,17 +9,17 @@ export interface GetCallAnalyticsJobCommandOutput extends GetCallAnalyticsJobRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified Call Analytics job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
|
|
13
13
|
* is <code>COMPLETED</code>, the job is finished. You can find your completed transcript
|
|
14
14
|
* at the URI specified in <code>TranscriptFileUri</code>. If the status is
|
|
15
15
|
* <code>FAILED</code>, <code>FailureReason</code> provides details on why your
|
|
16
16
|
* transcription job failed.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>If you enabled personally identifiable information (PII) redaction, the redacted
|
|
18
18
|
* transcript appears at the location specified in
|
|
19
19
|
* <code>RedactedTranscriptFileUri</code>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>If you chose to redact the audio in your media file, you can find your redacted media
|
|
21
21
|
* file at the location specified in <code>RedactedMediaFileUri</code>.</p>
|
|
22
|
-
*
|
|
22
|
+
* <p>To get a list of your Call Analytics jobs, use the operation.</p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -9,13 +9,13 @@ export interface GetMedicalTranscriptionJobCommandOutput extends GetMedicalTrans
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified medical transcription job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To view the status of the specified medical transcription job, check the
|
|
13
13
|
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
14
14
|
* the job is finished. You can find the results at the location specified in
|
|
15
15
|
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
16
16
|
* <code>FailureReason</code> provides details on why your transcription job
|
|
17
17
|
* failed.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>To get a list of your medical transcription jobs, use the operation.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -9,11 +9,11 @@ export interface GetMedicalVocabularyCommandOutput extends GetMedicalVocabularyR
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified custom medical vocabulary.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To view the status of the specified custom medical vocabulary, check the
|
|
13
13
|
* <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
|
|
14
14
|
* vocabulary is available to use. If the status is <code>FAILED</code>,
|
|
15
15
|
* <code>FailureReason</code> provides details on why your vocabulary failed.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>To get a list of your custom medical vocabularies, use the operation.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
19
|
* ```javascript
|
|
@@ -9,15 +9,15 @@ export interface GetTranscriptionJobCommandOutput extends GetTranscriptionJobRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified transcription job.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To view the status of the specified transcription job, check the
|
|
13
13
|
* <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
|
|
14
14
|
* the job is finished. You can find the results at the location specified in
|
|
15
15
|
* <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
|
|
16
16
|
* <code>FailureReason</code> provides details on why your transcription job
|
|
17
17
|
* failed.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If you enabled content redaction, the redacted transcript can be found at the location
|
|
19
19
|
* specified in <code>RedactedTranscriptFileUri</code>.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>To get a list of your transcription jobs, use the operation.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
23
|
* ```javascript
|
|
@@ -9,12 +9,12 @@ export interface GetVocabularyCommandOutput extends GetVocabularyResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified custom vocabulary.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To view the status of the specified custom vocabulary, check the
|
|
13
13
|
* <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom
|
|
14
14
|
* vocabulary is available to use. If the status is <code>FAILED</code>,
|
|
15
15
|
* <code>FailureReason</code> provides details on why your custom vocabulary
|
|
16
16
|
* failed.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>To get a list of your custom vocabularies, use the operation.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface GetVocabularyFilterCommandOutput extends GetVocabularyFilterRes
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides information about the specified custom vocabulary filter.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>To get a list of your custom vocabulary filters, use the operation.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface ListCallAnalyticsCategoriesCommandOutput extends ListCallAnalyt
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of Call Analytics categories, including all rules that make up each
|
|
12
12
|
* category.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific Call Analytics category, use the 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
|
|
@@ -10,7 +10,7 @@ export interface ListCallAnalyticsJobsCommandOutput extends ListCallAnalyticsJob
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of Call Analytics jobs that match the specified criteria. If no
|
|
12
12
|
* criteria are specified, all Call Analytics jobs are returned.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific Call Analytics job, use the 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
|
|
@@ -10,7 +10,7 @@ export interface ListLanguageModelsCommandOutput extends ListLanguageModelsRespo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of custom language models that match the specified criteria. If no
|
|
12
12
|
* criteria are specified, all custom language models are returned.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific custom language model, use the 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
|
|
@@ -10,7 +10,7 @@ export interface ListMedicalTranscriptionJobsCommandOutput extends ListMedicalTr
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of medical transcription jobs that match the specified criteria. If no
|
|
12
12
|
* criteria are specified, all medical transcription jobs are returned.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific medical transcription job, use the 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
|
|
@@ -10,7 +10,7 @@ export interface ListMedicalVocabulariesCommandOutput extends ListMedicalVocabul
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of custom medical vocabularies that match the specified criteria. If
|
|
12
12
|
* no criteria are specified, all custom medical vocabularies are returned.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific custom medical vocabulary, use the 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
|
|
@@ -10,7 +10,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Lists all tags associated with the specified transcription job, vocabulary, model, or
|
|
12
12
|
* resource.</p>
|
|
13
|
-
*
|
|
13
|
+
* <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
|
|
14
14
|
* resources</a>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface ListTranscriptionJobsCommandOutput extends ListTranscriptionJob
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of transcription jobs that match the specified criteria. If no
|
|
12
12
|
* criteria are specified, all transcription jobs are returned.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific transcription job, use the 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
|
|
@@ -10,7 +10,7 @@ export interface ListVocabulariesCommandOutput extends ListVocabulariesResponse,
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of custom vocabularies that match the specified criteria. If no
|
|
12
12
|
* criteria are specified, all custom vocabularies are returned.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific custom vocabulary, use the 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
|
|
@@ -10,7 +10,7 @@ export interface ListVocabularyFiltersCommandOutput extends ListVocabularyFilter
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a list of custom vocabulary filters that match the specified criteria. If no
|
|
12
12
|
* criteria are specified, all custom vocabularies are returned.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To get detailed information about a specific custom vocabulary filter, use the 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
|
|
@@ -10,54 +10,54 @@ export interface StartCallAnalyticsJobCommandOutput extends StartCallAnalyticsJo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Transcribes the audio from a customer service call and applies any additional Request
|
|
12
12
|
* Parameters you choose to include in your request.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>In addition to many standard transcription features, Call Analytics provides you with
|
|
14
14
|
* call characteristics, call summarization, speaker sentiment, and optional redaction of
|
|
15
15
|
* your text transcript and your audio file. You can also apply custom categories to flag
|
|
16
16
|
* 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
|
|
17
17
|
* center audio with Call Analytics</a>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>If you want to apply categories to your Call Analytics job, you must create them
|
|
19
19
|
* before submitting your job request. Categories cannot be retroactively applied to a job.
|
|
20
20
|
* To create a new category, use the
|
|
21
21
|
* 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 batch
|
|
22
22
|
* transcriptions</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html">Creating categories for
|
|
23
23
|
* streaming transcriptions</a>.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>To make a <code>StartCallAnalyticsJob</code> request, you must first upload your media
|
|
25
25
|
* file into an Amazon S3 bucket; you can then specify the Amazon S3
|
|
26
26
|
* location of the file using the <code>Media</code> parameter.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>You must include the following parameters in your <code>StartCallAnalyticsJob</code>
|
|
28
28
|
* request:</p>
|
|
29
|
-
*
|
|
29
|
+
* <ul>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>
|
|
32
32
|
* <code>region</code>: The Amazon Web Services Region where you are making your
|
|
33
33
|
* 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
|
|
34
34
|
* quotas</a>.</p>
|
|
35
35
|
* </li>
|
|
36
36
|
* <li>
|
|
37
|
-
*
|
|
37
|
+
* <p>
|
|
38
38
|
* <code>CallAnalyticsJobName</code>: A custom name that you create for your
|
|
39
39
|
* transcription job that's unique within your Amazon Web Services account.</p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
*
|
|
42
|
+
* <p>
|
|
43
43
|
* <code>DataAccessRoleArn</code>: The Amazon Resource Name (ARN) of an IAM role
|
|
44
44
|
* that has permissions to access the Amazon S3 bucket that contains your
|
|
45
45
|
* input files.</p>
|
|
46
46
|
* </li>
|
|
47
47
|
* <li>
|
|
48
|
-
*
|
|
48
|
+
* <p>
|
|
49
49
|
* <code>Media</code> (<code>MediaFileUri</code> or
|
|
50
50
|
* <code>RedactedMediaFileUri</code>): The Amazon S3 location of your
|
|
51
51
|
* media file.</p>
|
|
52
52
|
* </li>
|
|
53
53
|
* </ul>
|
|
54
|
-
*
|
|
54
|
+
* <note>
|
|
55
55
|
* <p>With Call Analytics, you can redact the audio contained in your media file by
|
|
56
56
|
* including <code>RedactedMediaFileUri</code>, instead of <code>MediaFileUri</code>,
|
|
57
57
|
* to specify the location of your input audio. If you choose to redact your audio, you
|
|
58
58
|
* can find your redacted media at the location specified in the
|
|
59
59
|
* <code>RedactedMediaFileUri</code> field of your response.</p>
|
|
60
|
-
*
|
|
60
|
+
* </note>
|
|
61
61
|
* @example
|
|
62
62
|
* Use a bare-bones client and the command you need to make an API call.
|
|
63
63
|
* ```javascript
|
|
@@ -10,49 +10,49 @@ export interface StartMedicalTranscriptionJobCommandOutput extends StartMedicalT
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Transcribes the audio from a medical dictation or conversation and applies any
|
|
12
12
|
* additional Request Parameters you choose to include in your request.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>In addition to many standard transcription features, Amazon Transcribe Medical
|
|
14
14
|
* provides you with a robust medical vocabulary and, optionally, content identification,
|
|
15
15
|
* which adds flags to personal health information (PHI). To learn more about these
|
|
16
16
|
* features, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-it-works-med.html">How Amazon Transcribe Medical
|
|
17
17
|
* works</a>.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>To make a <code>StartMedicalTranscriptionJob</code> request, you must first upload
|
|
19
19
|
* your media file into an Amazon S3 bucket; you can then specify the S3 location
|
|
20
20
|
* of the file using the <code>Media</code> parameter.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>You must include the following parameters in your
|
|
22
22
|
* <code>StartMedicalTranscriptionJob</code> request:</p>
|
|
23
|
-
*
|
|
23
|
+
* <ul>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>
|
|
26
26
|
* <code>region</code>: The Amazon Web Services Region where you are making your
|
|
27
27
|
* 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
|
|
28
28
|
* quotas</a>.</p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>
|
|
32
32
|
* <code>MedicalTranscriptionJobName</code>: A custom name you create for your
|
|
33
33
|
* transcription job that is unique within your Amazon Web Services account.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>
|
|
37
37
|
* <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location
|
|
38
38
|
* of your media file.</p>
|
|
39
39
|
* </li>
|
|
40
40
|
* <li>
|
|
41
|
-
*
|
|
41
|
+
* <p>
|
|
42
42
|
* <code>LanguageCode</code>: This must be <code>en-US</code>.</p>
|
|
43
43
|
* </li>
|
|
44
44
|
* <li>
|
|
45
|
-
*
|
|
45
|
+
* <p>
|
|
46
46
|
* <code>OutputBucketName</code>: The Amazon S3 bucket where you want
|
|
47
47
|
* your transcript stored. If you want your output stored in a sub-folder of this
|
|
48
48
|
* bucket, you must also include <code>OutputKey</code>.</p>
|
|
49
49
|
* </li>
|
|
50
50
|
* <li>
|
|
51
|
-
*
|
|
51
|
+
* <p>
|
|
52
52
|
* <code>Specialty</code>: This must be <code>PRIMARYCARE</code>.</p>
|
|
53
53
|
* </li>
|
|
54
54
|
* <li>
|
|
55
|
-
*
|
|
55
|
+
* <p>
|
|
56
56
|
* <code>Type</code>: Choose whether your audio is a conversation or a
|
|
57
57
|
* dictation.</p>
|
|
58
58
|
* </li>
|
|
@@ -10,30 +10,30 @@ export interface StartTranscriptionJobCommandOutput extends StartTranscriptionJo
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Transcribes the audio from a media file and applies any additional Request Parameters
|
|
12
12
|
* you choose to include in your request.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To make a <code>StartTranscriptionJob</code> request, you must first upload your media
|
|
14
14
|
* file into an Amazon S3 bucket; you can then specify the Amazon S3
|
|
15
15
|
* location of the file using the <code>Media</code> parameter.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>You must include the following parameters in your <code>StartTranscriptionJob</code>
|
|
17
17
|
* request:</p>
|
|
18
|
-
*
|
|
18
|
+
* <ul>
|
|
19
19
|
* <li>
|
|
20
|
-
*
|
|
20
|
+
* <p>
|
|
21
21
|
* <code>region</code>: The Amazon Web Services Region where you are making your
|
|
22
22
|
* 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
|
|
23
23
|
* quotas</a>.</p>
|
|
24
24
|
* </li>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>
|
|
27
27
|
* <code>TranscriptionJobName</code>: A custom name you create for your
|
|
28
28
|
* transcription job that is unique within your Amazon Web Services account.</p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>
|
|
32
32
|
* <code>Media</code> (<code>MediaFileUri</code>): The Amazon S3 location
|
|
33
33
|
* of your media file.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>One of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or
|
|
37
37
|
* <code>IdentifyMultipleLanguages</code>: If you know the language of your
|
|
38
38
|
* media file, specify it using the <code>LanguageCode</code> parameter; you can
|
|
39
39
|
* find all valid language codes in the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported
|
|
@@ -10,7 +10,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
|
|
12
12
|
* resource.</p>
|
|
13
|
-
*
|
|
13
|
+
* <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
|
|
14
14
|
* resources</a>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Removes the specified tags from the specified Amazon Transcribe resource.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you include <code>UntagResource</code> in your request, you must also include
|
|
13
13
|
* <code>ResourceArn</code> and <code>TagKeys</code>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,7 +12,7 @@ export interface UpdateCallAnalyticsCategoryCommandOutput extends UpdateCallAnal
|
|
|
12
12
|
* <code>UpdateCallAnalyticsCategory</code> operation overwrites all existing rules
|
|
13
13
|
* contained in the specified category. You cannot append additional rules onto an existing
|
|
14
14
|
* category.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>To create a new category, see .</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|