Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@aws-sdk/client-transcribe

Package Overview
Dependencies
Maintainers
5
Versions
424
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aws-sdk/client-transcribe

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

  • 3.712.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
80K
increased by18.21%
Maintainers
5
Weekly downloads
 
Created
Source

@aws-sdk/client-transcribe

Description

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

Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.

  • Standard transcriptions are the most common option. Refer to for details.

  • Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details.

  • Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.

Installing

To install this package, simply type add or install @aws-sdk/client-transcribe using your favorite package manager:

  • npm install @aws-sdk/client-transcribe
  • yarn add @aws-sdk/client-transcribe
  • pnpm add @aws-sdk/client-transcribe

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the TranscribeClient and the commands you need, for example ListVocabulariesCommand:

// ES5 example
const { TranscribeClient, ListVocabulariesCommand } = require("@aws-sdk/client-transcribe");
// ES6+ example
import { TranscribeClient, ListVocabulariesCommand } from "@aws-sdk/client-transcribe";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new TranscribeClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListVocabulariesCommand(params);
Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });
Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});
v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-transcribe";
const client = new AWS.Transcribe({ region: "REGION" });

// async/await.
try {
  const data = await client.listVocabularies(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listVocabularies(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listVocabularies(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-transcribe package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateCallAnalyticsCategory

Command API Reference / Input / Output

CreateLanguageModel

Command API Reference / Input / Output

CreateMedicalVocabulary

Command API Reference / Input / Output

CreateVocabulary

Command API Reference / Input / Output

CreateVocabularyFilter

Command API Reference / Input / Output

DeleteCallAnalyticsCategory

Command API Reference / Input / Output

DeleteCallAnalyticsJob

Command API Reference / Input / Output

DeleteLanguageModel

Command API Reference / Input / Output

DeleteMedicalScribeJob

Command API Reference / Input / Output

DeleteMedicalTranscriptionJob

Command API Reference / Input / Output

DeleteMedicalVocabulary

Command API Reference / Input / Output

DeleteTranscriptionJob

Command API Reference / Input / Output

DeleteVocabulary

Command API Reference / Input / Output

DeleteVocabularyFilter

Command API Reference / Input / Output

DescribeLanguageModel

Command API Reference / Input / Output

GetCallAnalyticsCategory

Command API Reference / Input / Output

GetCallAnalyticsJob

Command API Reference / Input / Output

GetMedicalScribeJob

Command API Reference / Input / Output

GetMedicalTranscriptionJob

Command API Reference / Input / Output

GetMedicalVocabulary

Command API Reference / Input / Output

GetTranscriptionJob

Command API Reference / Input / Output

GetVocabulary

Command API Reference / Input / Output

GetVocabularyFilter

Command API Reference / Input / Output

ListCallAnalyticsCategories

Command API Reference / Input / Output

ListCallAnalyticsJobs

Command API Reference / Input / Output

ListLanguageModels

Command API Reference / Input / Output

ListMedicalScribeJobs

Command API Reference / Input / Output

ListMedicalTranscriptionJobs

Command API Reference / Input / Output

ListMedicalVocabularies

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTranscriptionJobs

Command API Reference / Input / Output

ListVocabularies

Command API Reference / Input / Output

ListVocabularyFilters

Command API Reference / Input / Output

StartCallAnalyticsJob

Command API Reference / Input / Output

StartMedicalScribeJob

Command API Reference / Input / Output

StartMedicalTranscriptionJob

Command API Reference / Input / Output

StartTranscriptionJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateCallAnalyticsCategory

Command API Reference / Input / Output

UpdateMedicalVocabulary

Command API Reference / Input / Output

UpdateVocabulary

Command API Reference / Input / Output

UpdateVocabularyFilter

Command API Reference / Input / Output

FAQs

Package last updated on 13 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc