npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

whispermix

v1.2.4

Published

🎙️ WhisperMix is a versatile module for transcribing audio using OpenAI’s Whisper or Groq’s Whisper v3 model.

Downloads

49

Readme

🎙️ WhisperMix

WhisperMix is a flexible module that provides an interface for transcribing audio using OpenAI's Whisper model or Groq's Whisper Large v3 model.

📦 Installation

npm install whispermix

⚙️ Configuration

Before using WhisperMix, you need to set up your environment variables:

  • For OpenAI's Whisper: Set OPENAI_API_KEY in your environment or .env file.
  • For Groq's Whisper Large v3: Set GROQ_API_KEY in your environment or .env file.

🚀 Usage

First, import the WhisperMix class:

const WhisperMix = require('whispermix');

🔧 Initializing WhisperMix

You can initialize WhisperMix with a specific model:

const whisper = new WhisperMix({ model: 'whisper-1' }); // For OpenAI's Whisper
// or
const whisperGroq = new WhisperMix({ model: 'whisper-large-v3' }); // For Groq's Whisper Large v3

📄 Transcribing from a File

const filePath = 'path/to/your/audio/file.mp3';
whisperGroq.fromFile(filePath)
  .then(transcription => console.log(transcription))
  .catch(error => console.error(error));

🌊 Transcribing from a Stream

const fs = require('fs');
const audioStream = fs.createReadStream('path/to/your/audio/file.mp3');

whisperGroq.fromStream(audioStream)
  .then(transcription => console.log(transcription))
  .catch(error => console.error(error));

🚦 Bottleneck Configuration

WhisperMix uses Bottleneck for rate limiting. You can configure the Bottleneck settings when initializing WhisperMix:

const whisper = new WhisperMix({
  model: 'whisper-1',
  bottleneck: {
    minTime: 3000,
    maxConcurrent: 1,
    reservoir: 18,
    reservoirRefreshAmount: 18,
    reservoirRefreshInterval: 60000
  }
});

The default Bottleneck configuration is:

  • minTime: 3000 ms (minimum time between requests)
  • maxConcurrent: 1 (maximum number of concurrent requests)
  • reservoir: 18 (number of requests that can be made before throttling)
  • reservoirRefreshAmount: 18 (number of requests added back to the reservoir)
  • reservoirRefreshInterval: 60000 ms (time interval for refreshing the reservoir)

You can adjust these settings based on your specific rate limiting needs.

📚 API

new WhisperMix(options)

Creates a new WhisperMix instance.

  • options.model: The model to use for transcription. Can be 'whisper-1' (OpenAI) or 'whisper-large-v3' (Groq).
  • options.bottleneck: (Optional) Configuration for Bottleneck rate limiting.

whisper.fromFile(filePath)

Transcribes audio from a file.

  • filePath: Path to the audio file.

Returns a Promise that resolves with the transcription text.

whisper.fromStream(audioStream)

Transcribes audio from a stream.

  • audioStream: A readable stream of the audio data.

Returns a Promise that resolves with the transcription text.

⚠️ Error Handling

WhisperMix throws errors for API request failures. Always wrap your calls in try-catch blocks or use .catch() with promises to handle potential errors.

📄 License

The MIT License (MIT)

Copyright (c) Martin Clasen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.