@mastra/voice-elevenlabs 0.12.0-beta.1 → 0.12.0-beta.2

package/dist/docs/voice/02-reference.md

@@ -0,0 +1,163 @@
+# Voice API Reference
+
+> API reference for voice - 2 entries
+
+
+---
+
+## Reference: ElevenLabs
+
+> Documentation for the ElevenLabs voice implementation, offering high-quality text-to-speech capabilities with multiple voice models and natural-sounding synthesis.
+
+The ElevenLabs voice implementation in Mastra provides high-quality text-to-speech (TTS) and speech-to-text (STT) capabilities using the ElevenLabs API.
+
+## Usage Example
+
+```typescript
+import { ElevenLabsVoice } from "@mastra/voice-elevenlabs";
+
+// Initialize with default configuration (uses ELEVENLABS_API_KEY environment variable)
+const voice = new ElevenLabsVoice();
+
+// Initialize with custom configuration
+const voice = new ElevenLabsVoice({
+  speechModel: {
+    name: "eleven_multilingual_v2",
+    apiKey: "your-api-key",
+  },
+  speaker: "custom-speaker-id",
+});
+
+// Text-to-Speech
+const audioStream = await voice.speak("Hello, world!");
+
+// Get available speakers
+const speakers = await voice.getSpeakers();
+```
+
+## Constructor Parameters
+
+### ElevenLabsVoiceConfig
+
+## Methods
+
+### speak()
+
+Converts text to speech using the configured speech model and voice.
+
+Returns: `Promise<NodeJS.ReadableStream>`
+
+### getSpeakers()
+
+Returns an array of available voice options, where each node contains:
+
+### listen()
+
+Converts audio input to text using ElevenLabs Speech-to-Text API.
+
+The options object supports the following properties:
+
+Returns: `Promise<string>` - A Promise that resolves to the transcribed text
+
+## Important Notes
+
+1. An ElevenLabs API key is required. Set it via the `ELEVENLABS_API_KEY` environment variable or pass it in the constructor.
+2. The default speaker is set to Aria (ID: '9BWtsMINqrJLrRacOk9x').
+3. Speech-to-text functionality is not supported by ElevenLabs.
+4. Available speakers can be retrieved using the `getSpeakers()` method, which returns detailed information about each voice including language and gender.
+
+---
+
+## Reference: voice.getSpeakers()
+
+> Documentation for the getSpeakers() method available in voice providers, which retrieves available voice options.
+
+The `getSpeakers()` method retrieves a list of available voice options (speakers) from the voice provider. This allows applications to present users with voice choices or programmatically select the most appropriate voice for different contexts.
+
+## Usage Example
+
+```typescript
+import { OpenAIVoice } from "@mastra/voice-openai";
+import { ElevenLabsVoice } from "@mastra/voice-elevenlabs";
+
+// Initialize voice providers
+const openaiVoice = new OpenAIVoice();
+const elevenLabsVoice = new ElevenLabsVoice({
+  apiKey: process.env.ELEVENLABS_API_KEY,
+});
+
+// Get available speakers from OpenAI
+const openaiSpeakers = await openaiVoice.getSpeakers();
+console.log("OpenAI voices:", openaiSpeakers);
+// Example output: [{ voiceId: "alloy" }, { voiceId: "echo" }, { voiceId: "fable" }, ...]
+
+// Get available speakers from ElevenLabs
+const elevenLabsSpeakers = await elevenLabsVoice.getSpeakers();
+console.log("ElevenLabs voices:", elevenLabsSpeakers);
+// Example output: [{ voiceId: "21m00Tcm4TlvDq8ikWAM", name: "Rachel" }, ...]
+
+// Use a specific voice for speech
+const text = "Hello, this is a test of different voices.";
+await openaiVoice.speak(text, { speaker: openaiSpeakers[2].voiceId });
+await elevenLabsVoice.speak(text, { speaker: elevenLabsSpeakers[0].voiceId });
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Return Value
+
+## Provider-Specific Metadata
+
+Different voice providers return different metadata for their voices:
+
+  **OpenAI:**
+
+    
+  
+
+**OpenAI Realtime:**
+
+  
+
+**Deepgram:**
+
+  
+
+**ElevenLabs:**
+
+  
+
+**Google:**
+
+  
+
+**Azure:**
+
+  
+
+**Murf:**
+
+  
+
+**PlayAI:**
+
+  
+
+**Speechify:**
+
+  
+
+**Sarvam:**
+
+    
+  
+
+## Notes
+
+- The available voices vary significantly between providers
+- Some providers may require authentication to retrieve the full list of voices
+- The default implementation returns an empty array if the provider doesn't support this method
+- For performance reasons, consider caching the results if you need to display the list frequently
+- The `voiceId` property is guaranteed to be present for all providers, but additional metadata varies

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/voice-elevenlabs",
-  "version": "0.12.0-beta.1",
+  "version": "0.12.0-beta.2",
   "description": "Mastra ElevenLabs voice integration",
   "type": "module",
   "files": [
@@ -27,17 +27,16 @@
     "elevenlabs": "^1.59.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.8",
     "@types/node": "22.13.17",
     "@vitest/coverage-v8": "4.0.12",
     "@vitest/ui": "4.0.12",
     "eslint": "^9.37.0",
     "tsup": "^8.5.0",
-    "typescript": "^5.8.3",
-    "vitest": "4.0.12",
-    "@internal/lint": "0.0.53",
+    "typescript": "^5.9.3",
+    "vitest": "4.0.16",
     "@internal/types-builder": "0.0.28",
-    "@mastra/core": "1.0.0-beta.10"
+    "@internal/lint": "0.0.53",
+    "@mastra/core": "1.0.0-beta.20"
   },
   "peerDependencies": {
     "@mastra/core": ">=1.0.0-0 <2.0.0-0",
@@ -57,6 +56,7 @@
   },
   "scripts": {
     "build": "tsup --silent --config tsup.config.ts",
+    "postbuild": "pnpx tsx ../../scripts/generate-package-docs.ts voice/elevenlabs",
     "build:watch": "tsup build --watch && tsc -p tsconfig.build.json",
     "test": "vitest run",
     "lint": "eslint ."