1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
|
#!/usr/bin/env python
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
"""
FILE: basic_voice_assistant.py
DESCRIPTION:
This sample demonstrates the fundamental capabilities of the VoiceLive SDK by creating
a basic voice assistant that can engage in natural conversation with proper interruption
handling. This serves as the foundational example that showcases the core value
proposition of unified speech-to-speech interaction.
USAGE:
python basic_voice_assistant.py
Set the environment variables with your own values before running the sample:
1) AZURE_VOICELIVE_KEY - The Azure VoiceLive API key
2) AZURE_VOICELIVE_ENDPOINT - The Azure VoiceLive endpoint
Or copy .env.template to .env and fill in your values.
REQUIREMENTS:
- azure-ai-voicelive
- python-dotenv
- pyaudio (for audio capture and playback)
"""
import os
import sys
import asyncio
import base64
import argparse
import signal
import threading
import queue
from azure.ai.voicelive.models import ServerEventType
from typing import Union, Optional, TYPE_CHECKING, cast
from concurrent.futures import ThreadPoolExecutor
import logging
# Audio processing imports
try:
import pyaudio
except ImportError:
print("This sample requires pyaudio. Install with: pip install pyaudio")
sys.exit(1)
# Environment variable loading
try:
from dotenv import load_dotenv
load_dotenv()
except ImportError:
print("Note: python-dotenv not installed. Using existing environment variables.")
# Azure VoiceLive SDK imports
from azure.core.credentials import AzureKeyCredential, TokenCredential
from azure.identity import DefaultAzureCredential, InteractiveBrowserCredential
from azure.ai.voicelive.aio import connect
if TYPE_CHECKING:
# Only needed for type checking; avoids runtime import issues
from azure.ai.voicelive.aio import VoiceLiveConnection
from azure.ai.voicelive.models import (
RequestSession,
ServerVad,
AzureStandardVoice,
Modality,
AudioFormat,
)
# Set up logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s")
logger = logging.getLogger(__name__)
class AudioProcessor:
"""
Handles real-time audio capture and playback for the voice assistant.
Threading Architecture:
- Main thread: Event loop and UI
- Capture thread: PyAudio input stream reading
- Send thread: Async audio data transmission to VoiceLive
- Playback thread: PyAudio output stream writing
"""
def __init__(self, connection):
self.connection = connection
self.audio = pyaudio.PyAudio()
# Audio configuration - PCM16, 24kHz, mono as specified
self.format = pyaudio.paInt16
self.channels = 1
self.rate = 24000
self.chunk_size = 1024
# Capture and playback state
self.is_capturing = False
self.is_playing = False
self.input_stream = None
self.output_stream = None
# Audio queues and threading
self.audio_queue: "queue.Queue[bytes]" = queue.Queue()
self.audio_send_queue: "queue.Queue[str]" = queue.Queue() # base64 audio to send
self.executor = ThreadPoolExecutor(max_workers=3)
self.capture_thread: Optional[threading.Thread] = None
self.playback_thread: Optional[threading.Thread] = None
self.send_thread: Optional[threading.Thread] = None
self.loop: Optional[asyncio.AbstractEventLoop] = None # Store the event loop
logger.info("AudioProcessor initialized with 24kHz PCM16 mono audio")
async def start_capture(self):
"""Start capturing audio from microphone."""
if self.is_capturing:
return
# Store the current event loop for use in threads
self.loop = asyncio.get_event_loop()
self.is_capturing = True
try:
self.input_stream = self.audio.open(
format=self.format,
channels=self.channels,
rate=self.rate,
input=True,
frames_per_buffer=self.chunk_size,
stream_callback=None,
)
self.input_stream.start_stream()
# Start capture thread
self.capture_thread = threading.Thread(target=self._capture_audio_thread)
self.capture_thread.daemon = True
self.capture_thread.start()
# Start audio send thread
self.send_thread = threading.Thread(target=self._send_audio_thread)
self.send_thread.daemon = True
self.send_thread.start()
logger.info("Started audio capture")
except Exception as e:
logger.error(f"Failed to start audio capture: {e}")
self.is_capturing = False
raise
def _capture_audio_thread(self):
"""Audio capture thread - runs in background."""
while self.is_capturing and self.input_stream:
try:
# Read audio data
audio_data = self.input_stream.read(self.chunk_size, exception_on_overflow=False)
if audio_data and self.is_capturing:
# Convert to base64 and queue for sending
audio_base64 = base64.b64encode(audio_data).decode("utf-8")
self.audio_send_queue.put(audio_base64)
except Exception as e:
if self.is_capturing:
logger.error(f"Error in audio capture: {e}")
break
def _send_audio_thread(self):
"""Audio send thread - handles async operations from sync thread."""
while self.is_capturing:
try:
# Get audio data from queue (blocking with timeout)
audio_base64 = self.audio_send_queue.get(timeout=0.1)
if audio_base64 and self.is_capturing and self.loop:
# Schedule the async send operation in the main event loop
future = asyncio.run_coroutine_threadsafe(
self.connection.input_audio_buffer.append(audio=audio_base64), self.loop
)
# Don't wait for completion to avoid blocking
except queue.Empty:
continue
except Exception as e:
if self.is_capturing:
logger.error(f"Error sending audio: {e}")
break
async def stop_capture(self):
"""Stop capturing audio."""
if not self.is_capturing:
return
self.is_capturing = False
if self.input_stream:
self.input_stream.stop_stream()
self.input_stream.close()
self.input_stream = None
if self.capture_thread:
self.capture_thread.join(timeout=1.0)
if self.send_thread:
self.send_thread.join(timeout=1.0)
# Clear the send queue
while not self.audio_send_queue.empty():
try:
self.audio_send_queue.get_nowait()
except queue.Empty:
break
logger.info("Stopped audio capture")
async def start_playback(self):
"""Initialize audio playback system."""
if self.is_playing:
return
self.is_playing = True
try:
self.output_stream = self.audio.open(
format=self.format,
channels=self.channels,
rate=self.rate,
output=True,
frames_per_buffer=self.chunk_size,
)
# Start playback thread
self.playback_thread = threading.Thread(target=self._playback_audio_thread)
self.playback_thread.daemon = True
self.playback_thread.start()
logger.info("Audio playback system ready")
except Exception as e:
logger.error(f"Failed to initialize audio playback: {e}")
self.is_playing = False
raise
def _playback_audio_thread(self):
"""Audio playback thread - runs in background."""
while self.is_playing:
try:
# Get audio data from queue (blocking with timeout)
audio_data = self.audio_queue.get(timeout=0.1)
if audio_data and self.output_stream and self.is_playing:
self.output_stream.write(audio_data)
except queue.Empty:
continue
except Exception as e:
if self.is_playing:
logger.error(f"Error in audio playback: {e}")
break
async def queue_audio(self, audio_data: bytes):
"""Queue audio data for playback."""
if self.is_playing:
self.audio_queue.put(audio_data)
async def stop_playback(self):
"""Stop audio playback and clear queue."""
if not self.is_playing:
return
self.is_playing = False
# Clear the queue
while not self.audio_queue.empty():
try:
self.audio_queue.get_nowait()
except queue.Empty:
break
if self.output_stream:
self.output_stream.stop_stream()
self.output_stream.close()
self.output_stream = None
if self.playback_thread:
self.playback_thread.join(timeout=1.0)
logger.info("Stopped audio playback")
async def cleanup(self):
"""Clean up audio resources."""
await self.stop_capture()
await self.stop_playback()
if self.audio:
self.audio.terminate()
self.executor.shutdown(wait=True)
logger.info("Audio processor cleaned up")
class BasicVoiceAssistant:
"""Basic voice assistant implementing the VoiceLive SDK patterns."""
def __init__(
self,
endpoint: str,
credential: Union[AzureKeyCredential, TokenCredential],
model: str,
voice: str,
instructions: str,
):
self.endpoint = endpoint
self.credential = credential
self.model = model
self.voice = voice
self.instructions = instructions
self.connection: Optional["VoiceLiveConnection"] = None
self.audio_processor: Optional[AudioProcessor] = None
self.session_ready = False
self.conversation_started = False
async def start(self):
"""Start the voice assistant session."""
try:
logger.info(f"Connecting to VoiceLive API with model {self.model}")
# Connect to VoiceLive WebSocket API
async with connect(
endpoint=self.endpoint,
credential=self.credential,
model=self.model,
connection_options={
"max_msg_size": 10 * 1024 * 1024,
"heartbeat": 20,
"timeout": 20,
},
) as connection:
conn = connection
self.connection = conn
# Initialize audio processor
ap = AudioProcessor(conn)
self.audio_processor = ap
# Configure session for voice conversation
await self._setup_session()
# Start audio systems
await ap.start_playback()
logger.info("Voice assistant ready! Start speaking...")
print("\n" + "=" * 60)
print("š¤ VOICE ASSISTANT READY")
print("Start speaking to begin conversation")
print("Press Ctrl+C to exit")
print("=" * 60 + "\n")
# Process events
await self._process_events()
except KeyboardInterrupt:
logger.info("Received interrupt signal, shutting down...")
except Exception as e:
logger.error(f"Connection error: {e}")
raise
# Cleanup
if self.audio_processor:
await self.audio_processor.cleanup()
async def _setup_session(self):
"""Configure the VoiceLive session for audio conversation."""
logger.info("Setting up voice conversation session...")
# Create strongly typed voice configuration
voice_config: Union[AzureStandardVoice, str]
if self.voice.startswith("en-US-") or self.voice.startswith("en-CA-") or "-" in self.voice:
# Azure voice
voice_config = AzureStandardVoice(name=self.voice, type="azure-standard")
else:
# OpenAI voice (alloy, echo, fable, onyx, nova, shimmer)
voice_config = self.voice
# Create strongly typed turn detection configuration
turn_detection_config = ServerVad(threshold=0.5, prefix_padding_ms=300, silence_duration_ms=500)
# Create strongly typed session configuration
session_config = RequestSession(
modalities=[Modality.TEXT, Modality.AUDIO],
instructions=self.instructions,
voice=voice_config,
input_audio_format=AudioFormat.PCM16,
output_audio_format=AudioFormat.PCM16,
turn_detection=turn_detection_config,
)
conn = self.connection
assert conn is not None, "Connection must be established before setting up session"
await conn.session.update(session=session_config)
logger.info("Session configuration sent")
async def _process_events(self):
"""Process events from the VoiceLive connection."""
try:
conn = self.connection
assert conn is not None, "Connection must be established before processing events"
async for event in conn:
await self._handle_event(event)
except KeyboardInterrupt:
logger.info("Event processing interrupted")
except Exception as e:
logger.error(f"Error processing events: {e}")
raise
async def _handle_event(self, event):
"""Handle different types of events from VoiceLive."""
logger.debug(f"Received event: {event.type}")
ap = self.audio_processor
conn = self.connection
assert ap is not None, "AudioProcessor must be initialized"
assert conn is not None, "Connection must be established"
if event.type == ServerEventType.SESSION_UPDATED:
logger.info(f"Session ready: {event.session.id}")
self.session_ready = True
# Start audio capture once session is ready
await ap.start_capture()
elif event.type == ServerEventType.INPUT_AUDIO_BUFFER_SPEECH_STARTED:
logger.info("š¤ User started speaking - stopping playback")
print("š¤ Listening...")
# Stop current assistant audio playback (interruption handling)
await ap.stop_playback()
# Cancel any ongoing response
try:
await conn.response.cancel()
except Exception as e:
logger.debug(f"No response to cancel: {e}")
elif event.type == ServerEventType.INPUT_AUDIO_BUFFER_SPEECH_STOPPED:
logger.info("š¤ User stopped speaking")
print("š¤ Processing...")
# Restart playback system for response
await ap.start_playback()
elif event.type == ServerEventType.RESPONSE_CREATED:
logger.info("š¤ Assistant response created")
elif event.type == ServerEventType.RESPONSE_AUDIO_DELTA:
# Stream audio response to speakers
logger.debug("Received audio delta")
await ap.queue_audio(event.delta)
elif event.type == ServerEventType.RESPONSE_AUDIO_DONE:
logger.info("š¤ Assistant finished speaking")
print("š¤ Ready for next input...")
elif event.type == ServerEventType.RESPONSE_DONE:
logger.info("ā
Response complete")
elif event.type == ServerEventType.ERROR:
logger.error(f"ā VoiceLive error: {event.error.message}")
print(f"Error: {event.error.message}")
elif event.type == ServerEventType.CONVERSATION_ITEM_CREATED:
logger.debug(f"Conversation item created: {event.item.id}")
else:
logger.debug(f"Unhandled event type: {event.type}")
def parse_arguments():
"""Parse command line arguments."""
parser = argparse.ArgumentParser(
description="Basic Voice Assistant using Azure VoiceLive SDK",
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
)
parser.add_argument(
"--api-key",
help="Azure VoiceLive API key. If not provided, will use AZURE_VOICELIVE_API_KEY environment variable.",
type=str,
default=os.environ.get("AZURE_VOICELIVE_API_KEY"),
)
parser.add_argument(
"--endpoint",
help="Azure VoiceLive endpoint",
type=str,
default=os.environ.get("AZURE_VOICELIVE_ENDPOINT", "wss://api.voicelive.com/v1"),
)
parser.add_argument(
"--model",
help="VoiceLive model to use",
type=str,
default=os.environ.get("VOICELIVE_MODEL", "gpt-4o-realtime-preview"),
)
parser.add_argument(
"--voice",
help="Voice to use for the assistant",
type=str,
default=os.environ.get("VOICELIVE_VOICE", "en-US-AvaNeural"),
choices=[
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer",
"en-US-AvaNeural",
"en-US-JennyNeural",
"en-US-GuyNeural",
],
)
parser.add_argument(
"--instructions",
help="System instructions for the AI assistant",
type=str,
default=os.environ.get(
"VOICELIVE_INSTRUCTIONS",
"You are a helpful AI assistant. Respond naturally and conversationally. "
"Keep your responses concise but engaging.",
),
)
parser.add_argument(
"--use-token-credential", help="Use Azure token credential instead of API key", action="store_true"
)
parser.add_argument("--verbose", help="Enable verbose logging", action="store_true")
return parser.parse_args()
async def main():
"""Main function."""
args = parse_arguments()
# Set logging level
if args.verbose:
logging.getLogger().setLevel(logging.DEBUG)
# Validate credentials
if not args.api_key and not args.use_token_credential:
print("ā Error: No authentication provided")
print("Please provide an API key using --api-key or set AZURE_VOICELIVE_API_KEY environment variable,")
print("or use --use-token-credential for Azure authentication.")
sys.exit(1)
try:
# Create client with appropriate credential
credential: Union[AzureKeyCredential, TokenCredential]
if args.use_token_credential:
credential = InteractiveBrowserCredential() # or DefaultAzureCredential() if needed
logger.info("Using Azure token credential")
else:
credential = AzureKeyCredential(args.api_key)
logger.info("Using API key credential")
# Create and start voice assistant
assistant = BasicVoiceAssistant(
endpoint=args.endpoint,
credential=credential,
model=args.model,
voice=args.voice,
instructions=args.instructions,
)
# Setup signal handlers for graceful shutdown
def signal_handler(sig, frame):
logger.info("Received shutdown signal")
raise KeyboardInterrupt()
signal.signal(signal.SIGINT, signal_handler)
signal.signal(signal.SIGTERM, signal_handler)
# Start the assistant
await assistant.start()
except KeyboardInterrupt:
print("\nš Voice assistant shut down. Goodbye!")
except Exception as e:
logger.error(f"Fatal error: {e}")
print(f"ā Error: {e}")
sys.exit(1)
if __name__ == "__main__":
# Check for required dependencies
dependencies = {
"pyaudio": "Audio processing",
"azure.ai.voicelive": "Azure VoiceLive SDK",
"azure.core": "Azure Core libraries",
}
missing_deps = []
for dep, description in dependencies.items():
try:
__import__(dep.replace("-", "_"))
except ImportError:
missing_deps.append(f"{dep} ({description})")
if missing_deps:
print("ā Missing required dependencies:")
for dep in missing_deps:
print(f" - {dep}")
print("\nInstall with: pip install azure-ai-voicelive pyaudio python-dotenv")
sys.exit(1)
# Check audio system
try:
p = pyaudio.PyAudio()
# Check for input devices
input_devices = [
i
for i in range(p.get_device_count())
if cast(Union[int, float], p.get_device_info_by_index(i).get("maxInputChannels", 0) or 0) > 0
]
# Check for output devices
output_devices = [
i
for i in range(p.get_device_count())
if cast(Union[int, float], p.get_device_info_by_index(i).get("maxOutputChannels", 0) or 0) > 0
]
p.terminate()
if not input_devices:
print("ā No audio input devices found. Please check your microphone.")
sys.exit(1)
if not output_devices:
print("ā No audio output devices found. Please check your speakers.")
sys.exit(1)
except Exception as e:
print(f"ā Audio system check failed: {e}")
sys.exit(1)
print("šļø Basic Voice Assistant with Azure VoiceLive SDK")
print("=" * 50)
# Run the assistant
asyncio.run(main())
|