Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/farski/serverless-transcribe

A simple UI for Amazon Transcribe
https://github.com/farski/serverless-transcribe

aws aws-transcribe serverless transcription

Last synced: about 1 month ago
JSON representation

A simple UI for Amazon Transcribe

Awesome Lists containing this project

README 

        
# serverless-transcribe



A simple, serverless web UI for [Amazon Transcribe](https://aws.amazon.com/transcribe/). Supports WAV, FLAC, AMR, MP3, MP4, Ogg (Opus), and WebM audio without any fixed costs.



## How it Works



Once the project has been launched in [CloudFormation](https://aws.amazon.com/cloudformation/), you will have access to a webpage that allows users to upload audio files. The page uploads the files [directly](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-UsingHTTPPOST.html) to [S3](https://aws.amazon.com/s3/). The S3 bucket is configured to watch for audio files. When it sees new audio files, an [AWS Lambda](https://aws.amazon.com/lambda/) function is invoked, which starts a transcription job.



File detection is based on the file extension. Supported extensions are: `.wav`, `.flac`, `.amr`, `.3ga`, `.mp3`, `.mp4`, `.m4a`, `.oga`, `.ogg`, `.opus`, and `.webm`.



Another Lambda function is triggered via [EventBridge event](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html) when the transcription job completes (or fails). An email is sent to the user who uploaded file with details about the job failure, or a raw transcript that is extracted from the job results.



The webpage is protected by HTTP Basic authentication, with a single set of credentials that you set when launching the stack. This is handled by an authorizer on the [API Gateway](https://aws.amazon.com/api-gateway/), and could be extended to allow for more robust authorization schemes.



Amazon Transcribe currently has file limits of 4 hours and 2 GB.



### AWS Costs



The cost of running and using this project are almost entirely based on usage. Media files uploaded to S3 are set to expire after one day, and the resulting files in the transcripts bucket expire after 30 days. The Lambda functions have no fixed costs, so you will only be charged when they are invoked. Amazon Transcribe is "[pay-as-you-go](https://aws.amazon.com/transcribe/pricing/) based on the seconds of audio transcribed per month".



Most resources created from the CloudFormation template include a `Project` resource tag, which you can use for cost allocation. Transcription jobs also include this tag, and can include an optional tag defined using stack parameters.



## How to Use



The project is organized using a [SAM](https://aws.amazon.com/serverless/sam/) CloudFormation [template](https://github.com/farski/serverless-transcribe/blob/master/template.yaml). Launching a stack from this template will create all the resources necessary for the system to work.



### Requirements



- The stack must be launched in an AWS [region](https://docs.aws.amazon.com/general/latest/gr/ses.html) that supports [SES](https://aws.amazon.com/ses/). The addresses that SES will send to and from are determined by your SES domain verification and sandboxing status.



### Deploying from the AWS Serverless Application Repository



The application can be deployed from the [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com/applications/us-east-1/087822466452/serverless-transcribe) into your own AWS account. This is the easiest way to get started with serverless-transcribe.



### Using the SAM CLI to deploy



The app can also be deployed using the  [AWS SAM CLI](https://github.com/awslabs/aws-sam-cli). Once the CLI is [installed](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html), you can run `sam deploy --guided` in the project directory to deploy the application. (After the first deploy, you can use `sam deploy` if `samconfig.toml` is present in the directory.)



Any other deployment method that is compatible with SAM templates would also work.



_Note: The deploy script that was previously included in the project is no longer supported._