node-deepgram's Introduction

deepgram

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.

This is a very early version, I hope to implement more functions & enhance the existing ones in the following weeks, PRs are welcome 😄.

Usage

There's a NPM package available:

npm install --save deepgram

Indexing an audio file is as easy as:

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.

Development

The wrapper uses Babel. You may test the source using mocha:

npm test

The above will compile the JS & run mocha with the options in the file.

API Documentation

I found the API documentation here.

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

node-deepgram's People

Contributors

Stargazers

Watchers

node-deepgram's Issues

group_search

The group_search and parallel_search options should be provided. I believe this would be a good turning point to revise the tests as well so it's not dependent on the hard-coded values in the file as of right now.

Tagging

We should allow for tagging options and viewing the available tags as a list.

ENOENT: no such file or directory, open '.env'

When running npm test:

vinay@Vinays-MacBook-Pro ~/C/node-deepgram> npm test --verbose
npm info it worked if it ends with ok
npm verb cli [ '/usr/local/Cellar/node/5.0.0/bin/node',
npm verb cli   '/usr/local/bin/npm',
npm verb cli   'test',
npm verb cli   '--verbose' ]
npm info using [email protected]
npm info using [email protected]
npm verb run-script [ 'pretest', 'test', 'posttest' ]
npm info lifecycle [email protected]~pretest: [email protected]
npm info lifecycle [email protected]~test: [email protected]

> [email protected] test /Users/vinay/Code/node-deepgram
> npm run compile && NODE_ENV=test mocha --compilers js:babel-core/register

npm info it worked if it ends with ok
npm verb cli [ '/usr/local/Cellar/node/5.0.0/bin/node',
npm verb cli   '/usr/local/bin/npm',
npm verb cli   'run',
npm verb cli   'compile' ]
npm info using [email protected]
npm info using [email protected]
npm verb run-script [ 'precompile', 'compile', 'postcompile' ]
npm info lifecycle [email protected]~precompile: [email protected]
npm info lifecycle [email protected]~compile: [email protected]

> [email protected] compile /Users/vinay/Code/node-deepgram
> babel src --modules common --out-dir lib

src/deepgram.js -> lib/deepgram.js
npm verb lifecycle [email protected]~compile: unsafe-perm in lifecycle true
npm verb lifecycle [email protected]~compile: PATH: /usr/local/lib/node_modules/npm/bin/node-gyp-bin:/Users/vinay/Code/node-deepgram/node_modules/.bin:/usr/local/Cellar/node/5.0.0/bin:/usr/local/lib/node_modules/npm/bin/node-gyp-bin:/Users/vinay/Code/node-deepgram/node_modules/.bin:/usr/local/Cellar/node/5.0.0/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
npm verb lifecycle [email protected]~compile: CWD: /Users/vinay/Code/node-deepgram
npm info lifecycle [email protected]~postcompile: [email protected]
npm verb exit [ 0, true ]
npm info ok
Debugger listening on port 5858
{ [Error: ENOENT: no such file or directory, open '.env'] errno: -2, code: 'ENOENT', syscall: 'open', path: '.env' }