https://github.com/matiasinsaurralde/node-deepgram
NodeJS wrapper for Deepgram
https://github.com/matiasinsaurralde/node-deepgram
Last synced: 6 days ago
JSON representation
NodeJS wrapper for Deepgram
- Host: GitHub
- URL: https://github.com/matiasinsaurralde/node-deepgram
- Owner: matiasinsaurralde
- License: mit
- Created: 2016-03-16T05:02:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-15T07:35:54.000Z (over 2 years ago)
- Last Synced: 2025-06-17T08:06:12.044Z (5 months ago)
- Language: JavaScript
- Homepage: https://www.deepgram.com
- Size: 15.6 KB
- Stars: 9
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# deepgram
[![Wercker][wercker-image]][wercker-url]
[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-downloads]][npm-url]
[![MIT License][license-image]][license-url]
From the [YC post](http://blog.ycombinator.com/deepgram-yc-w16-is-building-a-google-for-audio):
> **DeepGram is a company launching out of our Winter 2016 class that uses deep learning to index audio and make it searchable for businesses. For example, a company can use DeepGram to analyze their phone support audio dataset and search for moments where their competitors' names are mentioned.**
This project provides a simple NodeJS wrapper for the Deepgram API, it's built on top of [frisbee](https://github.com/niftylettuce/frisbee).
This is a very early version, I hope to implement more functions & enhance the existing ones in the following weeks, PRs are welcome :smile:.
## Usage
There's a NPM package available:
```npm install --save deepgram```
Indexing an audio file is as easy as:
```js
import deepgram from 'deepgram';
deepgram.indexContent( 'http://website.com/audio.mp3' ).then( data => {
// you'll get the content ID here (inside data)
}).catch( err => {
// handle the error
});
```
Examples available [here](https://github.com/matiasinsaurralde/node-deepgram/tree/master/examples).
## Development
The wrapper uses Babel. You may test the source using [mocha](https://mochajs.org/):
```npm test```
The above will compile the JS & run [mocha](https://mochajs.org/) with the [options in the file](https://github.com/matiasinsaurralde/node-deepgram/blob/master/test/mocha.opts).
## API Documentation
I found the API documentation [here](https://api.deepgram.com/doc/).
When you signup on the website you'll see some ```curl``` samples as well.
## TODO
* It could be interesting to use this module directly from the browser.
## License
[MIT][license-url]
[wercker-image]: https://app.wercker.com/status/2179a5f7fbbfa2be251285bbda4ec173/s/master
[wercker-url]: https://app.wercker.com/project/bykey/2179a5f7fbbfa2be251285bbda4ec173
[npm-image]: http://img.shields.io/npm/v/deepgram.svg?style=flat
[npm-url]: https://npmjs.org/package/deepgram
[npm-downloads]: http://img.shields.io/npm/dm/deepgram.svg?style=flat
[license-url]: LICENSE
[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat