admin-valentin/openai-agents-python
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make the TTS voices type exportable (#577)

Browse source 
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>
This commit is contained in:
Stefano Baccianella 2025-04-25 01:11:25 +02:00 committed by GitHub
parent 8fd7773a5e
commit aa197e1e14
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/agents/voice/__init__.py
View file

@ -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",

7
src/agents/voice/model.py
View file

@ -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.