Skip to content

Commit 2c3c3cd

Browse files
author
awstools
committed
feat(client-transcribe): Amazon Transcribe now supports automatic language identification for multi-lingual audio in batch mode.
1 parent d285512 commit 2c3c3cd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+3312
-1850
lines changed

‎clients/client-transcribe/README.md‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,30 @@
99

1010
AWS SDK for JavaScript Transcribe Client for Node.js, Browser and React Native.
1111

12-
<p>Operations and objects for transcribing speech to text.</p>
12+
<p>Amazon Transcribe offers three main types of batch transcription:
13+
<b>Standard</b>, <b>Medical</b>, and
14+
<b>Call Analytics</b>.</p>
15+
<ul>
16+
<li>
17+
<p>
18+
<b>Standard transcriptions</b> are the most common
19+
option. Refer to for details.</p>
20+
</li>
21+
<li>
22+
<p>
23+
<b>Medical transcriptions</b> are tailored to medical
24+
professionals and incorporate medical terms. A common use case for this service is
25+
transcribing doctor-patient dialogue into after-visit notes. Refer to
26+
for details.</p>
27+
</li>
28+
<li>
29+
<p>
30+
<b>Call Analytics transcriptions</b> are designed for use
31+
with call center audio on two different channels; if you're looking for insight into customer
32+
service calls, use this option. Refer to for
33+
details.</p>
34+
</li>
35+
</ul>
1336

1437
## Installing
1538

‎clients/client-transcribe/src/Transcribe.ts‎

Lines changed: 359 additions & 109 deletions
Large diffs are not rendered by default.

‎clients/client-transcribe/src/TranscribeClient.ts‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,30 @@ type TranscribeClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
422422
export interface TranscribeClientResolvedConfig extends TranscribeClientResolvedConfigType {}
423423

424424
/**
425-
* <p>Operations and objects for transcribing speech to text.</p>
425+
* <p>Amazon Transcribe offers three main types of batch transcription:
426+
* <b>Standard</b>, <b>Medical</b>, and
427+
* <b>Call Analytics</b>.</p>
428+
* <ul>
429+
* <li>
430+
* <p>
431+
* <b>Standard transcriptions</b> are the most common
432+
* option. Refer to for details.</p>
433+
* </li>
434+
* <li>
435+
* <p>
436+
* <b>Medical transcriptions</b> are tailored to medical
437+
* professionals and incorporate medical terms. A common use case for this service is
438+
* transcribing doctor-patient dialogue into after-visit notes. Refer to
439+
* for details.</p>
440+
* </li>
441+
* <li>
442+
* <p>
443+
* <b>Call Analytics transcriptions</b> are designed for use
444+
* with call center audio on two different channels; if you're looking for insight into customer
445+
* service calls, use this option. Refer to for
446+
* details.</p>
447+
* </li>
448+
* </ul>
426449
*/
427450
export class TranscribeClient extends __Client<
428451
__HttpHandlerOptions,

‎clients/client-transcribe/src/commands/CreateCallAnalyticsCategoryCommand.ts‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,31 @@ export interface CreateCallAnalyticsCategoryCommandOutput
2525
__MetadataBearer {}
2626

2727
/**
28-
* <p>Creates a call analytics category. Amazon Transcribe applies the conditions specified by your
29-
* call analytics categories to your call analytics jobs. For each analytics category, you
30-
* must create between 1 and 20 rules. For example, you can create a 'greeting'
31-
* category with a rule that flags calls in which your agent does not use a specified
32-
* phrase (for example: "Please note this call may be recorded.") in the first 15 seconds
33-
* of the call. When you start a call analytics job, Amazon Transcribe applies all your existing call
34-
* analytics categories to that job.</p>
28+
* <p>Creates a new Call Analytics category.</p>
29+
* <p>All categories are automatically applied to your Call Analytics jobs. Note that in order to apply
30+
* your categories to your jobs, you must create them before submitting your job request, as
31+
* categories cannot be applied retroactively.</p>
32+
* <p>Call Analytics categories are composed of rules. For each category, you must create
33+
* between 1 and 20 rules. Rules can include these parameters: ,
34+
* , , and
35+
* .</p>
36+
* <p>To update an existing category, see .</p>
37+
* <p>To learn more about:</p>
38+
* <ul>
39+
* <li>
40+
* <p>Call Analytics categories, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html">Creating categories</a>
41+
* </p>
42+
* </li>
43+
* <li>
44+
* <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
45+
* criteria</a> and refer to the data type</p>
46+
* </li>
47+
* <li>
48+
* <p>Call Analytics, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call
49+
* Analytics</a>
50+
* </p>
51+
* </li>
52+
* </ul>
3553
* @example
3654
* Use a bare-bones client and the command you need to make an API call.
3755
* ```javascript

‎clients/client-transcribe/src/commands/CreateLanguageModelCommand.ts‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,24 @@ export interface CreateLanguageModelCommandInput extends CreateLanguageModelRequ
2323
export interface CreateLanguageModelCommandOutput extends CreateLanguageModelResponse, __MetadataBearer {}
2424

2525
/**
26-
* <p>Creates a new custom language model. When creating a new language model,
27-
* you must specify if you want a Wideband (audio sample rates over 16,000 Hz) or
28-
* Narrowband (audio sample rates under 16,000 Hz) base model. You then include the
29-
* S3 URI location of your training and tuning files, the language for the model, a
30-
* unique name, and any tags you want associated with your model.</p>
26+
* <p>Creates a new custom language model.</p>
27+
* <p>When creating a new language model, you must specify:</p>
28+
* <ul>
29+
* <li>
30+
* <p>If you want a Wideband (audio sample rates over 16,000 Hz) or Narrowband (audio sample
31+
* rates under 16,000 Hz) base model</p>
32+
* </li>
33+
* <li>
34+
* <p>The location of your training and tuning files (this must be an Amazon S3 URI)</p>
35+
* </li>
36+
* <li>
37+
* <p>The language of your model</p>
38+
* </li>
39+
* <li>
40+
* <p>A unique name for your model</p>
41+
* </li>
42+
* </ul>
43+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language models</a>.</p>
3144
* @example
3245
* Use a bare-bones client and the command you need to make an API call.
3346
* ```javascript

‎clients/client-transcribe/src/commands/CreateMedicalVocabularyCommand.ts‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,17 @@ export interface CreateMedicalVocabularyCommandOutput extends CreateMedicalVocab
2424

2525
/**
2626
* <p>Creates a new custom medical vocabulary.</p>
27-
* <p>When creating a new medical vocabulary, you must upload a text file that contains
28-
* your new entries, phrases, and terms into an S3 bucket. Note that this differs from
27+
* <p>Prior to creating a new medical vocabulary, you must first upload a text file that contains
28+
* your new entries, phrases, and terms into an Amazon S3 bucket. Note that this differs from
2929
* , where you can include a list of terms within
30-
* your request using the <code>Phrases</code> flag, as
31-
* <code>CreateMedicalVocabulary</code> does not support the <code>Phrases</code>
32-
* flag.</p>
33-
* <p>For more information on creating a custom vocabulary text file, see
34-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
35-
* vocabulary</a>.</p>
30+
* your request using the <code>Phrases</code> flag; <code>CreateMedicalVocabulary</code>
31+
* does not support the <code>Phrases</code> flag.</p>
32+
* <p>Each language has a character set that contains all allowed characters for that specific
33+
* language. If you use unsupported characters, your vocabulary request fails. Refer to
34+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
35+
* Custom Vocabularies</a> to get the character set for your language.</p>
36+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
37+
* vocabulary</a>.</p>
3638
* @example
3739
* Use a bare-bones client and the command you need to make an API call.
3840
* ```javascript

‎clients/client-transcribe/src/commands/CreateVocabularyCommand.ts‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,14 @@ export interface CreateVocabularyCommandOutput extends CreateVocabularyResponse,
2424

2525
/**
2626
* <p>Creates a new custom vocabulary.</p>
27-
* <p>When creating a new medical vocabulary, you can either upload a text file that
28-
* contains your new entries, phrases, and terms into an S3 bucket or include a list of
29-
* terms directly in your request using the <code>Phrases</code> flag.</p>
30-
* <p>For more information on creating a custom vocabulary, see
31-
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
27+
* <p>When creating a new vocabulary, you can either upload a text file that contains your new
28+
* entries, phrases, and terms into an Amazon S3 bucket and include the URI in your request, or
29+
* you can include a list of terms directly in your request using the <code>Phrases</code> flag.</p>
30+
* <p>Each language has a character set that contains all allowed characters for that specific
31+
* language. If you use unsupported characters, your vocabulary request fails. Refer to
32+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
33+
* Custom Vocabularies</a> to get the character set for your language.</p>
34+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary-create.html">Creating a custom
3235
* vocabulary</a>.</p>
3336
* @example
3437
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-transcribe/src/commands/CreateVocabularyFilterCommand.ts‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,15 @@ export interface CreateVocabularyFilterCommandInput extends CreateVocabularyFilt
2323
export interface CreateVocabularyFilterCommandOutput extends CreateVocabularyFilterResponse, __MetadataBearer {}
2424

2525
/**
26-
* <p>Creates a new vocabulary filter that you can use to filter words from your transcription
27-
* output. For example, you can use this operation to remove profanity from your
28-
* transcript.</p>
26+
* <p>Creates a new custom vocabulary filter.</p>
27+
* <p>You can use vocabulary filters to mask, delete, or flag specific words from your transcript.
28+
* Vocabulary filters are commonly used to mask profanity in transcripts.</p>
29+
* <p>Each language has a character set that contains all allowed characters for that specific
30+
* language. If you use unsupported characters, your vocabulary filter request fails. Refer to
31+
* <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for
32+
* Custom Vocabularies</a> to get the character set for your language.</p>
33+
* <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html">Using vocabulary filtering with unwanted
34+
* words</a>.</p>
2935
* @example
3036
* Use a bare-bones client and the command you need to make an API call.
3137
* ```javascript

‎clients/client-transcribe/src/commands/DeleteCallAnalyticsCategoryCommand.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ export interface DeleteCallAnalyticsCategoryCommandOutput
2525
__MetadataBearer {}
2626

2727
/**
28-
* <p>Deletes a call analytics category. To use this operation, specify the name of the
29-
* category you want to delete using <code>CategoryName</code>.</p>
28+
* <p>Deletes a Call Analytics category. To use this operation, specify the name of the category
29+
* you want to delete using <code>CategoryName</code>. Category names are case
30+
* sensitive.</p>
3031
* @example
3132
* Use a bare-bones client and the command you need to make an API call.
3233
* ```javascript

‎clients/client-transcribe/src/commands/DeleteCallAnalyticsJobCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ export interface DeleteCallAnalyticsJobCommandInput extends DeleteCallAnalyticsJ
2323
export interface DeleteCallAnalyticsJobCommandOutput extends DeleteCallAnalyticsJobResponse, __MetadataBearer {}
2424

2525
/**
26-
* <p>Deletes a call analytics job. To use this operation, specify the name of the
27-
* job you want to delete using <code>CallAnalyticsJobName</code>.</p>
26+
* <p>Deletes a Call Analytics job. To use this operation, specify the name of the job you want to
27+
* delete using <code>CallAnalyticsJobName</code>. Job names are case sensitive.</p>
2828
* @example
2929
* Use a bare-bones client and the command you need to make an API call.
3030
* ```javascript

0 commit comments

Comments
 (0)