https://github.com/rxtoolkit/stt-assemblyai
👂 An RxJS operator for real-time speech-to-text (STT/S2T) streaming using the AssemblyAI STT API.
https://github.com/rxtoolkit/stt-assemblyai
incomplete package
Last synced: over 1 year ago
JSON representation
👂 An RxJS operator for real-time speech-to-text (STT/S2T) streaming using the AssemblyAI STT API.
- Host: GitHub
- URL: https://github.com/rxtoolkit/stt-assemblyai
- Owner: rxtoolkit
- Created: 2021-06-14T14:30:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T01:38:01.000Z (over 1 year ago)
- Last Synced: 2025-01-05T04:22:44.362Z (over 1 year ago)
- Topics: incomplete, package
- Language: JavaScript
- Homepage:
- Size: 3.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
Awesome Lists containing this project
README
# @buccaneerai/stt-assemblyai
> 👂 An RxJS operator for real-time speech-to-text (STT/S2T) streaming using the AssemblyAI STT API.
## Installation
This is a private package. It requires setting up access in your npm config.
```bash
yarn add @buccaneerai/stt-assemblyai
```
## Demo
To run the demo pipeline:
```bash
yarn demo:run
```
## API
### `toAssemblyAI`
```js
import {from} from 'rxjs';
import {toAssemblyAI} from '@buccaneerai/stt-assemblyai';
import {fromFile} from '@bottlenose/rxfs';
const filePath = 'path/to/audio-file.linear16';
// For a full list of options, see ./src/lib/toIBM.js
const params = {
apiKey: process.env.ASSEMBLY_AI_API_KEY,
};
const audioChunk$ = fromFile(filePath);
const output$ = string$.pipe(toAssemblyAI(params));
output$.subscribe(console.log);
// Output:
// {...responseFromAPI}
// {...anotherResponseFromAPI}
```
## Contributing, Deployments, etc.
See [CONTRIBUTING.md](https://github.com/buccaneerai/stt-assemblyai/blob/master/docs/CONTRIBUTING.md) file for information about deployments, etc.
## References
- [AssemblyAI docs](https://docs.assemblyai.com/api-ref/v2-stream)