Files
tatt/README.md
2019-02-12 21:27:59 -05:00

95 lines
3.1 KiB
Markdown

# Transcribe All The Things™
Tatt creates a uniform API for multiple speech-to-text (STT) services.
## Installation
pip install tatt
## Dependencies
An AWS account (the only supported STT provider as of Feb 12, 2019), and a recording to transcribe!
## Usage
### List All Commands
transcribe --help
Usage: transcribe [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
get Downloads and/or saves completed transcript.
list Lists available STT services.
services Lists available speech-to-text services.
this Sends a media file to be transcribed.
### List All STT Services
transcribe services
Here are all the available speech-to-text services:
amazon (60 minutes per month for the first 12 months)
### Get Something Transcribed
transcribe this <path_to_media_file> <service_name>
Okay, transcribing /Users/zev/d/<job_name> using <service_name>...
Okay, job <job_name> is being transcribed. Use "get" command to download it.
### List Transcripts
transcribe list # a full list of all transcripts, completed and in_progress
Service Job Name Status
------- -------- ------
amazon tester.mp3 IN_PROGRESS
amazon messed_up.mp4 FAILED
amazon done_test.mp3 COMPLETED
amazon also_done.MP3 COMPLETED
transcribe list <job_name> # the status of a particular transcript
Service Job Name Status
------- -------- ------
amazon <job_name> IN_PROGRESS
### Get A Completed Transcript
transcript get <job_name> # prints to stdout
{'accountId': '416321668733',
'jobName': 'a1bace5e-8b08-4ce4-b08c-834a23aafcf1',
'results': {'items': [{'alternatives': [{'confidence': '0.9774',
'content': 'Hi'}],
'end_time': '1.5',
'start_time': '1.23',
'type': 'pronunciation'},
{'alternatives': [{'confidence': '0.9429',
'content': 'is'}],
'end_time': '1.71',
'start_time': '1.5',
'type': 'pronunciation'},
...
transcript get -f <job_name> # saves to a file in the format <job_name>.json
Okay, downloaded <job_name>.json
## Services Supported
- [Amazon Transcribe](https://aws.amazon.com/transcribe/)
### Planned
- [Watson](https://www.ibm.com/watson/services/speech-to-text/)
- [Google Speech](https://cloud.google.com/speech-to-text/)
- [Kaldi](https://github.com/kaldi-asr/kaldi) [ and/or things built on it ](https://github.com/lowerquality/gentle)
- [Speechmatics](https://www.speechmatics.com/)
- [Mozilla's new open-source STT thing](https://github.com/mozilla/DeepSpeech)