From aa197e1e1431ec8ad381575d0ea5a9667a9c2fcb Mon Sep 17 00:00:00 2001
From: Stefano Baccianella <4247706+mangiucugna@users.noreply.github.com>
Date: Fri, 25 Apr 2025 01:11:25 +0200
Subject: [PATCH] Make the TTS voices type exportable (#577)

When using the voice agent in typed code, it is suboptimal and error
prone to type the TTS voice variables in your code independently.

With this commit we are making the type exportable so that developers
can just use that and be future-proof.

Example of usage in code:

```
DEFAULT_TTS_VOICE: TTSModelSettings.TTSVoice = "alloy"

...

tts_voice: TTSModelSettings.TTSVoice = DEFAULT_TTS_VOICE

...

output = await VoicePipeline(
  workflow=workflow,
  config=VoicePipelineConfig(
  tts_settings=TTSModelSettings(
    buffer_size=512,
    transform_data=transform_data,
    voice=tts_voice,
    instructions=tts_instructions,
  ))
).run(audio_input)
```

---------

Co-authored-by: Rohan Mehta <rm@openai.com>
---
 src/agents/voice/__init__.py | 2 ++
 src/agents/voice/model.py    | 7 +++----
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/agents/voice/__init__.py b/src/agents/voice/__init__.py
index 499c064..e11ee44 100644
--- a/src/agents/voice/__init__.py
+++ b/src/agents/voice/__init__.py
@@ -7,6 +7,7 @@ from .model import (
     STTModelSettings,
     TTSModel,
     TTSModelSettings,
+    TTSVoice,
     VoiceModelProvider,
 )
 from .models.openai_model_provider import OpenAIVoiceModelProvider
@@ -30,6 +31,7 @@ __all__ = [
     "STTModelSettings",
     "TTSModel",
     "TTSModelSettings",
+    "TTSVoice",
     "VoiceModelProvider",
     "StreamedAudioResult",
     "SingleAgentVoiceWorkflow",
diff --git a/src/agents/voice/model.py b/src/agents/voice/model.py
index 220d4b4..c36a4de 100644
--- a/src/agents/voice/model.py
+++ b/src/agents/voice/model.py
@@ -14,14 +14,13 @@ DEFAULT_TTS_INSTRUCTIONS = (
 )
 DEFAULT_TTS_BUFFER_SIZE = 120
 
+TTSVoice = Literal["alloy", "ash", "coral", "echo", "fable", "onyx", "nova", "sage", "shimmer"]
+"""Exportable type for the TTSModelSettings voice enum"""
 
 @dataclass
 class TTSModelSettings:
     """Settings for a TTS model."""
-
-    voice: (
-        Literal["alloy", "ash", "coral", "echo", "fable", "onyx", "nova", "sage", "shimmer"] | None
-    ) = None
+    voice: TTSVoice | None = None
     """
     The voice to use for the TTS model. If not provided, the default voice for the respective model
     will be used.