There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for Amazon Transcribe using AWS SDKs
The following code examples show you how to use Amazon Transcribe with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
*Scenarios* are code examples that show you how to accomplish specific tasks by calling multiple functions within a service or combined with other AWS services.
**More resources**
+ **[ Amazon Transcribe Developer Guide](https://docs.aws.amazon.com/transcribe/latest/dg/what-is.html)** – More information about Amazon Transcribe.
+ **[Amazon Transcribe API Reference](https://docs.aws.amazon.com/transcribe/latest/APIReference/Welcome.html)** – Details about all available Amazon Transcribe actions.
+ **[AWS Developer Center](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23transcribe)** – Code examples that you can filter by category or full-text search.
+ **[AWS SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub repo with complete code in preferred languages. Includes instructions for setting up and running the code.
**Contents**
+ [Basics](transcribe_code_examples_basics.md)
+ [Actions](transcribe_code_examples_actions.md)
+ [`CreateVocabulary`](transcribe_example_transcribe_CreateVocabulary_section.md)
+ [`DeleteMedicalTranscriptionJob`](transcribe_example_transcribe_DeleteMedicalTranscriptionJob_section.md)
+ [`DeleteTranscriptionJob`](transcribe_example_transcribe_DeleteTranscriptionJob_section.md)
+ [`DeleteVocabulary`](transcribe_example_transcribe_DeleteVocabulary_section.md)
+ [`GetTranscriptionJob`](transcribe_example_transcribe_GetTranscriptionJob_section.md)
+ [`GetVocabulary`](transcribe_example_transcribe_GetVocabulary_section.md)
+ [`ListMedicalTranscriptionJobs`](transcribe_example_transcribe_ListMedicalTranscriptionJobs_section.md)
+ [`ListTranscriptionJobs`](transcribe_example_transcribe_ListTranscriptionJobs_section.md)
+ [`ListVocabularies`](transcribe_example_transcribe_ListVocabularies_section.md)
+ [`StartMedicalTranscriptionJob`](transcribe_example_transcribe_StartMedicalTranscriptionJob_section.md)
+ [`StartTranscriptionJob`](transcribe_example_transcribe_StartTranscriptionJob_section.md)
+ [`UpdateVocabulary`](transcribe_example_transcribe_UpdateVocabulary_section.md)
+ [Scenarios](transcribe_code_examples_scenarios.md)
+ [Build an Amazon Transcribe streaming app](transcribe_example_cross_TranscriptionStreamingApp_section.md)
+ [Convert text to speech and back to text](transcribe_example_cross_Telephone_section.md)
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
+ [Transcribe audio and get job data](transcribe_example_transcribe_Scenario_GettingStartedTranscriptionJobs_section.md)
# Basic examples for Amazon Transcribe using AWS SDKs
The following code examples show how to use the basics of Amazon Transcribe with AWS SDKs.
**Contents**
+ [Actions](transcribe_code_examples_actions.md)
+ [`CreateVocabulary`](transcribe_example_transcribe_CreateVocabulary_section.md)
+ [`DeleteMedicalTranscriptionJob`](transcribe_example_transcribe_DeleteMedicalTranscriptionJob_section.md)
+ [`DeleteTranscriptionJob`](transcribe_example_transcribe_DeleteTranscriptionJob_section.md)
+ [`DeleteVocabulary`](transcribe_example_transcribe_DeleteVocabulary_section.md)
+ [`GetTranscriptionJob`](transcribe_example_transcribe_GetTranscriptionJob_section.md)
+ [`GetVocabulary`](transcribe_example_transcribe_GetVocabulary_section.md)
+ [`ListMedicalTranscriptionJobs`](transcribe_example_transcribe_ListMedicalTranscriptionJobs_section.md)
+ [`ListTranscriptionJobs`](transcribe_example_transcribe_ListTranscriptionJobs_section.md)
+ [`ListVocabularies`](transcribe_example_transcribe_ListVocabularies_section.md)
+ [`StartMedicalTranscriptionJob`](transcribe_example_transcribe_StartMedicalTranscriptionJob_section.md)
+ [`StartTranscriptionJob`](transcribe_example_transcribe_StartTranscriptionJob_section.md)
+ [`UpdateVocabulary`](transcribe_example_transcribe_UpdateVocabulary_section.md)
# Actions for Amazon Transcribe using AWS SDKs
The following code examples demonstrate how to perform individual Amazon Transcribe actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
These excerpts call the Amazon Transcribe API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for Amazon Transcribe using AWS SDKs](transcribe_code_examples_scenarios.md).
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Transcribe API Reference](https://docs.aws.amazon.com/transcribe/latest/APIReference/Welcome.html).
**Topics**
+ [`CreateVocabulary`](transcribe_example_transcribe_CreateVocabulary_section.md)
+ [`DeleteMedicalTranscriptionJob`](transcribe_example_transcribe_DeleteMedicalTranscriptionJob_section.md)
+ [`DeleteTranscriptionJob`](transcribe_example_transcribe_DeleteTranscriptionJob_section.md)
+ [`DeleteVocabulary`](transcribe_example_transcribe_DeleteVocabulary_section.md)
+ [`GetTranscriptionJob`](transcribe_example_transcribe_GetTranscriptionJob_section.md)
+ [`GetVocabulary`](transcribe_example_transcribe_GetVocabulary_section.md)
+ [`ListMedicalTranscriptionJobs`](transcribe_example_transcribe_ListMedicalTranscriptionJobs_section.md)
+ [`ListTranscriptionJobs`](transcribe_example_transcribe_ListTranscriptionJobs_section.md)
+ [`ListVocabularies`](transcribe_example_transcribe_ListVocabularies_section.md)
+ [`StartMedicalTranscriptionJob`](transcribe_example_transcribe_StartMedicalTranscriptionJob_section.md)
+ [`StartTranscriptionJob`](transcribe_example_transcribe_StartTranscriptionJob_section.md)
+ [`UpdateVocabulary`](transcribe_example_transcribe_UpdateVocabulary_section.md)
# Use `CreateVocabulary` with an AWS SDK or CLI
The following code examples show how to use `CreateVocabulary`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Create a custom vocabulary using a list of phrases. Custom vocabularies
/// improve transcription accuracy for one or more specific words.
///
/// The language code of the vocabulary.
/// Phrases to use in the vocabulary.
/// Name for the vocabulary.
/// The state of the custom vocabulary.
public async Task CreateCustomVocabulary(LanguageCode languageCode,
List phrases, string vocabularyName)
{
var response = await _amazonTranscribeService.CreateVocabularyAsync(
new CreateVocabularyRequest
{
LanguageCode = languageCode,
Phrases = phrases,
VocabularyName = vocabularyName
});
return response.VocabularyState;
}
```
+ For API details, see [CreateVocabulary](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/CreateVocabulary) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To create a custom vocabulary**
The following `create-vocabulary` example creates a custom vocabulary. To create a custom vocabulary, you must have created a text file with all the terms that you want to transcribe more accurately. For vocabulary-file-uri, specify the Amazon Simple Storage Service (Amazon S3) URI of that text file. For language-code, specify a language code corresponding to the language of your custom vocabulary. For vocabulary-name, specify what you want to call your custom vocabulary.
```
aws transcribe create-vocabulary \
--language-code language-code \
--vocabulary-name cli-vocab-example \
--vocabulary-file-uri s3://amzn-s3-demo-bucket/Amazon-S3-prefix/the-text-file-for-the-custom-vocabulary.txt
```
Output:
```
{
"VocabularyName": "cli-vocab-example",
"LanguageCode": "language-code",
"VocabularyState": "PENDING"
}
```
For more information, see [Custom Vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [CreateVocabulary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/create-vocabulary.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def create_vocabulary(
vocabulary_name, language_code, transcribe_client, phrases=None, table_uri=None
):
"""
Creates a custom vocabulary that can be used to improve the accuracy of
transcription jobs. This function returns as soon as the vocabulary processing
is started. Call get_vocabulary to get the current status of the vocabulary.
The vocabulary is ready to use when its status is 'READY'.
:param vocabulary_name: The name of the custom vocabulary.
:param language_code: The language code of the vocabulary.
For example, en-US or nl-NL.
:param transcribe_client: The Boto3 Transcribe client.
:param phrases: A list of comma-separated phrases to include in the vocabulary.
:param table_uri: A table of phrases and pronunciation hints to include in the
vocabulary.
:return: Information about the newly created vocabulary.
"""
try:
vocab_args = {"VocabularyName": vocabulary_name, "LanguageCode": language_code}
if phrases is not None:
vocab_args["Phrases"] = phrases
elif table_uri is not None:
vocab_args["VocabularyFileUri"] = table_uri
response = transcribe_client.create_vocabulary(**vocab_args)
logger.info("Created custom vocabulary %s.", response["VocabularyName"])
except ClientError:
logger.exception("Couldn't create custom vocabulary %s.", vocabulary_name)
raise
else:
return response
```
+ For API details, see [CreateVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/CreateVocabulary) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
IF it_phrases IS NOT INITIAL.
oo_result = lo_tnb->createvocabulary(
iv_vocabularyname = iv_vocabulary_name
iv_languagecode = iv_language_code
it_phrases = it_phrases ).
ELSEIF iv_vocab_file_uri IS NOT INITIAL.
oo_result = lo_tnb->createvocabulary(
iv_vocabularyname = iv_vocabulary_name
iv_languagecode = iv_language_code
iv_vocabularyfileuri = iv_vocab_file_uri ).
ENDIF.
MESSAGE 'Custom vocabulary created.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnblimitexceededex INTO DATA(lo_limit_ex).
MESSAGE lo_limit_ex TYPE 'I'.
RAISE EXCEPTION lo_limit_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
CATCH /aws1/cx_tnbconflictexception INTO DATA(lo_conflict_ex).
MESSAGE lo_conflict_ex TYPE 'I'.
RAISE EXCEPTION lo_conflict_ex.
ENDTRY.
```
+ For API details, see [CreateVocabulary](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DeleteMedicalTranscriptionJob` with an AWS SDK or CLI
The following code examples show how to use `DeleteMedicalTranscriptionJob`.
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Delete a medical transcription job. Also deletes the transcript associated with the job.
///
/// Name of the medical transcription job to delete.
/// True if successful.
public async Task DeleteMedicalTranscriptionJob(string jobName)
{
var response = await _amazonTranscribeService.DeleteMedicalTranscriptionJobAsync(
new DeleteMedicalTranscriptionJobRequest()
{
MedicalTranscriptionJobName = jobName
});
return response.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DeleteMedicalTranscriptionJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/DeleteMedicalTranscriptionJob) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete a medical transcription job**
The following `delete-medical-transcription-job` example deletes a medical transcription job.
```
aws transcribe delete-medical-transcription-job \
--medical-transcription-job-name medical-transcription-job-name
```
This command produces no output.
For more information, see [DeleteMedicalTranscriptionJob](https://docs.aws.amazon.com/transcribe/latest/dg/API_DeleteMedicalTranscriptionJob.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [DeleteMedicalTranscriptionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/delete-medical-transcription-job.html) in *AWS CLI Command Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples).
Create the client.
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
Delete a medical transcription job.
```
// Import the required AWS SDK clients and commands for Node.js
import { DeleteMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
MedicalTranscriptionJobName: "MEDICAL_JOB_NAME", // For example, 'medical_transciption_demo'
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new DeleteMedicalTranscriptionJobCommand(params),
);
console.log("Success - deleted");
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-medical-examples-section.html#transcribe-delete-medical-job).
+ For API details, see [DeleteMedicalTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/DeleteMedicalTranscriptionJobCommand) in *AWS SDK for JavaScript API Reference*.
------
# Use `DeleteTranscriptionJob` with an AWS SDK or CLI
The following code examples show how to use `DeleteTranscriptionJob`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Delete a transcription job. Also deletes the transcript associated with the job.
///
/// Name of the transcription job to delete.
/// True if successful.
public async Task DeleteTranscriptionJob(string jobName)
{
var response = await _amazonTranscribeService.DeleteTranscriptionJobAsync(
new DeleteTranscriptionJobRequest()
{
TranscriptionJobName = jobName
});
return response.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DeleteTranscriptionJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/DeleteTranscriptionJob) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete one of your transcription jobs**
The following `delete-transcription-job` example deletes one of your transcription jobs.
```
aws transcribe delete-transcription-job \
--transcription-job-name your-transcription-job
```
This command produces no output.
For more information, see [DeleteTranscriptionJob](https://docs.aws.amazon.com/transcribe/latest/dg/API_DeleteTranscriptionJob.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [DeleteTranscriptionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/delete-transcription-job.html) in *AWS CLI Command Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples).
Delete a transcription job.
```
// Import the required AWS SDK clients and commands for Node.js
import { DeleteTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
TranscriptionJobName: "JOB_NAME", // Required. For example, 'transciption_demo'
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new DeleteTranscriptionJobCommand(params),
);
console.log("Success - deleted");
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
Create the client.
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-examples-section.html#transcribe-delete-job).
+ For API details, see [DeleteTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/DeleteTranscriptionJobCommand) in *AWS SDK for JavaScript API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def delete_job(job_name, transcribe_client):
"""
Deletes a transcription job. This also deletes the transcript associated with
the job.
:param job_name: The name of the job to delete.
:param transcribe_client: The Boto3 Transcribe client.
"""
try:
transcribe_client.delete_transcription_job(TranscriptionJobName=job_name)
logger.info("Deleted job %s.", job_name)
except ClientError:
logger.exception("Couldn't delete job %s.", job_name)
raise
```
+ For API details, see [DeleteTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/DeleteTranscriptionJob) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
lo_tnb->deletetranscriptionjob( iv_job_name ).
MESSAGE 'Transcription job deleted.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnblimitexceededex INTO DATA(lo_limit_ex).
MESSAGE lo_limit_ex TYPE 'I'.
RAISE EXCEPTION lo_limit_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
ENDTRY.
```
+ For API details, see [DeleteTranscriptionJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DeleteVocabulary` with an AWS SDK or CLI
The following code examples show how to use `DeleteVocabulary`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Delete an existing custom vocabulary.
///
/// Name of the vocabulary to delete.
/// True if successful.
public async Task DeleteCustomVocabulary(string vocabularyName)
{
var response = await _amazonTranscribeService.DeleteVocabularyAsync(
new DeleteVocabularyRequest
{
VocabularyName = vocabularyName
});
return response.HttpStatusCode == HttpStatusCode.OK;
}
```
+ For API details, see [DeleteVocabulary](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/DeleteVocabulary) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete a custom vocabulary**
The following `delete-vocabulary` example deletes a custom vocabulary.
```
aws transcribe delete-vocabulary \
--vocabulary-name vocabulary-name
```
This command produces no output.
For more information, see [Custom Vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [DeleteVocabulary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/delete-vocabulary.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def delete_vocabulary(vocabulary_name, transcribe_client):
"""
Deletes a custom vocabulary.
:param vocabulary_name: The name of the vocabulary to delete.
:param transcribe_client: The Boto3 Transcribe client.
"""
try:
transcribe_client.delete_vocabulary(VocabularyName=vocabulary_name)
logger.info("Deleted vocabulary %s.", vocabulary_name)
except ClientError:
logger.exception("Couldn't delete vocabulary %s.", vocabulary_name)
raise
```
+ For API details, see [DeleteVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/DeleteVocabulary) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
lo_tnb->deletevocabulary( iv_vocabulary_name ).
MESSAGE 'Vocabulary deleted.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
CATCH /aws1/cx_tnblimitexceededex INTO DATA(lo_limit_ex).
MESSAGE lo_limit_ex TYPE 'I'.
RAISE EXCEPTION lo_limit_ex.
CATCH /aws1/cx_tnbnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex TYPE 'I'.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
ENDTRY.
```
+ For API details, see [DeleteVocabulary](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetTranscriptionJob` with an AWS SDK or CLI
The following code examples show how to use `GetTranscriptionJob`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
+ [Transcribe audio and get job data](transcribe_example_transcribe_Scenario_GettingStartedTranscriptionJobs_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Get details about a transcription job.
///
/// A unique name for the transcription job.
/// A TranscriptionJob instance with information on the requested job.
public async Task GetTranscriptionJob(string jobName)
{
var response = await _amazonTranscribeService.GetTranscriptionJobAsync(
new GetTranscriptionJobRequest()
{
TranscriptionJobName = jobName
});
return response.TranscriptionJob;
}
```
+ For API details, see [GetTranscriptionJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/GetTranscriptionJob) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To get information about a specific transcription job**
The following `get-transcription-job` example gets information about a specific transcription job. To access the transcription results, use the TranscriptFileUri parameter. Use the MediaFileUri parameter to see which audio file you transcribed with this job. You can use the Settings object to see the optional features you've enabled in the transcription job.
```
aws transcribe get-transcription-job \
--transcription-job-name your-transcription-job
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "your-transcription-job",
"TranscriptionJobStatus": "COMPLETED",
"LanguageCode": "language-code",
"MediaSampleRateHertz": 48000,
"MediaFormat": "mp4",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.file-extension"
},
"Transcript": {
"TranscriptFileUri": "https://Amazon-S3-file-location-of-transcription-output"
},
"StartTime": "2020-09-18T22:27:23.970000+00:00",
"CreationTime": "2020-09-18T22:27:23.948000+00:00",
"CompletionTime": "2020-09-18T22:28:21.197000+00:00",
"Settings": {
"ChannelIdentification": false,
"ShowAlternatives": false
},
"IdentifyLanguage": true,
"IdentifiedLanguageScore": 0.8672199249267578
}
}
```
For more information, see [Getting Started (AWS Command Line Interface)](https://docs.aws.amazon.com/transcribe/latest/dg/getting-started-cli.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [GetTranscriptionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/get-transcription-job.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def get_job(job_name, transcribe_client):
"""
Gets details about a transcription job.
:param job_name: The name of the job to retrieve.
:param transcribe_client: The Boto3 Transcribe client.
:return: The retrieved transcription job.
"""
try:
response = transcribe_client.get_transcription_job(
TranscriptionJobName=job_name
)
job = response["TranscriptionJob"]
logger.info("Got job %s.", job["TranscriptionJobName"])
except ClientError:
logger.exception("Couldn't get job %s.", job_name)
raise
else:
return job
```
+ For API details, see [GetTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/GetTranscriptionJob) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
oo_result = lo_tnb->gettranscriptionjob( iv_job_name ).
DATA(lo_job) = oo_result->get_transcriptionjob( ).
MESSAGE 'Retrieved transcription job details.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnbnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex TYPE 'I'.
RAISE EXCEPTION lo_not_found_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
ENDTRY.
```
+ For API details, see [GetTranscriptionJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetVocabulary` with an AWS SDK or CLI
The following code examples show how to use `GetVocabulary`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Get information about a custom vocabulary.
///
/// Name of the vocabulary.
/// The state of the custom vocabulary.
public async Task GetCustomVocabulary(string vocabularyName)
{
var response = await _amazonTranscribeService.GetVocabularyAsync(
new GetVocabularyRequest()
{
VocabularyName = vocabularyName
});
return response.VocabularyState;
}
```
+ For API details, see [GetVocabulary](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/GetVocabulary) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To get information about a custom vocabulary**
The following `get-vocabulary` example gets information on a previously created custom vocabulary.
```
aws transcribe get-vocabulary \
--vocabulary-name cli-vocab-1
```
Output:
```
{
"VocabularyName": "cli-vocab-1",
"LanguageCode": "language-code",
"VocabularyState": "READY",
"LastModifiedTime": "2020-09-19T23:22:32.836000+00:00",
"DownloadUri": "https://link-to-download-the-text-file-used-to-create-your-custom-vocabulary"
}
```
For more information, see [Custom Vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [GetVocabulary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/get-vocabulary.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def get_vocabulary(vocabulary_name, transcribe_client):
"""
Gets information about a custom vocabulary.
:param vocabulary_name: The name of the vocabulary to retrieve.
:param transcribe_client: The Boto3 Transcribe client.
:return: Information about the vocabulary.
"""
try:
response = transcribe_client.get_vocabulary(VocabularyName=vocabulary_name)
logger.info("Got vocabulary %s.", response["VocabularyName"])
except ClientError:
logger.exception("Couldn't get vocabulary %s.", vocabulary_name)
raise
else:
return response
```
+ For API details, see [GetVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/GetVocabulary) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
oo_result = lo_tnb->getvocabulary( iv_vocabulary_name ).
MESSAGE 'Retrieved vocabulary details.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnbnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex TYPE 'I'.
RAISE EXCEPTION lo_not_found_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
ENDTRY.
```
+ For API details, see [GetVocabulary](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListMedicalTranscriptionJobs` with an AWS SDK or CLI
The following code examples show how to use `ListMedicalTranscriptionJobs`.
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// List medical transcription jobs, optionally with a name filter.
///
/// Optional name filter for the medical transcription jobs.
/// A list of summaries about medical transcription jobs.
public async Task> ListMedicalTranscriptionJobs(
string? jobNameContains = null)
{
var response = await _amazonTranscribeService.ListMedicalTranscriptionJobsAsync(
new ListMedicalTranscriptionJobsRequest()
{
JobNameContains = jobNameContains
});
return response.MedicalTranscriptionJobSummaries;
}
```
+ For API details, see [ListMedicalTranscriptionJobs](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/ListMedicalTranscriptionJobs) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To list your medical transcription jobs**
The following `list-medical-transcription-jobs` example lists the medical transcription jobs associated with your AWS account and Region. To get more information about a particular transcription job, copy the value of a MedicalTranscriptionJobName parameter in the transcription output, and specify that value for the `MedicalTranscriptionJobName` option of the `get-medical-transcription-job` command. To see more of your transcription jobs, copy the value of the NextToken parameter, run the `list-medical-transcription-jobs` command again, and specify that value in the `--next-token` option.
```
aws transcribe list-medical-transcription-jobs
```
Output:
```
{
"NextToken": "3/PblzkiGhzjER3KHuQt2fmbPLF7cDYafjFMEoGn44ON/gsuUSTIkGyanvRE6WMXFd/ZTEc2EZj+P9eii/z1O2FDYli6RLI0WoRX4RwMisVrh9G0Kie0Y8ikBCdtqlZB10Wa9McC+ebOl+LaDtZPC4u6ttoHLRlEfzqstHXSgapXg3tEBtm9piIaPB6MOM5BB6t86+qtmocTR/qrteHZBBudhTfbCwhsxaqujHiiUvFdm3BQbKKWIW06yV9b+4f38oD2lVIan+vfUs3gBYAl5VTDmXXzQPBQOHPjtwmFI+IWX15nSUjWuN3TUylHgPWzDaYT8qBtu0Z+3UG4V6b+K2CC0XszXg5rBq9hYgNzy4XoFh/6s5DoSnzq49Q9xHgHdT2yBADFmvFK7myZBsj75+2vQZOSVpWUPy3WT/32zFAcoELHR4unuWhXPwjbKU+mFYfUjtTZ8n/jq7aQEjQ42A+X/7K6JgOcdVPtEg8PlDr5kgYYG3q3OmYXX37U3FZuJmnTI63VtIXsNnOU5eGoYObtpk00Nq9UkzgSJxqj84ZD5n+S0EGy9ZUYBJRRcGeYUM3Q4DbSJfUwSAqcFdLIWZdp8qIREMQIBWy7BLwSdyqsQo2vRrd53hm5aWM7SVf6pPq6X/IXR5+1eUOOD8/coaTT4ES2DerbV6RkV4o0VT1d0SdVX/MmtkNG8nYj8PqU07w7988quh1ZP6D80veJS1q73tUUR9MjnGernW2tAnvnLNhdefBcD+sZVfYq3iBMFY7wTy1P1G6NqW9GrYDYoX3tTPWlD7phpbVSyKrh/PdYrps5UxnsGoA1b7L/FfAXDfUoGrGUB4N3JsPYXX9D++g+6gV1qBBs/WfF934aKqfD6UTggm/zV3GAOWiBpfvAZRvEb924i6yGHyMC7y54O1ZAwSBupmI+FFd13CaPO4kN1vJlth6aM5vUPXg4BpyUhtbRhwD/KxCvf9K0tLJGyL1A==",
"MedicalTranscriptionJobSummaries": [
{
"MedicalTranscriptionJobName": "vocabulary-dictation-medical-transcription-job",
"CreationTime": "2020-09-21T21:17:27.016000+00:00",
"StartTime": "2020-09-21T21:17:27.045000+00:00",
"CompletionTime": "2020-09-21T21:17:59.561000+00:00",
"LanguageCode": "en-US",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "CUSTOMER_BUCKET",
"Specialty": "PRIMARYCARE",
"Type": "DICTATION"
},
{
"MedicalTranscriptionJobName": "alternatives-dictation-medical-transcription-job",
"CreationTime": "2020-09-21T21:01:14.569000+00:00",
"StartTime": "2020-09-21T21:01:14.592000+00:00",
"CompletionTime": "2020-09-21T21:01:43.606000+00:00",
"LanguageCode": "en-US",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "CUSTOMER_BUCKET",
"Specialty": "PRIMARYCARE",
"Type": "DICTATION"
},
{
"MedicalTranscriptionJobName": "alternatives-conversation-medical-transcription-job",
"CreationTime": "2020-09-21T19:09:18.171000+00:00",
"StartTime": "2020-09-21T19:09:18.199000+00:00",
"CompletionTime": "2020-09-21T19:10:22.516000+00:00",
"LanguageCode": "en-US",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "CUSTOMER_BUCKET",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION"
},
{
"MedicalTranscriptionJobName": "speaker-id-conversation-medical-transcription-job",
"CreationTime": "2020-09-21T18:43:37.157000+00:00",
"StartTime": "2020-09-21T18:43:37.265000+00:00",
"CompletionTime": "2020-09-21T18:44:21.192000+00:00",
"LanguageCode": "en-US",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "CUSTOMER_BUCKET",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION"
},
{
"MedicalTranscriptionJobName": "multichannel-conversation-medical-transcription-job",
"CreationTime": "2020-09-20T23:46:44.053000+00:00",
"StartTime": "2020-09-20T23:46:44.081000+00:00",
"CompletionTime": "2020-09-20T23:47:35.851000+00:00",
"LanguageCode": "en-US",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "CUSTOMER_BUCKET",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION"
}
]
}
```
For more information, see https://docs.aws.amazon.com/transcribe/latest/dg/batch-med-transcription.html> in the *Amazon Transcribe Developer Guide*.
+ For API details, see [ListMedicalTranscriptionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/list-medical-transcription-jobs.html) in *AWS CLI Command Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples).
Create the client.
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
List medical transcription jobs.
```
// Import the required AWS SDK clients and commands for Node.js
import { StartMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
MedicalTranscriptionJobName: "MEDICAL_JOB_NAME", // Required
OutputBucketName: "OUTPUT_BUCKET_NAME", // Required
Specialty: "PRIMARYCARE", // Required. Possible values are 'PRIMARYCARE'
Type: "JOB_TYPE", // Required. Possible values are 'CONVERSATION' and 'DICTATION'
LanguageCode: "LANGUAGE_CODE", // For example, 'en-US'
MediaFormat: "SOURCE_FILE_FORMAT", // For example, 'wav'
Media: {
MediaFileUri: "SOURCE_FILE_LOCATION",
// The S3 object location of the input media file. The URI must be in the same region
// as the API endpoint that you are calling.For example,
// "https://transcribe-demo.s3-REGION.amazonaws.com/hello_world.wav"
},
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new StartMedicalTranscriptionJobCommand(params),
);
console.log("Success - put", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-medical-examples-section.html#transcribe-list-medical-jobs).
+ For API details, see [ListMedicalTranscriptionJobs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/ListMedicalTranscriptionJobsCommand) in *AWS SDK for JavaScript API Reference*.
------
# Use `ListTranscriptionJobs` with an AWS SDK or CLI
The following code examples show how to use `ListTranscriptionJobs`.
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// List transcription jobs, optionally with a name filter.
///
/// Optional name filter for the transcription jobs.
/// A list of transcription job summaries.
public async Task> ListTranscriptionJobs(string? jobNameContains = null)
{
var response = await _amazonTranscribeService.ListTranscriptionJobsAsync(
new ListTranscriptionJobsRequest()
{
JobNameContains = jobNameContains
});
return response.TranscriptionJobSummaries;
}
```
+ For API details, see [ListTranscriptionJobs](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/ListTranscriptionJobs) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To list your transcription jobs**
The following `list-transcription-jobs` example lists the transcription jobs associated with your AWS account and Region.
```
aws transcribe list-transcription-jobs
```
Output:
```
{
"NextToken": "NextToken",
"TranscriptionJobSummaries": [
{
"TranscriptionJobName": "speak-id-job-1",
"CreationTime": "2020-08-17T21:06:15.391000+00:00",
"StartTime": "2020-08-17T21:06:15.416000+00:00",
"CompletionTime": "2020-08-17T21:07:05.098000+00:00",
"LanguageCode": "language-code",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "SERVICE_BUCKET"
},
{
"TranscriptionJobName": "job-1",
"CreationTime": "2020-08-17T20:50:24.207000+00:00",
"StartTime": "2020-08-17T20:50:24.230000+00:00",
"CompletionTime": "2020-08-17T20:52:18.737000+00:00",
"LanguageCode": "language-code",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "SERVICE_BUCKET"
},
{
"TranscriptionJobName": "sdk-test-job-4",
"CreationTime": "2020-08-17T20:32:27.917000+00:00",
"StartTime": "2020-08-17T20:32:27.956000+00:00",
"CompletionTime": "2020-08-17T20:33:15.126000+00:00",
"LanguageCode": "language-code",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "SERVICE_BUCKET"
},
{
"TranscriptionJobName": "Diarization-speak-id",
"CreationTime": "2020-08-10T22:10:09.066000+00:00",
"StartTime": "2020-08-10T22:10:09.116000+00:00",
"CompletionTime": "2020-08-10T22:26:48.172000+00:00",
"LanguageCode": "language-code",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "SERVICE_BUCKET"
},
{
"TranscriptionJobName": "your-transcription-job-name",
"CreationTime": "2020-07-29T17:45:09.791000+00:00",
"StartTime": "2020-07-29T17:45:09.826000+00:00",
"CompletionTime": "2020-07-29T17:46:20.831000+00:00",
"LanguageCode": "language-code",
"TranscriptionJobStatus": "COMPLETED",
"OutputLocationType": "SERVICE_BUCKET"
}
]
}
```
For more information, see [Getting Started (AWS Command Line Interface)](https://docs.aws.amazon.com/transcribe/latest/dg/getting-started-cli.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [ListTranscriptionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/list-transcription-jobs.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/transcribe#code-examples).
```
public class ListTranscriptionJobs {
public static void main(String[] args) {
TranscribeClient transcribeClient = TranscribeClient.builder()
.region(Region.US_EAST_1)
.build();
listTranscriptionJobs(transcribeClient);
}
public static void listTranscriptionJobs(TranscribeClient transcribeClient) {
ListTranscriptionJobsRequest listJobsRequest = ListTranscriptionJobsRequest.builder()
.build();
transcribeClient.listTranscriptionJobsPaginator(listJobsRequest).stream()
.flatMap(response -> response.transcriptionJobSummaries().stream())
.forEach(jobSummary -> {
System.out.println("Job Name: " + jobSummary.transcriptionJobName());
System.out.println("Job Status: " + jobSummary.transcriptionJobStatus());
System.out.println("Output Location: " + jobSummary.outputLocationType());
// Add more information as needed
// Retrieve additional details for the job if necessary
GetTranscriptionJobResponse jobDetails = transcribeClient.getTranscriptionJob(
GetTranscriptionJobRequest.builder()
.transcriptionJobName(jobSummary.transcriptionJobName())
.build());
// Display additional details
System.out.println("Language Code: " + jobDetails.transcriptionJob().languageCode());
System.out.println("Media Format: " + jobDetails.transcriptionJob().mediaFormat());
// Add more details as needed
System.out.println("--------------");
});
}
}
```
+ For API details, see [ListTranscriptionJobs](https://docs.aws.amazon.com/goto/SdkForJavaV2/transcribe-2017-10-26/ListTranscriptionJobs) in *AWS SDK for Java 2.x API Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples).
List transcription jobs.
```
// Import the required AWS SDK clients and commands for Node.js
import { ListTranscriptionJobsCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
JobNameContains: "KEYWORD", // Not required. Returns only transcription
// job names containing this string
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new ListTranscriptionJobsCommand(params),
);
console.log("Success", data.TranscriptionJobSummaries);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
Create the client.
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-examples-section.html#transcribe-list-jobs).
+ For API details, see [ListTranscriptionJobs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/ListTranscriptionJobsCommand) in *AWS SDK for JavaScript API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def list_jobs(job_filter, transcribe_client):
"""
Lists summaries of the transcription jobs for the current AWS account.
:param job_filter: The list of returned jobs must contain this string in their
names.
:param transcribe_client: The Boto3 Transcribe client.
:return: The list of retrieved transcription job summaries.
"""
try:
response = transcribe_client.list_transcription_jobs(JobNameContains=job_filter)
jobs = response["TranscriptionJobSummaries"]
next_token = response.get("NextToken")
while next_token is not None:
response = transcribe_client.list_transcription_jobs(
JobNameContains=job_filter, NextToken=next_token
)
jobs += response["TranscriptionJobSummaries"]
next_token = response.get("NextToken")
logger.info("Got %s jobs with filter %s.", len(jobs), job_filter)
except ClientError:
logger.exception("Couldn't get jobs with filter %s.", job_filter)
raise
else:
return jobs
```
+ For API details, see [ListTranscriptionJobs](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/ListTranscriptionJobs) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
IF iv_job_filter IS NOT INITIAL.
oo_result = lo_tnb->listtranscriptionjobs( iv_jobnamecontains = iv_job_filter ).
ELSE.
oo_result = lo_tnb->listtranscriptionjobs( ).
ENDIF.
MESSAGE 'Retrieved transcription jobs list.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
ENDTRY.
```
+ For API details, see [ListTranscriptionJobs](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListVocabularies` with an AWS SDK or CLI
The following code examples show how to use `ListVocabularies`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// List custom vocabularies for the current account. Optionally specify a name
/// filter and a specific state to filter the vocabularies list.
///
/// Optional string the vocabulary name must contain.
/// Optional state of the vocabulary.
/// List of information about the vocabularies.
public async Task> ListCustomVocabularies(string? nameContains = null,
VocabularyState? stateEquals = null)
{
var response = await _amazonTranscribeService.ListVocabulariesAsync(
new ListVocabulariesRequest()
{
NameContains = nameContains,
StateEquals = stateEquals
});
return response.Vocabularies;
}
```
+ For API details, see [ListVocabularies](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/ListVocabularies) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To list your custom vocabularies**
The following `list-vocabularies` example lists the custom vocabularies associated with your AWS account and Region.
```
aws transcribe list-vocabularies
```
Output:
```
{
"NextToken": "NextToken",
"Vocabularies": [
{
"VocabularyName": "ards-test-1",
"LanguageCode": "language-code",
"LastModifiedTime": "2020-04-27T22:00:27.330000+00:00",
"VocabularyState": "READY"
},
{
"VocabularyName": "sample-test",
"LanguageCode": "language-code",
"LastModifiedTime": "2020-04-24T23:04:11.044000+00:00",
"VocabularyState": "READY"
},
{
"VocabularyName": "CRLF-to-LF-test-3-1",
"LanguageCode": "language-code",
"LastModifiedTime": "2020-04-24T22:12:22.277000+00:00",
"VocabularyState": "READY"
},
{
"VocabularyName": "CRLF-to-LF-test-2",
"LanguageCode": "language-code",
"LastModifiedTime": "2020-04-24T21:53:50.455000+00:00",
"VocabularyState": "READY"
},
{
"VocabularyName": "CRLF-to-LF-1-1",
"LanguageCode": "language-code",
"LastModifiedTime": "2020-04-24T21:39:33.356000+00:00",
"VocabularyState": "READY"
}
]
}
```
For more information, see [Custom Vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [ListVocabularies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/list-vocabularies.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def list_vocabularies(vocabulary_filter, transcribe_client):
"""
Lists the custom vocabularies created for this AWS account.
:param vocabulary_filter: The returned vocabularies must contain this string in
their names.
:param transcribe_client: The Boto3 Transcribe client.
:return: The list of retrieved vocabularies.
"""
try:
response = transcribe_client.list_vocabularies(NameContains=vocabulary_filter)
vocabs = response["Vocabularies"]
next_token = response.get("NextToken")
while next_token is not None:
response = transcribe_client.list_vocabularies(
NameContains=vocabulary_filter, NextToken=next_token
)
vocabs += response["Vocabularies"]
next_token = response.get("NextToken")
logger.info(
"Got %s vocabularies with filter %s.", len(vocabs), vocabulary_filter
)
except ClientError:
logger.exception(
"Couldn't list vocabularies with filter %s.", vocabulary_filter
)
raise
else:
return vocabs
```
+ For API details, see [ListVocabularies](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/ListVocabularies) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
IF iv_vocab_filter IS NOT INITIAL.
oo_result = lo_tnb->listvocabularies( iv_namecontains = iv_vocab_filter ).
ELSE.
oo_result = lo_tnb->listvocabularies( ).
ENDIF.
MESSAGE 'Retrieved vocabularies list.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
ENDTRY.
```
+ For API details, see [ListVocabularies](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `StartMedicalTranscriptionJob` with an AWS SDK or CLI
The following code examples show how to use `StartMedicalTranscriptionJob`.
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Start a medical transcription job for a media file. This method returns
/// as soon as the job is started.
///
/// A unique name for the medical transcription job.
/// The URI of the media file, typically an Amazon S3 location.
/// The format of the media file.
/// Location for the output, typically an Amazon S3 location.
/// Conversation or dictation transcription type.
/// A MedicalTransactionJob instance with information on the new job.
public async Task StartMedicalTranscriptionJob(
string jobName, string mediaFileUri,
MediaFormat mediaFormat, string outputBucketName, Amazon.TranscribeService.Type transcriptionType)
{
var response = await _amazonTranscribeService.StartMedicalTranscriptionJobAsync(
new StartMedicalTranscriptionJobRequest()
{
MedicalTranscriptionJobName = jobName,
Media = new Media()
{
MediaFileUri = mediaFileUri
},
MediaFormat = mediaFormat,
LanguageCode =
LanguageCode
.EnUS, // The value must be en-US for medical transcriptions.
OutputBucketName = outputBucketName,
OutputKey =
jobName, // The value is a key used to fetch the output of the transcription.
Specialty = Specialty.PRIMARYCARE, // The value PRIMARYCARE must be set.
Type = transcriptionType
});
return response.MedicalTranscriptionJob;
}
```
+ For API details, see [StartMedicalTranscriptionJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/StartMedicalTranscriptionJob) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To transcribe a medical dictation stored as an audio file**
The following `start-medical-transcription-job` example transcribes an audio file. You specify the location of the transcription output in the `OutputBucketName` parameter.
```
aws transcribe start-medical-transcription-job \
--cli-input-json file://myfile.json
```
Contents of `myfile.json`:
```
{
"MedicalTranscriptionJobName": "simple-dictation-medical-transcription-job",
"LanguageCode": "language-code",
"Specialty": "PRIMARYCARE",
"Type": "DICTATION",
"OutputBucketName":"amzn-s3-demo-bucket",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
}
}
```
Output:
```
{
"MedicalTranscriptionJob": {
"MedicalTranscriptionJobName": "simple-dictation-medical-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"StartTime": "2020-09-20T00:35:22.256000+00:00",
"CreationTime": "2020-09-20T00:35:22.218000+00:00",
"Specialty": "PRIMARYCARE",
"Type": "DICTATION"
}
}
```
For more information, see [Batch Transcription Overview](https://docs.aws.amazon.com/transcribe/latest/dg/batch-med-transcription.html) in the *Amazon Transcribe Developer Guide*.
**Example 2: To transcribe a clinician-patient dialogue stored as an audio file**
The following `start-medical-transcription-job` example transcribes an audio file containing a clinician-patient dialogue. You specify the location of the transcription output in the OutputBucketName parameter.
```
aws transcribe start-medical-transcription-job \
--cli-input-json file://mysecondfile.json
```
Contents of `mysecondfile.json`:
```
{
"MedicalTranscriptionJobName": "simple-dictation-medical-transcription-job",
"LanguageCode": "language-code",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION",
"OutputBucketName":"amzn-s3-demo-bucket",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
}
}
```
Output:
```
{
"MedicalTranscriptionJob": {
"MedicalTranscriptionJobName": "simple-conversation-medical-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"StartTime": "2020-09-20T23:19:49.965000+00:00",
"CreationTime": "2020-09-20T23:19:49.941000+00:00",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION"
}
}
```
For more information, see [Batch Transcription Overview](https://docs.aws.amazon.com/transcribe/latest/dg/batch-med-transcription.html) in the *Amazon Transcribe Developer Guide*.
**Example 3: To transcribe a multichannel audio file of a clinician-patient dialogue**
The following `start-medical-transcription-job` example transcribes the audio from each channel in the audio file and merges the separate transcriptions from each channel into a single transcription output. You specify the location of the transcription output in the `OutputBucketName` parameter.
```
aws transcribe start-medical-transcription-job \
--cli-input-json file://mythirdfile.json
```
Contents of `mythirdfile.json`:
```
{
"MedicalTranscriptionJobName": "multichannel-conversation-medical-transcription-job",
"LanguageCode": "language-code",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION",
"OutputBucketName":"amzn-s3-demo-bucket",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"Settings":{
"ChannelIdentification": true
}
}
```
Output:
```
{
"MedicalTranscriptionJob": {
"MedicalTranscriptionJobName": "multichannel-conversation-medical-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"StartTime": "2020-09-20T23:46:44.081000+00:00",
"CreationTime": "2020-09-20T23:46:44.053000+00:00",
"Settings": {
"ChannelIdentification": true
},
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION"
}
}
```
For more information, see [Channel Identification](https://docs.aws.amazon.com/transcribe/latest/dg/how-channel-id-med.html) in the *Amazon Transcribe Developer Guide*.
**Example 4: To transcribe an audio file of a clinician-patient dialogue and identify the speakers in the transcription output**
The following `start-medical-transcription-job` example transcribes an audio file and labels the speech of each speaker in the transcription output. You specify the location of the transcription output in the `OutputBucketName` parameter.
```
aws transcribe start-medical-transcription-job \
--cli-input-json file://myfourthfile.json
```
Contents of `myfourthfile.json`:
```
{
"MedicalTranscriptionJobName": "speaker-id-conversation-medical-transcription-job",
"LanguageCode": "language-code",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION",
"OutputBucketName":"amzn-s3-demo-bucket",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"Settings":{
"ShowSpeakerLabels": true,
"MaxSpeakerLabels": 2
}
}
```
Output:
```
{
"MedicalTranscriptionJob": {
"MedicalTranscriptionJobName": "speaker-id-conversation-medical-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"StartTime": "2020-09-21T18:43:37.265000+00:00",
"CreationTime": "2020-09-21T18:43:37.157000+00:00",
"Settings": {
"ShowSpeakerLabels": true,
"MaxSpeakerLabels": 2
},
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION"
}
}
```
For more information, see [Identifying Speakers](https://docs.aws.amazon.com/transcribe/latest/dg/diarization-med.html) in the *Amazon Transcribe Developer Guide*.
**Example 5: To transcribe a medical conversation stored as an audio file with up to two transcription alternatives**
The following `start-medical-transcription-job` example creates up to two alternative transcriptions from a single audio file. Every transcriptions has a level of confidence associated with it. By default, Amazon Transcribe returns the transcription with the highest confidence level. You can specify that Amazon Transcribe return additional transcriptions with lower confidence levels. You specify the location of the transcription output in the `OutputBucketName` parameter.
```
aws transcribe start-medical-transcription-job \
--cli-input-json file://myfifthfile.json
```
Contents of `myfifthfile.json`:
```
{
"MedicalTranscriptionJobName": "alternatives-conversation-medical-transcription-job",
"LanguageCode": "language-code",
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION",
"OutputBucketName":"amzn-s3-demo-bucket",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"Settings":{
"ShowAlternatives": true,
"MaxAlternatives": 2
}
}
```
Output:
```
{
"MedicalTranscriptionJob": {
"MedicalTranscriptionJobName": "alternatives-conversation-medical-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"StartTime": "2020-09-21T19:09:18.199000+00:00",
"CreationTime": "2020-09-21T19:09:18.171000+00:00",
"Settings": {
"ShowAlternatives": true,
"MaxAlternatives": 2
},
"Specialty": "PRIMARYCARE",
"Type": "CONVERSATION"
}
}
```
For more information, see [Alternative Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives-med.html) in the *Amazon Transcribe Developer Guide*.
**Example 6: To transcribe an audio file of a medical dictation with up to two alternative transcriptions**
The following `start-medical-transcription-job` example transcribes an audio file and uses a vocabulary filter to mask any unwanted words. You specify the location of the transcription output in the OutputBucketName parameter.
```
aws transcribe start-medical-transcription-job \
--cli-input-json file://mysixthfile.json
```
Contents of `mysixthfile.json`:
```
{
"MedicalTranscriptionJobName": "alternatives-conversation-medical-transcription-job",
"LanguageCode": "language-code",
"Specialty": "PRIMARYCARE",
"Type": "DICTATION",
"OutputBucketName":"amzn-s3-demo-bucket",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"Settings":{
"ShowAlternatives": true,
"MaxAlternatives": 2
}
}
```
Output:
```
{
"MedicalTranscriptionJob": {
"MedicalTranscriptionJobName": "alternatives-dictation-medical-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"StartTime": "2020-09-21T21:01:14.592000+00:00",
"CreationTime": "2020-09-21T21:01:14.569000+00:00",
"Settings": {
"ShowAlternatives": true,
"MaxAlternatives": 2
},
"Specialty": "PRIMARYCARE",
"Type": "DICTATION"
}
}
```
For more information, see [Alternative Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives-med.html) in the *Amazon Transcribe Developer Guide*.
**Example 7: To transcribe an audio file of a medical dictation with increased accuracy by using a custom vocabulary**
The following `start-medical-transcription-job` example transcribes an audio file and uses a medical custom vocabulary you've previously created to increase the transcription accuracy. You specify the location of the transcription output in the `OutputBucketName` parameter.
```
aws transcribe start-transcription-job \
--cli-input-json file://myseventhfile.json
```
Contents of `mysixthfile.json`:
```
{
"MedicalTranscriptionJobName": "vocabulary-dictation-medical-transcription-job",
"LanguageCode": "language-code",
"Specialty": "PRIMARYCARE",
"Type": "DICTATION",
"OutputBucketName":"amzn-s3-demo-bucket",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"Settings":{
"VocabularyName": "cli-medical-vocab-1"
}
}
```
Output:
```
{
"MedicalTranscriptionJob": {
"MedicalTranscriptionJobName": "vocabulary-dictation-medical-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension"
},
"StartTime": "2020-09-21T21:17:27.045000+00:00",
"CreationTime": "2020-09-21T21:17:27.016000+00:00",
"Settings": {
"VocabularyName": "cli-medical-vocab-1"
},
"Specialty": "PRIMARYCARE",
"Type": "DICTATION"
}
}
```
For more information, see [Medical Custom Vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary-med.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [StartMedicalTranscriptionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/start-medical-transcription-job.html) in *AWS CLI Command Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples).
Create the client.
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
Start a medical transcription job.
```
// Import the required AWS SDK clients and commands for Node.js
import { StartMedicalTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
MedicalTranscriptionJobName: "MEDICAL_JOB_NAME", // Required
OutputBucketName: "OUTPUT_BUCKET_NAME", // Required
Specialty: "PRIMARYCARE", // Required. Possible values are 'PRIMARYCARE'
Type: "JOB_TYPE", // Required. Possible values are 'CONVERSATION' and 'DICTATION'
LanguageCode: "LANGUAGE_CODE", // For example, 'en-US'
MediaFormat: "SOURCE_FILE_FORMAT", // For example, 'wav'
Media: {
MediaFileUri: "SOURCE_FILE_LOCATION",
// The S3 object location of the input media file. The URI must be in the same region
// as the API endpoint that you are calling.For example,
// "https://transcribe-demo.s3-REGION.amazonaws.com/hello_world.wav"
},
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new StartMedicalTranscriptionJobCommand(params),
);
console.log("Success - put", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-medical-examples-section.html#transcribe-start-medical-transcription).
+ For API details, see [StartMedicalTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/StartMedicalTranscriptionJobCommand) in *AWS SDK for JavaScript API Reference*.
------
# Use `StartTranscriptionJob` with an AWS SDK or CLI
The following code examples show how to use `StartTranscriptionJob`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
+ [Transcribe audio and get job data](transcribe_example_transcribe_Scenario_GettingStartedTranscriptionJobs_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Start a transcription job for a media file. This method returns
/// as soon as the job is started.
///
/// A unique name for the transcription job.
/// The URI of the media file, typically an Amazon S3 location.
/// The format of the media file.
/// The language code of the media file, such as en-US.
/// Optional name of a custom vocabulary.
/// A TranscriptionJob instance with information on the new job.
public async Task StartTranscriptionJob(string jobName, string mediaFileUri,
MediaFormat mediaFormat, LanguageCode languageCode, string? vocabularyName)
{
var response = await _amazonTranscribeService.StartTranscriptionJobAsync(
new StartTranscriptionJobRequest()
{
TranscriptionJobName = jobName,
Media = new Media()
{
MediaFileUri = mediaFileUri
},
MediaFormat = mediaFormat,
LanguageCode = languageCode,
Settings = vocabularyName != null ? new Settings()
{
VocabularyName = vocabularyName
} : null
});
return response.TranscriptionJob;
}
```
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/StartTranscriptionJob) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To transcribe an audio file**
The following `start-transcription-job` example transcribes your audio file.
```
aws transcribe start-transcription-job \
--cli-input-json file://myfile.json
```
Contents of `myfile.json`:
```
{
"TranscriptionJobName": "cli-simple-transcription-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
}
}
```
For more information, see [Getting Started (AWS Command Line Interface)](https://docs.aws.amazon.com/transcribe/latest/dg/getting-started-cli.html) in the *Amazon Transcribe Developer Guide*.
**Example 2: To transcribe a multi-channel audio file**
The following `start-transcription-job` example transcribes your multi-channel audio file.
```
aws transcribe start-transcription-job \
--cli-input-json file://mysecondfile.json
```
Contents of `mysecondfile.json`:
```
{
"TranscriptionJobName": "cli-channelid-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"ChannelIdentification":true
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-channelid-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-17T16:07:56.817000+00:00",
"CreationTime": "2020-09-17T16:07:56.784000+00:00",
"Settings": {
"ChannelIdentification": true
}
}
}
```
For more information, see [Transcribing Multi-Channel Audio](https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) in the *Amazon Transcribe Developer Guide*.
**Example 3: To transcribe an audio file and identify the different speakers**
The following `start-transcription-job` example transcribes your audio file and identifies the speakers in the transcription output.
```
aws transcribe start-transcription-job \
--cli-input-json file://mythirdfile.json
```
Contents of `mythirdfile.json`:
```
{
"TranscriptionJobName": "cli-speakerid-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"ShowSpeakerLabels": true,
"MaxSpeakerLabels": 2
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-speakerid-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-17T16:22:59.696000+00:00",
"CreationTime": "2020-09-17T16:22:59.676000+00:00",
"Settings": {
"ShowSpeakerLabels": true,
"MaxSpeakerLabels": 2
}
}
}
```
For more information, see [Identifying Speakers](https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) in the *Amazon Transcribe Developer Guide*.
**Example 4: To transcribe an audio file and mask any unwanted words in the transcription output**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://myfourthfile.json
```
Contents of `myfourthfile.json`:
```
{
"TranscriptionJobName": "cli-filter-mask-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "mask"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-filter-mask-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"StartTime": "2020-09-18T16:36:18.568000+00:00",
"CreationTime": "2020-09-18T16:36:18.547000+00:00",
"Settings": {
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "mask"
}
}
}
```
For more information, see [Filtering Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/filter-transcriptions.html) in the *Amazon Transcribe Developer Guide*.
**Example 5: To transcribe an audio file and remove any unwanted words in the transcription output**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://myfifthfile.json
```
Contents of `myfifthfile.json`:
```
{
"TranscriptionJobName": "cli-filter-remove-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "remove"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-filter-remove-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-18T16:36:18.568000+00:00",
"CreationTime": "2020-09-18T16:36:18.547000+00:00",
"Settings": {
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "remove"
}
}
}
```
For more information, see [Filtering Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/filter-transcriptions.html) in the *Amazon Transcribe Developer Guide*.
**Example 6: To transcribe an audio file with increased accuracy using a custom vocabulary**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://mysixthfile.json
```
Contents of `mysixthfile.json`:
```
{
"TranscriptionJobName": "cli-vocab-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"VocabularyName": "your-vocabulary"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-vocab-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-18T16:36:18.568000+00:00",
"CreationTime": "2020-09-18T16:36:18.547000+00:00",
"Settings": {
"VocabularyName": "your-vocabulary"
}
}
}
```
For more information, see [Filtering Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/filter-transcriptions.html) in the *Amazon Transcribe Developer Guide*.
**Example 7: To identify the language of an audio file and transcribe it**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://myseventhfile.json
```
Contents of `myseventhfile.json`:
```
{
"TranscriptionJobName": "cli-identify-language-transcription-job",
"IdentifyLanguage": true,
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-identify-language-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-18T22:27:23.970000+00:00",
"CreationTime": "2020-09-18T22:27:23.948000+00:00",
"IdentifyLanguage": true
}
}
```
For more information, see [Identifying the Language](https://docs.aws.amazon.com/transcribe/latest/dg/auto-lang-id.html) in the *Amazon Transcribe Developer Guide*.
**Example 8: To transcribe an audio file with personally identifiable information redacted**
The following `start-transcription-job` example transcribes your audio file and redacts any personally identifiable information in the transcription output.
```
aws transcribe start-transcription-job \
--cli-input-json file://myeighthfile.json
```
Contents of `myeigthfile.json`:
```
{
"TranscriptionJobName": "cli-redaction-job",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"ContentRedaction": {
"RedactionOutput":"redacted",
"RedactionType":"PII"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-redaction-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"StartTime": "2020-09-25T23:49:13.195000+00:00",
"CreationTime": "2020-09-25T23:49:13.176000+00:00",
"ContentRedaction": {
"RedactionType": "PII",
"RedactionOutput": "redacted"
}
}
}
```
For more information, see [Automatic Content Redaction](https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html) in the *Amazon Transcribe Developer Guide*.
**Example 9: To generate a transcript with personally identifiable information (PII) redacted and an unredacted transcript**
The following `start-transcription-job` example generates two transcrptions of your audio file, one with the personally identifiable information redacted, and the other without any redactions.
```
aws transcribe start-transcription-job \
--cli-input-json file://myninthfile.json
```
Contents of `myninthfile.json`:
```
{
"TranscriptionJobName": "cli-redaction-job-with-unredacted-transcript",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"ContentRedaction": {
"RedactionOutput":"redacted_and_unredacted",
"RedactionType":"PII"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-redaction-job-with-unredacted-transcript",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"StartTime": "2020-09-25T23:59:47.677000+00:00",
"CreationTime": "2020-09-25T23:59:47.653000+00:00",
"ContentRedaction": {
"RedactionType": "PII",
"RedactionOutput": "redacted_and_unredacted"
}
}
}
```
For more information, see [Automatic Content Redaction](https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html) in the *Amazon Transcribe Developer Guide*.
**Example 10: To use a custom language model you've previously created to transcribe an audio file.**
The following `start-transcription-job` example transcribes your audio file with a custom language model you've previously created.
```
aws transcribe start-transcription-job \
--cli-input-json file://mytenthfile.json
```
Contents of `mytenthfile.json`:
```
{
"TranscriptionJobName": "cli-clm-2-job-1",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.file-extension"
},
"ModelSettings": {
"LanguageModelName":"cli-clm-2"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-clm-2-job-1",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.file-extension"
},
"StartTime": "2020-09-28T17:56:01.835000+00:00",
"CreationTime": "2020-09-28T17:56:01.801000+00:00",
"ModelSettings": {
"LanguageModelName": "cli-clm-2"
}
}
}
```
For more information, see [Improving Domain-Specific Transcription Accuracy with Custom Language Models](https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [StartTranscriptionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/start-transcription-job.html) in *AWS CLI Command Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples).
Start a transcription job.
```
// Import the required AWS SDK clients and commands for Node.js
import { StartTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
TranscriptionJobName: "JOB_NAME",
LanguageCode: "LANGUAGE_CODE", // For example, 'en-US'
MediaFormat: "SOURCE_FILE_FORMAT", // For example, 'wav'
Media: {
MediaFileUri: "SOURCE_LOCATION",
// For example, "https://transcribe-demo.s3-REGION.amazonaws.com/hello_world.wav"
},
OutputBucketName: "OUTPUT_BUCKET_NAME",
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new StartTranscriptionJobCommand(params),
);
console.log("Success - put", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
Create the client.
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-examples-section.html#transcribe-start-transcription).
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/StartTranscriptionJobCommand) in *AWS SDK for JavaScript API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def start_job(
job_name,
media_uri,
media_format,
language_code,
transcribe_client,
vocabulary_name=None,
):
"""
Starts a transcription job. This function returns as soon as the job is started.
To get the current status of the job, call get_transcription_job. The job is
successfully completed when the job status is 'COMPLETED'.
:param job_name: The name of the transcription job. This must be unique for
your AWS account.
:param media_uri: The URI where the audio file is stored. This is typically
in an Amazon S3 bucket.
:param media_format: The format of the audio file. For example, mp3 or wav.
:param language_code: The language code of the audio file.
For example, en-US or ja-JP
:param transcribe_client: The Boto3 Transcribe client.
:param vocabulary_name: The name of a custom vocabulary to use when transcribing
the audio file.
:return: Data about the job.
"""
try:
job_args = {
"TranscriptionJobName": job_name,
"Media": {"MediaFileUri": media_uri},
"MediaFormat": media_format,
"LanguageCode": language_code,
}
if vocabulary_name is not None:
job_args["Settings"] = {"VocabularyName": vocabulary_name}
response = transcribe_client.start_transcription_job(**job_args)
job = response["TranscriptionJob"]
logger.info("Started transcription job %s.", job_name)
except ClientError:
logger.exception("Couldn't start transcription job %s.", job_name)
raise
else:
return job
```
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/StartTranscriptionJob) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
DATA(lo_media) = NEW /aws1/cl_tnbmedia( iv_mediafileuri = iv_media_uri ).
DATA(lo_settings) = NEW /aws1/cl_tnbsettings( ).
IF iv_vocabulary_name IS NOT INITIAL.
lo_settings = NEW /aws1/cl_tnbsettings( iv_vocabularyname = iv_vocabulary_name ).
ENDIF.
oo_result = lo_tnb->starttranscriptionjob(
iv_transcriptionjobname = iv_job_name
io_media = lo_media
iv_mediaformat = iv_media_format
iv_languagecode = iv_language_code
io_settings = lo_settings ).
MESSAGE 'Transcription job started.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnblimitexceededex INTO DATA(lo_limit_ex).
MESSAGE lo_limit_ex TYPE 'I'.
RAISE EXCEPTION lo_limit_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
CATCH /aws1/cx_tnbconflictexception INTO DATA(lo_conflict_ex).
MESSAGE lo_conflict_ex TYPE 'I'.
RAISE EXCEPTION lo_conflict_ex.
ENDTRY.
```
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `UpdateVocabulary` with an AWS SDK or CLI
The following code examples show how to use `UpdateVocabulary`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Update a custom vocabulary with new values. Update overwrites all existing information.
///
/// The language code of the vocabulary.
/// Phrases to use in the vocabulary.
/// Name for the vocabulary.
/// The state of the custom vocabulary.
public async Task UpdateCustomVocabulary(LanguageCode languageCode,
List phrases, string vocabularyName)
{
var response = await _amazonTranscribeService.UpdateVocabularyAsync(
new UpdateVocabularyRequest()
{
LanguageCode = languageCode,
Phrases = phrases,
VocabularyName = vocabularyName
});
return response.VocabularyState;
}
```
+ For API details, see [UpdateVocabulary](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/UpdateVocabulary) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To update a custom vocabulary with new terms.**
The following `update-vocabulary` example overwrites the terms used to create a custom vocabulary with the new ones that you provide. Prerequisite: to replace the terms in a custom vocabulary, you need a file with new terms.
```
aws transcribe update-vocabulary \
--vocabulary-file-uri s3://amzn-s3-demo-bucket/Amazon-S3-Prefix/custom-vocabulary.txt \
--vocabulary-name custom-vocabulary \
--language-code language-code
```
Output:
```
{
"VocabularyName": "custom-vocabulary",
"LanguageCode": "language",
"VocabularyState": "PENDING"
}
```
For more information, see [Custom Vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/how-vocabulary.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [UpdateVocabulary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/update-vocabulary.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def update_vocabulary(
vocabulary_name, language_code, transcribe_client, phrases=None, table_uri=None
):
"""
Updates an existing custom vocabulary. The entire vocabulary is replaced with
the contents of the update.
:param vocabulary_name: The name of the vocabulary to update.
:param language_code: The language code of the vocabulary.
:param transcribe_client: The Boto3 Transcribe client.
:param phrases: A list of comma-separated phrases to include in the vocabulary.
:param table_uri: A table of phrases and pronunciation hints to include in the
vocabulary.
"""
try:
vocab_args = {"VocabularyName": vocabulary_name, "LanguageCode": language_code}
if phrases is not None:
vocab_args["Phrases"] = phrases
elif table_uri is not None:
vocab_args["VocabularyFileUri"] = table_uri
response = transcribe_client.update_vocabulary(**vocab_args)
logger.info("Updated custom vocabulary %s.", response["VocabularyName"])
except ClientError:
logger.exception("Couldn't update custom vocabulary %s.", vocabulary_name)
raise
```
+ For API details, see [UpdateVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/UpdateVocabulary) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
IF it_phrases IS NOT INITIAL.
oo_result = lo_tnb->updatevocabulary(
iv_vocabularyname = iv_vocabulary_name
iv_languagecode = iv_language_code
it_phrases = it_phrases ).
ELSEIF iv_vocab_file_uri IS NOT INITIAL.
oo_result = lo_tnb->updatevocabulary(
iv_vocabularyname = iv_vocabulary_name
iv_languagecode = iv_language_code
iv_vocabularyfileuri = iv_vocab_file_uri ).
ENDIF.
MESSAGE 'Vocabulary updated.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
CATCH /aws1/cx_tnblimitexceededex INTO DATA(lo_limit_ex).
MESSAGE lo_limit_ex TYPE 'I'.
RAISE EXCEPTION lo_limit_ex.
CATCH /aws1/cx_tnbnotfoundexception INTO DATA(lo_not_found_ex).
MESSAGE lo_not_found_ex TYPE 'I'.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
CATCH /aws1/cx_tnbconflictexception INTO DATA(lo_conflict_ex).
MESSAGE lo_conflict_ex TYPE 'I'.
RAISE EXCEPTION lo_conflict_ex.
ENDTRY.
```
+ For API details, see [UpdateVocabulary](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Scenarios for Amazon Transcribe using AWS SDKs
The following code examples show you how to implement common scenarios in Amazon Transcribe with AWS SDKs. These scenarios show you how to accomplish specific tasks by calling multiple functions within Amazon Transcribe or combined with other AWS services. Each scenario includes a link to the complete source code, where you can find instructions on how to set up and run the code.
Scenarios target an intermediate level of experience to help you understand service actions in context.
**Topics**
+ [Build an Amazon Transcribe streaming app](transcribe_example_cross_TranscriptionStreamingApp_section.md)
+ [Convert text to speech and back to text](transcribe_example_cross_Telephone_section.md)
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
+ [Transcribe audio and get job data](transcribe_example_transcribe_Scenario_GettingStartedTranscriptionJobs_section.md)
# Build an Amazon Transcribe streaming app
The following code example shows how to build an app that records, transcribes, and translates live audio in real-time, and emails the results.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
Shows how to use Amazon Transcribe to build an app that records, transcribes, and translates live audio in real-time, and emails the results using Amazon Simple Email Service (Amazon SES).
For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/transcribe-streaming-app).
**Services used in this example**
+ Amazon Comprehend
+ Amazon SES
+ Amazon Transcribe
+ Amazon Translate
------
# Convert text to speech and back to text using an AWS SDK
The following code example shows how to:
+ Use Amazon Polly to synthesize a plain text (UTF-8) input file to an audio file.
+ Upload the audio file to an Amazon S3 bucket.
+ Use Amazon Transcribe to convert the audio file to text.
+ Display the text.
------
#### [ Rust ]
**SDK for Rust**
Use Amazon Polly to synthesize a plain text (UTF-8) input file to an audio file, upload the audio file to an Amazon S3 bucket, use Amazon Transcribe to convert that audio file to text, and display the text.
For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/rustv1/cross_service#code-examples).
**Services used in this example**
+ Amazon Polly
+ Amazon S3
+ Amazon Transcribe
------
# Create and refine an Amazon Transcribe custom vocabulary using an AWS SDK
The following code example shows how to:
+ Upload an audio file to Amazon S3.
+ Run an Amazon Transcribe job to transcribe the file and get the results.
+ Create and refine a custom vocabulary to improve transcription accuracy.
+ Run jobs with custom vocabularies and get the results.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
Transcribe an audio file that contains a reading of Jabberwocky by Lewis Carroll. Start by creating functions that wrap Amazon Transcribe actions.
```
def start_job(
job_name,
media_uri,
media_format,
language_code,
transcribe_client,
vocabulary_name=None,
):
"""
Starts a transcription job. This function returns as soon as the job is started.
To get the current status of the job, call get_transcription_job. The job is
successfully completed when the job status is 'COMPLETED'.
:param job_name: The name of the transcription job. This must be unique for
your AWS account.
:param media_uri: The URI where the audio file is stored. This is typically
in an Amazon S3 bucket.
:param media_format: The format of the audio file. For example, mp3 or wav.
:param language_code: The language code of the audio file.
For example, en-US or ja-JP
:param transcribe_client: The Boto3 Transcribe client.
:param vocabulary_name: The name of a custom vocabulary to use when transcribing
the audio file.
:return: Data about the job.
"""
try:
job_args = {
"TranscriptionJobName": job_name,
"Media": {"MediaFileUri": media_uri},
"MediaFormat": media_format,
"LanguageCode": language_code,
}
if vocabulary_name is not None:
job_args["Settings"] = {"VocabularyName": vocabulary_name}
response = transcribe_client.start_transcription_job(**job_args)
job = response["TranscriptionJob"]
logger.info("Started transcription job %s.", job_name)
except ClientError:
logger.exception("Couldn't start transcription job %s.", job_name)
raise
else:
return job
def get_job(job_name, transcribe_client):
"""
Gets details about a transcription job.
:param job_name: The name of the job to retrieve.
:param transcribe_client: The Boto3 Transcribe client.
:return: The retrieved transcription job.
"""
try:
response = transcribe_client.get_transcription_job(
TranscriptionJobName=job_name
)
job = response["TranscriptionJob"]
logger.info("Got job %s.", job["TranscriptionJobName"])
except ClientError:
logger.exception("Couldn't get job %s.", job_name)
raise
else:
return job
def delete_job(job_name, transcribe_client):
"""
Deletes a transcription job. This also deletes the transcript associated with
the job.
:param job_name: The name of the job to delete.
:param transcribe_client: The Boto3 Transcribe client.
"""
try:
transcribe_client.delete_transcription_job(TranscriptionJobName=job_name)
logger.info("Deleted job %s.", job_name)
except ClientError:
logger.exception("Couldn't delete job %s.", job_name)
raise
def create_vocabulary(
vocabulary_name, language_code, transcribe_client, phrases=None, table_uri=None
):
"""
Creates a custom vocabulary that can be used to improve the accuracy of
transcription jobs. This function returns as soon as the vocabulary processing
is started. Call get_vocabulary to get the current status of the vocabulary.
The vocabulary is ready to use when its status is 'READY'.
:param vocabulary_name: The name of the custom vocabulary.
:param language_code: The language code of the vocabulary.
For example, en-US or nl-NL.
:param transcribe_client: The Boto3 Transcribe client.
:param phrases: A list of comma-separated phrases to include in the vocabulary.
:param table_uri: A table of phrases and pronunciation hints to include in the
vocabulary.
:return: Information about the newly created vocabulary.
"""
try:
vocab_args = {"VocabularyName": vocabulary_name, "LanguageCode": language_code}
if phrases is not None:
vocab_args["Phrases"] = phrases
elif table_uri is not None:
vocab_args["VocabularyFileUri"] = table_uri
response = transcribe_client.create_vocabulary(**vocab_args)
logger.info("Created custom vocabulary %s.", response["VocabularyName"])
except ClientError:
logger.exception("Couldn't create custom vocabulary %s.", vocabulary_name)
raise
else:
return response
def get_vocabulary(vocabulary_name, transcribe_client):
"""
Gets information about a custom vocabulary.
:param vocabulary_name: The name of the vocabulary to retrieve.
:param transcribe_client: The Boto3 Transcribe client.
:return: Information about the vocabulary.
"""
try:
response = transcribe_client.get_vocabulary(VocabularyName=vocabulary_name)
logger.info("Got vocabulary %s.", response["VocabularyName"])
except ClientError:
logger.exception("Couldn't get vocabulary %s.", vocabulary_name)
raise
else:
return response
def update_vocabulary(
vocabulary_name, language_code, transcribe_client, phrases=None, table_uri=None
):
"""
Updates an existing custom vocabulary. The entire vocabulary is replaced with
the contents of the update.
:param vocabulary_name: The name of the vocabulary to update.
:param language_code: The language code of the vocabulary.
:param transcribe_client: The Boto3 Transcribe client.
:param phrases: A list of comma-separated phrases to include in the vocabulary.
:param table_uri: A table of phrases and pronunciation hints to include in the
vocabulary.
"""
try:
vocab_args = {"VocabularyName": vocabulary_name, "LanguageCode": language_code}
if phrases is not None:
vocab_args["Phrases"] = phrases
elif table_uri is not None:
vocab_args["VocabularyFileUri"] = table_uri
response = transcribe_client.update_vocabulary(**vocab_args)
logger.info("Updated custom vocabulary %s.", response["VocabularyName"])
except ClientError:
logger.exception("Couldn't update custom vocabulary %s.", vocabulary_name)
raise
def list_vocabularies(vocabulary_filter, transcribe_client):
"""
Lists the custom vocabularies created for this AWS account.
:param vocabulary_filter: The returned vocabularies must contain this string in
their names.
:param transcribe_client: The Boto3 Transcribe client.
:return: The list of retrieved vocabularies.
"""
try:
response = transcribe_client.list_vocabularies(NameContains=vocabulary_filter)
vocabs = response["Vocabularies"]
next_token = response.get("NextToken")
while next_token is not None:
response = transcribe_client.list_vocabularies(
NameContains=vocabulary_filter, NextToken=next_token
)
vocabs += response["Vocabularies"]
next_token = response.get("NextToken")
logger.info(
"Got %s vocabularies with filter %s.", len(vocabs), vocabulary_filter
)
except ClientError:
logger.exception(
"Couldn't list vocabularies with filter %s.", vocabulary_filter
)
raise
else:
return vocabs
def delete_vocabulary(vocabulary_name, transcribe_client):
"""
Deletes a custom vocabulary.
:param vocabulary_name: The name of the vocabulary to delete.
:param transcribe_client: The Boto3 Transcribe client.
"""
try:
transcribe_client.delete_vocabulary(VocabularyName=vocabulary_name)
logger.info("Deleted vocabulary %s.", vocabulary_name)
except ClientError:
logger.exception("Couldn't delete vocabulary %s.", vocabulary_name)
raise
```
Call the wrapper functions to transcribe audio without a custom vocabulary and then with different versions of a custom vocabulary to see improved results.
```
def usage_demo():
"""Shows how to use the Amazon Transcribe service."""
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
s3_resource = boto3.resource("s3")
transcribe_client = boto3.client("transcribe")
print("-" * 88)
print("Welcome to the Amazon Transcribe demo!")
print("-" * 88)
bucket_name = f"jabber-bucket-{time.time_ns()}"
print(f"Creating bucket {bucket_name}.")
bucket = s3_resource.create_bucket(
Bucket=bucket_name,
CreateBucketConfiguration={
"LocationConstraint": transcribe_client.meta.region_name
},
)
media_file_name = ".media/Jabberwocky.mp3"
media_object_key = "Jabberwocky.mp3"
print(f"Uploading media file {media_file_name}.")
bucket.upload_file(media_file_name, media_object_key)
media_uri = f"s3://{bucket.name}/{media_object_key}"
job_name_simple = f"Jabber-{time.time_ns()}"
print(f"Starting transcription job {job_name_simple}.")
start_job(
job_name_simple,
f"s3://{bucket_name}/{media_object_key}",
"mp3",
"en-US",
transcribe_client,
)
transcribe_waiter = TranscribeCompleteWaiter(transcribe_client)
transcribe_waiter.wait(job_name_simple)
job_simple = get_job(job_name_simple, transcribe_client)
transcript_simple = requests.get(
job_simple["Transcript"]["TranscriptFileUri"]
).json()
print(f"Transcript for job {transcript_simple['jobName']}:")
print(transcript_simple["results"]["transcripts"][0]["transcript"])
print("-" * 88)
print(
"Creating a custom vocabulary that lists the nonsense words to try to "
"improve the transcription."
)
vocabulary_name = f"Jabber-vocabulary-{time.time_ns()}"
create_vocabulary(
vocabulary_name,
"en-US",
transcribe_client,
phrases=[
"brillig",
"slithy",
"borogoves",
"mome",
"raths",
"Jub-Jub",
"frumious",
"manxome",
"Tumtum",
"uffish",
"whiffling",
"tulgey",
"thou",
"frabjous",
"callooh",
"callay",
"chortled",
],
)
vocabulary_ready_waiter = VocabularyReadyWaiter(transcribe_client)
vocabulary_ready_waiter.wait(vocabulary_name)
job_name_vocabulary_list = f"Jabber-vocabulary-list-{time.time_ns()}"
print(f"Starting transcription job {job_name_vocabulary_list}.")
start_job(
job_name_vocabulary_list,
media_uri,
"mp3",
"en-US",
transcribe_client,
vocabulary_name,
)
transcribe_waiter.wait(job_name_vocabulary_list)
job_vocabulary_list = get_job(job_name_vocabulary_list, transcribe_client)
transcript_vocabulary_list = requests.get(
job_vocabulary_list["Transcript"]["TranscriptFileUri"]
).json()
print(f"Transcript for job {transcript_vocabulary_list['jobName']}:")
print(transcript_vocabulary_list["results"]["transcripts"][0]["transcript"])
print("-" * 88)
print(
"Updating the custom vocabulary with table data that provides additional "
"pronunciation hints."
)
table_vocab_file = "jabber-vocabulary-table.txt"
bucket.upload_file(table_vocab_file, table_vocab_file)
update_vocabulary(
vocabulary_name,
"en-US",
transcribe_client,
table_uri=f"s3://{bucket.name}/{table_vocab_file}",
)
vocabulary_ready_waiter.wait(vocabulary_name)
job_name_vocab_table = f"Jabber-vocab-table-{time.time_ns()}"
print(f"Starting transcription job {job_name_vocab_table}.")
start_job(
job_name_vocab_table,
media_uri,
"mp3",
"en-US",
transcribe_client,
vocabulary_name=vocabulary_name,
)
transcribe_waiter.wait(job_name_vocab_table)
job_vocab_table = get_job(job_name_vocab_table, transcribe_client)
transcript_vocab_table = requests.get(
job_vocab_table["Transcript"]["TranscriptFileUri"]
).json()
print(f"Transcript for job {transcript_vocab_table['jobName']}:")
print(transcript_vocab_table["results"]["transcripts"][0]["transcript"])
print("-" * 88)
print("Getting data for jobs and vocabularies.")
jabber_jobs = list_jobs("Jabber", transcribe_client)
print(f"Found {len(jabber_jobs)} jobs:")
for job_sum in jabber_jobs:
job = get_job(job_sum["TranscriptionJobName"], transcribe_client)
print(
f"\t{job['TranscriptionJobName']}, {job['Media']['MediaFileUri']}, "
f"{job['Settings'].get('VocabularyName')}"
)
jabber_vocabs = list_vocabularies("Jabber", transcribe_client)
print(f"Found {len(jabber_vocabs)} vocabularies:")
for vocab_sum in jabber_vocabs:
vocab = get_vocabulary(vocab_sum["VocabularyName"], transcribe_client)
vocab_content = requests.get(vocab["DownloadUri"]).text
print(f"\t{vocab['VocabularyName']} contents:")
print(vocab_content)
print("-" * 88)
print("Deleting demo jobs.")
for job_name in [job_name_simple, job_name_vocabulary_list, job_name_vocab_table]:
delete_job(job_name, transcribe_client)
print("Deleting demo vocabulary.")
delete_vocabulary(vocabulary_name, transcribe_client)
print("Deleting demo bucket.")
bucket.objects.delete()
bucket.delete()
print("Thanks for watching!")
```
+ For API details, see the following topics in *AWS SDK for Python (Boto3) API Reference*.
+ [CreateVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/CreateVocabulary)
+ [DeleteTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/DeleteTranscriptionJob)
+ [DeleteVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/DeleteVocabulary)
+ [GetTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/GetTranscriptionJob)
+ [GetVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/GetVocabulary)
+ [ListVocabularies](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/ListVocabularies)
+ [StartTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/StartTranscriptionJob)
+ [UpdateVocabulary](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/UpdateVocabulary)
------
# Transcribe audio and get job data with Amazon Transcribe using an AWS SDK
The following code examples show how to:
+ Start a transcription job with Amazon Transcribe.
+ Wait for the job to complete.
+ Get the URI where the transcript is stored.
For more information, see [Getting started with Amazon Transcribe](https://docs.aws.amazon.com/transcribe/latest/dg/getting-started.html).
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/transcribe#code-examples).
Transcribes a PCM file.
```
/**
* To run this AWS code example, ensure that you have set up your development
* environment, including your AWS credentials.
*
* For information, see this documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class TranscribeStreamingDemoFile {
private static final Region REGION = Region.US_EAST_1;
private static TranscribeStreamingAsyncClient client;
public static void main(String args[]) throws ExecutionException, InterruptedException {
final String USAGE = "\n" +
"Usage:\n" +
" \n\n" +
"Where:\n" +
" file - the location of a PCM file to transcribe. In this example, ensure the PCM file is 16 hertz (Hz). \n";
if (args.length != 1) {
System.out.println(USAGE);
System.exit(1);
}
String file = args[0];
client = TranscribeStreamingAsyncClient.builder()
.region(REGION)
.build();
CompletableFuture result = client.startStreamTranscription(getRequest(16_000),
new AudioStreamPublisher(getStreamFromFile(file)),
getResponseHandler());
result.get();
client.close();
}
private static InputStream getStreamFromFile(String file) {
try {
File inputFile = new File(file);
InputStream audioStream = new FileInputStream(inputFile);
return audioStream;
} catch (FileNotFoundException e) {
throw new RuntimeException(e);
}
}
private static StartStreamTranscriptionRequest getRequest(Integer mediaSampleRateHertz) {
return StartStreamTranscriptionRequest.builder()
.languageCode(LanguageCode.EN_US)
.mediaEncoding(MediaEncoding.PCM)
.mediaSampleRateHertz(mediaSampleRateHertz)
.build();
}
private static StartStreamTranscriptionResponseHandler getResponseHandler() {
return StartStreamTranscriptionResponseHandler.builder()
.onResponse(r -> {
System.out.println("Received Initial response");
})
.onError(e -> {
System.out.println(e.getMessage());
StringWriter sw = new StringWriter();
e.printStackTrace(new PrintWriter(sw));
System.out.println("Error Occurred: " + sw.toString());
})
.onComplete(() -> {
System.out.println("=== All records stream successfully ===");
})
.subscriber(event -> {
List results = ((TranscriptEvent) event).transcript().results();
if (results.size() > 0) {
if (!results.get(0).alternatives().get(0).transcript().isEmpty()) {
System.out.println(results.get(0).alternatives().get(0).transcript());
}
}
})
.build();
}
private static class AudioStreamPublisher implements Publisher {
private final InputStream inputStream;
private static Subscription currentSubscription;
private AudioStreamPublisher(InputStream inputStream) {
this.inputStream = inputStream;
}
@Override
public void subscribe(Subscriber s) {
if (this.currentSubscription == null) {
this.currentSubscription = new SubscriptionImpl(s, inputStream);
} else {
this.currentSubscription.cancel();
this.currentSubscription = new SubscriptionImpl(s, inputStream);
}
s.onSubscribe(currentSubscription);
}
}
public static class SubscriptionImpl implements Subscription {
private static final int CHUNK_SIZE_IN_BYTES = 1024 * 1;
private final Subscriber subscriber;
private final InputStream inputStream;
private ExecutorService executor = Executors.newFixedThreadPool(1);
private AtomicLong demand = new AtomicLong(0);
SubscriptionImpl(Subscriber s, InputStream inputStream) {
this.subscriber = s;
this.inputStream = inputStream;
}
@Override
public void request(long n) {
if (n <= 0) {
subscriber.onError(new IllegalArgumentException("Demand must be positive"));
}
demand.getAndAdd(n);
executor.submit(() -> {
try {
do {
ByteBuffer audioBuffer = getNextEvent();
if (audioBuffer.remaining() > 0) {
AudioEvent audioEvent = audioEventFromBuffer(audioBuffer);
subscriber.onNext(audioEvent);
} else {
subscriber.onComplete();
break;
}
} while (demand.decrementAndGet() > 0);
} catch (Exception e) {
subscriber.onError(e);
}
});
}
@Override
public void cancel() {
executor.shutdown();
}
private ByteBuffer getNextEvent() {
ByteBuffer audioBuffer = null;
byte[] audioBytes = new byte[CHUNK_SIZE_IN_BYTES];
int len = 0;
try {
len = inputStream.read(audioBytes);
if (len <= 0) {
audioBuffer = ByteBuffer.allocate(0);
} else {
audioBuffer = ByteBuffer.wrap(audioBytes, 0, len);
}
} catch (IOException e) {
throw new UncheckedIOException(e);
}
return audioBuffer;
}
private AudioEvent audioEventFromBuffer(ByteBuffer bb) {
return AudioEvent.builder()
.audioChunk(SdkBytes.fromByteBuffer(bb))
.build();
}
}
}
```
Transcribes streaming audio from your computer's microphone.
```
public class TranscribeStreamingDemoApp {
private static final Region REGION = Region.US_EAST_1;
private static TranscribeStreamingAsyncClient client;
public static void main(String[] args)
throws URISyntaxException, ExecutionException, InterruptedException, LineUnavailableException {
client = TranscribeStreamingAsyncClient.builder()
.credentialsProvider(getCredentials())
.region(REGION)
.build();
CompletableFuture result = client.startStreamTranscription(getRequest(16_000),
new AudioStreamPublisher(getStreamFromMic()),
getResponseHandler());
result.get();
client.close();
}
private static InputStream getStreamFromMic() throws LineUnavailableException {
// Signed PCM AudioFormat with 16kHz, 16 bit sample size, mono
int sampleRate = 16000;
AudioFormat format = new AudioFormat(sampleRate, 16, 1, true, false);
DataLine.Info info = new DataLine.Info(TargetDataLine.class, format);
if (!AudioSystem.isLineSupported(info)) {
System.out.println("Line not supported");
System.exit(0);
}
TargetDataLine line = (TargetDataLine) AudioSystem.getLine(info);
line.open(format);
line.start();
InputStream audioStream = new AudioInputStream(line);
return audioStream;
}
private static AwsCredentialsProvider getCredentials() {
return DefaultCredentialsProvider.create();
}
private static StartStreamTranscriptionRequest getRequest(Integer mediaSampleRateHertz) {
return StartStreamTranscriptionRequest.builder()
.languageCode(LanguageCode.EN_US.toString())
.mediaEncoding(MediaEncoding.PCM)
.mediaSampleRateHertz(mediaSampleRateHertz)
.build();
}
private static StartStreamTranscriptionResponseHandler getResponseHandler() {
return StartStreamTranscriptionResponseHandler.builder()
.onResponse(r -> {
System.out.println("Received Initial response");
})
.onError(e -> {
System.out.println(e.getMessage());
StringWriter sw = new StringWriter();
e.printStackTrace(new PrintWriter(sw));
System.out.println("Error Occurred: " + sw);
})
.onComplete(() -> {
System.out.println("=== All records stream successfully ===");
})
.subscriber(event -> {
List results = ((TranscriptEvent) event).transcript().results();
if (results.size() > 0) {
if (!results.get(0).alternatives().get(0).transcript().isEmpty()) {
System.out.println(results.get(0).alternatives().get(0).transcript());
}
}
})
.build();
}
private static class AudioStreamPublisher implements Publisher {
private static Subscription currentSubscription;
private final InputStream inputStream;
private AudioStreamPublisher(InputStream inputStream) {
this.inputStream = inputStream;
}
@Override
public void subscribe(Subscriber s) {
if (currentSubscription == null) {
currentSubscription = new SubscriptionImpl(s, inputStream);
} else {
currentSubscription.cancel();
currentSubscription = new SubscriptionImpl(s, inputStream);
}
s.onSubscribe(currentSubscription);
}
}
public static class SubscriptionImpl implements Subscription {
private static final int CHUNK_SIZE_IN_BYTES = 1024;
private final Subscriber subscriber;
private final InputStream inputStream;
private final ExecutorService executor = Executors.newFixedThreadPool(1);
private final AtomicLong demand = new AtomicLong(0);
SubscriptionImpl(Subscriber s, InputStream inputStream) {
this.subscriber = s;
this.inputStream = inputStream;
}
@Override
public void request(long n) {
if (n <= 0) {
subscriber.onError(new IllegalArgumentException("Demand must be positive"));
}
demand.getAndAdd(n);
executor.submit(() -> {
try {
do {
ByteBuffer audioBuffer = getNextEvent();
if (audioBuffer.remaining() > 0) {
AudioEvent audioEvent = audioEventFromBuffer(audioBuffer);
subscriber.onNext(audioEvent);
} else {
subscriber.onComplete();
break;
}
} while (demand.decrementAndGet() > 0);
} catch (Exception e) {
subscriber.onError(e);
}
});
}
@Override
public void cancel() {
executor.shutdown();
}
private ByteBuffer getNextEvent() {
ByteBuffer audioBuffer = null;
byte[] audioBytes = new byte[CHUNK_SIZE_IN_BYTES];
int len = 0;
try {
len = inputStream.read(audioBytes);
if (len <= 0) {
audioBuffer = ByteBuffer.allocate(0);
} else {
audioBuffer = ByteBuffer.wrap(audioBytes, 0, len);
}
} catch (IOException e) {
throw new UncheckedIOException(e);
}
return audioBuffer;
}
private AudioEvent audioEventFromBuffer(ByteBuffer bb) {
return AudioEvent.builder()
.audioChunk(SdkBytes.fromByteBuffer(bb))
.build();
}
}
}
```
+ For API details, see the following topics in *AWS SDK for Java 2.x API Reference*.
+ [GetTranscriptionJob](https://docs.aws.amazon.com/goto/SdkForJavaV2/transcribe-2017-10-26/GetTranscriptionJob)
+ [StartTranscriptionJob](https://docs.aws.amazon.com/goto/SdkForJavaV2/transcribe-2017-10-26/StartTranscriptionJob)
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
import time
import boto3
def transcribe_file(job_name, file_uri, transcribe_client):
transcribe_client.start_transcription_job(
TranscriptionJobName=job_name,
Media={"MediaFileUri": file_uri},
MediaFormat="wav",
LanguageCode="en-US",
)
max_tries = 60
while max_tries > 0:
max_tries -= 1
job = transcribe_client.get_transcription_job(TranscriptionJobName=job_name)
job_status = job["TranscriptionJob"]["TranscriptionJobStatus"]
if job_status in ["COMPLETED", "FAILED"]:
print(f"Job {job_name} is {job_status}.")
if job_status == "COMPLETED":
print(
f"Download the transcript from\n"
f"\t{job['TranscriptionJob']['Transcript']['TranscriptFileUri']}."
)
break
else:
print(f"Waiting for {job_name}. Current status is {job_status}.")
time.sleep(10)
def main():
transcribe_client = boto3.client("transcribe")
file_uri = "s3://test-transcribe/answer2.wav"
transcribe_file("Example-job", file_uri, transcribe_client)
if __name__ == "__main__":
main()
```
+ For API details, see the following topics in *AWS SDK for Python (Boto3) API Reference*.
+ [GetTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/GetTranscriptionJob)
+ [StartTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/StartTranscriptionJob)
------