D-SER-T-CLI
Using the project
This CLI requires Microsoft speech service, a directory of audio files and a corresponding transcriptions text file.
Prerequisites
- Node.js
- Microsoft speech service subscription key.
- Speech service region
- Conditional Parameters
- endpoint-id; necessary to use custom speech
- Concurrent calls; generally < 20
- audio-directory
- transcription-file
- output-file
- audio-file
- Conditional Parameters
Install
npm install d-ser-t-cli
globally install with
npm install -g d-ser-t-cli
Flags used by CLI.
flag | alias | value |
---|---|---|
-s | subscription-key | Microsoft Speech Subscription Key |
-r | service-region | Speech Service Region |
-d | audio-directory [ optional ] | Path to Directory of wav files |
-e | endpoint-Id [ optional ] | Custom Speech Endpoint ID |
-t | transcription-file [ optional ] | Transcription File Path, .txt file |
-f | audio-file [ optional ] | singular audio file .wav for console logging Speech Transcription |
-o | out-file [ optional ] | test output file: location to save test results, only .json and .xml formats supported [ defaults to ./test_results.json ] |
-c | concurrent-calls | concurrent service calls [defaults to 1] |
Conflicts --> -f : (-d & -t) | Providing a singular file to transcribe, results in console log of transcription from service |
Notable Dependency
- creating a transcription file
- recording audio
Running
## individual filenpm run d-ser-t -- -s [string] -r [string] -f [string] ## audio directory with transcription filenpm run d-ser-t -- -s [string] -r [string] -d [string] -t [string] ## if globally installed;d-ser-t -s [string] -r [string] -f [string]d-ser-t -s [string] -r [string] -d [string] -t [string]
Contributing
Please read CONTRIBUTING.md for details on contributing, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning.