[适用于 JavaScript 的 AWS SDK V3 API 参考指南](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/)详细描述了 适用于 JavaScript 的 AWS SDK 版本 3 (V3) 的所有 API 操作。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# Amazon Transcribe 示例
Amazon Transcribe 使开发人员能够轻松地向其应用程序添加语音到文本转换功能。
![\[JavaScript 环境、软件开发工具包和 Amazon Transcribe 之间的关系\]](http://docs.aws.amazon.com/zh_cn/sdk-for-javascript/v3/developer-guide/images/code-samples-transcribe.png)
Amazon Transcribe 的 JavaScript API 通过[TranscribeService](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/Transcribe/)客户端类公开。
**Topics**
+ [Amazon Transcribe 示例](transcribe-examples-section.md)
+ [Amazon Transcribe Medical 示例](transcribe-medical-examples-section.md)
# Amazon Transcribe 示例
在此示例中，使用一系列 Node.js 模块通过 `TranscribeService` 客户端类的以下方法创建、列出和删除转录作业：
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/StartTranscriptionJobCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/StartTranscriptionJobCommand/)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/ListTranscriptionJobsCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/ListTranscriptionJobsCommand/)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteTranscriptionJobCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteTranscriptionJobCommand/)
有关 Amazon Transcribe 的更多信息，请参阅 [Amazon Transcribe 开发人员指南](https://docs.aws.amazon.com//transcribe/latest/dg/what-is-transcribe.html)。
## 先决条件任务
要设置和运行此示例，您必须先完成以下任务：
+ 设置项目环境以运行这些 Node TypeScript 示例，并安装所需的模块 适用于 JavaScript 的 AWS SDK 和第三方模块。按照上的说明进行操作[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/README.md)。
+ 使用用户凭证创建共享配置文件。有关提供共享凭据文件的更多信息，请参阅[和*工具参考指南中的共享配置AWS SDKs 和*凭据文件](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html)。
**重要**
这些示例演示了如何使用 ECMAScript6 (ES6) 来 import/export 客户端服务对象和命令。
这需要使用 Node.js 版本 13.x 或更高版本。要下载并安装最新版本的 Node.js，请参阅 [Node.js 下载](https://nodejs.org/en/download)。
如果您更喜欢使用 CommonJS 语法，请参阅 [JavaScript ES6/CommonJS 语法](sdk-example-javascript-syntax.md)
## 启动 Amazon Transcribe 作业
此示例演示如何使用 适用于 JavaScript 的 AWS SDK启动 Amazon Transcribe 转录作业。有关更多信息，请参阅 [StartTranscriptionJobCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/StartTranscriptionJobCommand/)。
创建一个 `libs` 目录，然后使用文件名 `transcribeClient.js` 创建一个 Node.js 模块。将以下代码复制并粘贴到其中，这将创建 Amazon Transcribe 客户端对象。*REGION*替换为您所在 AWS 的地区。
```
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 };
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/libs/transcribeClient.js)示例代码 GitHub。
创建文件名为 `transcribe-create-job.js` 的 Node.js 模块。确保如前所示配置 SDK，包括安装所需的客户端和软件包。创建一个参数对象，指定所需的参数。使用 `StartMedicalTranscriptionJobCommand` 命令启动作业。
**注意**
*MEDICAL\$1JOB\$1NAME*替换为转录作业的名称。为此，*OUTPUT\$1BUCKET\$1NAME*请指定保存输出的 Amazon S3 存储桶。用于*JOB\$1TYPE*指定作业类型。用于*SOURCE\$1LOCATION*指定源文件的位置。用于*SOURCE\$1FILE\$1LOCATION*指定输入媒体文件的位置。
```
// 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();
```
要运行示例，请在命令提示符中键入以下内容。
```
node transcribe-create-job.js
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/transcribe_create_job.js)示例代码 GitHub。
## 列出 Amazon Transcribe 作业
此示例演示如何使用 适用于 JavaScript 的 AWS SDK列出 Amazon Transcribe 转录作业。有关您可以修改的其他设置的更多信息，请参阅 [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/ListTranscriptionJobsCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/ListTranscriptionJobsCommand/)。
创建一个 `libs` 目录，然后使用文件名 `transcribeClient.js` 创建一个 Node.js 模块。将以下代码复制并粘贴到其中，这将创建 Amazon Transcribe 客户端对象。*REGION*替换为您所在 AWS 的地区。
```
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 };
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/libs/transcribeClient.js)示例代码 GitHub。
创建文件名为 `transcribe-list-jobs.js` 的 Node.js 模块。确保如前所示配置 SDK，包括安装所需的客户端和软件包。使用所需参数创建参数对象。
**注意**
*KEY\$1WORD*替换为返回的作业名称必须包含的关键字。
```
// 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();
```
要运行示例，请在命令提示符中键入以下内容。
```
node transcribe-list-jobs.js
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/transcribe_list_jobs.js)示例代码 GitHub。
## 删除 Amazon Transcribe 作业
此示例演示如何使用 适用于 JavaScript 的 AWS SDK删除 Amazon Transcribe 转录作业。有关选项的更多信息，请参阅 [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteTranscriptionJobCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteTranscriptionJobCommand/)。
创建一个 `libs` 目录，然后使用文件名 `transcribeClient.js` 创建一个 Node.js 模块。将以下代码复制并粘贴到其中，这将创建 Amazon Transcribe 客户端对象。*REGION*替换为您所在 AWS 的地区。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create Transcribe service object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/libs/transcribeClient.js)示例代码 GitHub。
创建文件名为 `transcribe-delete-job.js` 的 Node.js 模块。确保如前所示配置 SDK，包括安装所需的客户端和软件包。指定 AWS 区域以及要删除的任务的名称。
**注意**
*JOB\$1NAME*替换为要删除的作业的名称。
```
// 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();
```
要运行示例，请在命令提示符中键入以下内容。
```
node transcribe-delete-job.js
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/transcribe_delete_job.js)示例代码 GitHub。
# Amazon Transcribe Medical 示例
在此示例中，使用一系列 Node.js 模块通过 `TranscribeService` 客户端类的以下方法创建、列出和删除医疗转录作业：
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/StartMedicalTranscriptionJobCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/StartMedicalTranscriptionJobCommand/)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/ListTranscriptionJobsCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/ListTranscriptionJobsCommand/)
+ [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteTranscriptionJobCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteTranscriptionJobCommand/)
有关 Amazon Transcribe 的更多信息，请参阅 [Amazon Transcribe 开发人员指南](https://docs.aws.amazon.com//transcribe/latest/dg/what-is-transcribe.html)。
## 先决条件任务
要设置和运行此示例，您必须先完成以下任务：
+ 设置项目环境以运行这些 Node TypeScript 示例，并安装所需的模块 适用于 JavaScript 的 AWS SDK 和第三方模块。按照上的说明进行操作[ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/README.md)。
+ 使用用户凭证创建共享配置文件。有关提供共享凭据文件的更多信息，请参阅[和*工具参考指南中的共享配置AWS SDKs 和*凭据文件](https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html)。
**重要**
这些示例演示了如何使用 ECMAScript6 (ES6) 来 import/export 客户端服务对象和命令。
这需要使用 Node.js 版本 13.x 或更高版本。要下载并安装最新版本的 Node.js，请参阅 [Node.js 下载](https://nodejs.org/en/download)。
如果您更喜欢使用 CommonJS 语法，请参阅 [JavaScript ES6/CommonJS 语法](sdk-example-javascript-syntax.md)
## 启动 Amazon Transcribe Medical 转录作业
此示例演示如何使用 适用于 JavaScript 的 AWS SDK启动 Amazon Transcribe Medical 转录作业。有关更多信息，请参阅 [startMedicalTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/StartMedicalTranscriptionJobCommand/)。
创建一个 `libs` 目录，然后使用文件名 `transcribeClient.js` 创建一个 Node.js 模块。将以下代码复制并粘贴到其中，这将创建 Amazon Transcribe 客户端对象。*REGION*替换为您所在 AWS 的地区。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create Transcribe service object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/libs/transcribeClient.js)示例代码 GitHub。
创建文件名为 `transcribe-create-medical-job.js` 的 Node.js 模块。确保如前所示配置 SDK，包括安装所需的客户端和软件包。创建一个参数对象，指定所需的参数。使用 `StartMedicalTranscriptionJobCommand` 命令启动医疗作业。
**注意**
*MEDICAL\$1JOB\$1NAME*替换为医疗转录作业的名称。为此，*OUTPUT\$1BUCKET\$1NAME*请指定保存输出的 Amazon S3 存储桶。用于*JOB\$1TYPE*指定作业类型。用于*SOURCE\$1LOCATION*指定源文件的位置。用于*SOURCE\$1FILE\$1LOCATION*指定输入媒体文件的位置。
```
// 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();
```
要运行示例，请在命令提示符中键入以下内容。
```
node transcribe-create-medical-job.js
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/transcribe_create_medical_job.js)示例代码 GitHub。
## 列出 Amazon Transcribe Medical 作业
此示例演示如何使用 适用于 JavaScript 的 AWS SDK列出 Amazon Transcribe 转录作业。有关更多信息，请参阅 [ListTranscriptionMedicalJobsCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/ListMedicalTranscriptionJobsCommand/)。
创建一个 `libs` 目录，然后使用文件名 `transcribeClient.js` 创建一个 Node.js 模块。将以下代码复制并粘贴到其中，这将创建 Amazon Transcribe 客户端对象。*REGION*替换为您所在 AWS 的地区。
```
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 };
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/libs/transcribeClient.js)示例代码 GitHub。
创建文件名为 `transcribe-list-medical-jobs.js` 的 Node.js 模块。确保如前所示配置 SDK，包括安装所需的客户端和软件包。使用所需参数创建参数对象，并使用 `ListMedicalTranscriptionJobsCommand` 命令列出医疗作业。
**注意**
*KEYWORD*替换为返回的作业名称必须包含的关键字。
```
// Import the required AWS SDK clients and commands for Node.js
import { ListMedicalTranscriptionJobsCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
JobNameContains: "KEYWORD", // Returns only transcription job names containing this string
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new ListMedicalTranscriptionJobsCommand(params),
);
console.log("Success", data.MedicalTranscriptionJobName);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
要运行示例，请在命令提示符中键入以下内容。
```
node transcribe-list-medical-jobs.js
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/transcribe_list_medical_jobs.js)示例代码 GitHub。
## 删除 Amazon Transcribe Medical 作业
此示例演示如何使用 适用于 JavaScript 的 AWS SDK删除 Amazon Transcribe 转录作业。有关选项的更多信息，请参阅 [https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteMedicalTranscriptionJobCommand/](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-transcribe/Class/DeleteMedicalTranscriptionJobCommand/)。
创建一个 `libs` 目录，然后使用文件名 `transcribeClient.js` 创建一个 Node.js 模块。将以下代码复制并粘贴到其中，这将创建 Amazon Transcribe 客户端对象。*REGION*替换为您所在 AWS 的地区。
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create Transcribe service object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/libs/transcribeClient.js)示例代码 GitHub。
创建文件名为 `transcribe-delete-job.js` 的 Node.js 模块。确保如前所示配置 SDK，包括安装所需的客户端和软件包。使用所需参数创建参数对象，并使用 `DeleteMedicalJobCommand` 命令删除医疗作业。
**注意**
*JOB\$1NAME*替换为要删除的作业的名称。
```
// 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();
```
要运行示例，请在命令提示符中键入以下内容。
```
node transcribe-delete-medical-job.js
```
可以在此[处找到此](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/javascriptv3/example_code/transcribe/src/transcribe_delete_medical_job.js)示例代码 GitHub。