@cogito.ai/voice-openai v0.1.19

@cogito.ai/voice-openai

IMPORTANT! This package fork from @mastra/voice-openai

OpenAI Voice integration for Mastra, providing both Text-to-Speech (TTS) and Speech-to-Text (STT) capabilities using OpenAI's advanced models.

Installation

npm install @cogito.ai/voice-openai

Configuration

The module requires an OpenAI API key, which can be provided through environment variables or directly in the configuration:

OPENAI_API_KEY=your_api_key

Usage

import { OpenAIVoice } from '@cogito.ai/voice-openai';

// Create voice with both speech and listening capabilities
const voice = new OpenAIVoice({
  speechModel: {
    name: 'tts-1', // or 'tts-1-hd' for higher quality
    apiKey: 'your-api-key', // Optional, can use OPENAI_API_KEY env var
  },
  listeningModel: {
    name: 'whisper-1',
    apiKey: 'your-api-key', // Optional, can use OPENAI_API_KEY env var
  },
  speaker: 'alloy', // Default voice
});

// Or create speech-only voice
const speechVoice = new OpenAIVoice({
  speechModel: {
    name: 'tts-1',
    apiKey: 'your-api-key',
  },
  speaker: 'nova',
});

// Or create listening-only voice
const listeningVoice = new OpenAIVoice({
  listeningModel: {
    name: 'whisper-1',
    apiKey: 'your-api-key',
  },
});

// List available voices
const speakers = await voice.getSpeakers();

// Generate speech
const audioStream = await voice.speak('Hello from Mastra!', {
  speaker: 'nova', // Optional: override default speaker
  speed: 1.0, // Optional: adjust speech speed
});

// Convert speech to text
const text = await voice.listen(audioStream, {
  filetype: 'wav',
});

Features

• High-quality Text-to-Speech synthesis
• Accurate Speech-to-Text transcription
• Multiple voice options
• Natural and expressive speech output
• Fast processing times

Voice Options

OpenAI provides several high-quality voices:

• alloy (Neutral)
• echo (Male)
• fable (Male)
• onyx (Male)
• nova (Female)
• shimmer (Female)
• ash (Male)
• coral (Female)
• sage (Male)

View the complete list in OpenAI's Text to Speech documentation.