Class swarmauri_standard.llms.OpenAIAudioTTS.OpenAIAudioTTS
swarmauri_standard.llms.OpenAIAudioTTS.OpenAIAudioTTS
OpenAIAudioTTS(**data)
Bases: LLMBase
A class to interact with OpenAI's Text-to-Speech API, allowing for synchronous and asynchronous text-to-speech synthesis, as well as streaming capabilities.
ATTRIBUTE | DESCRIPTION |
---|---|
api_key |
The API key for accessing OpenAI's TTS service.
TYPE:
|
allowed_models |
List of models supported by the TTS service.
TYPE:
|
allowed_voices |
List of available voices.
TYPE:
|
name |
The default model name used for TTS.
TYPE:
|
type |
The type of TTS model.
TYPE:
|
voice |
The default voice setting for TTS synthesis.
TYPE:
|
Provider Resource: https://platform.openai.com/docs/guides/text-to-speech/overview
Initialize the OpenAIAudioTTS class with the provided data.
PARAMETER | DESCRIPTION |
---|---|
**data
|
Arbitrary keyword arguments containing initialization data.
DEFAULT:
|
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
52 53 54 55 56 57 58 59 60 61 62 63 |
|
api_key
instance-attribute
api_key
allowed_models
class-attribute
instance-attribute
allowed_models = ['tts-1', 'tts-1-hd', 'gpt-4o-mini-tts']
allowed_voices
class-attribute
instance-attribute
allowed_voices = [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer",
]
name
class-attribute
instance-attribute
name = 'tts-1'
type
class-attribute
instance-attribute
type = 'OpenAIAudioTTS'
voice
class-attribute
instance-attribute
voice = 'alloy'
timeout
class-attribute
instance-attribute
timeout = 600.0
model_config
class-attribute
instance-attribute
model_config = ConfigDict(
extra="allow", arbitrary_types_allowed=True
)
id
class-attribute
instance-attribute
id = Field(default_factory=generate_id)
members
class-attribute
instance-attribute
members = None
owners
class-attribute
instance-attribute
owners = None
host
class-attribute
instance-attribute
host = None
default_logger
class-attribute
default_logger = None
logger
class-attribute
instance-attribute
logger = None
version
class-attribute
instance-attribute
version = '0.1.0'
include_usage
class-attribute
instance-attribute
include_usage = True
BASE_URL
class-attribute
instance-attribute
BASE_URL = None
predict
predict(text, audio_path='output.mp3')
Synchronously converts text to speech using httpx.
PARAMETER | DESCRIPTION |
---|---|
text
|
The text to convert to speech.
TYPE:
|
audio_path
|
Path to save the synthesized audio.
TYPE:
|
Returns: str: Absolute path to the saved audio file.
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
|
apredict
async
apredict(text, audio_path='output.mp3')
Asynchronously converts text to speech using httpx.
PARAMETER | DESCRIPTION |
---|---|
text
|
The text to convert to speech.
TYPE:
|
audio_path
|
Path to save the synthesized audio.
TYPE:
|
Returns: str: Absolute path to the saved audio file.
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
|
stream
stream(text)
Synchronously streams TTS audio using httpx.
PARAMETER | DESCRIPTION |
---|---|
text
|
The text to convert to speech.
TYPE:
|
Returns: bytes: bytes of the audio.
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
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 |
|
astream
async
astream(text)
Asynchronously streams TTS audio using httpx.
PARAMETER | DESCRIPTION |
---|---|
text
|
The text to convert to speech.
TYPE:
|
Returns: io.BytesIO: bytes of the audio.
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
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 |
|
batch
batch(text_path_dict)
Synchronously process multiple text-to-speech requests in batch mode.
PARAMETER | DESCRIPTION |
---|---|
text_path_dict
|
Dictionary mapping text to output paths.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
List[str]
|
List[str]: List of paths to the saved audio files. |
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
|
abatch
async
abatch(text_path_dict, max_concurrent=5)
Asynchronously process multiple text-to-speech requests in batch mode with controlled concurrency.
PARAMETER | DESCRIPTION |
---|---|
text_path_dict
|
Dictionary mapping text to output paths.
TYPE:
|
max_concurrent
|
Maximum number of concurrent requests.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
List[str]
|
List[str]: List of paths to the saved audio files. |
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
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 |
|
get_allowed_models
get_allowed_models()
Queries the LLMProvider API endpoint to retrieve the list of allowed models.
RETURNS | DESCRIPTION |
---|---|
List[str]
|
List[str]: List of allowed model names. |
Source code in swarmauri_standard/llms/OpenAIAudioTTS.py
240 241 242 243 244 245 246 247 248 |
|
register_model
classmethod
register_model()
Decorator to register a base model in the unified registry.
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the model class.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
register_type
classmethod
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
PARAMETER | DESCRIPTION |
---|---|
resource_type
|
The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used.
TYPE:
|
type_name
|
An optional custom type name for the subtype.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the subtype.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
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 |
|
model_validate_toml
classmethod
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
model_dump_toml
model_dump_toml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
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 |
|
model_validate_yaml
classmethod
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
model_dump_yaml
model_dump_yaml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
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 |
|
model_post_init
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
23 24 25 26 27 28 |
|
add_allowed_model
add_allowed_model(model)
Add a new model to the list of allowed models.
RAISES | DESCRIPTION |
---|---|
ValueError
|
If the model is already in the allowed models list. |
Source code in swarmauri_base/llms/LLMBase.py
36 37 38 39 40 41 42 43 44 45 |
|
remove_allowed_model
remove_allowed_model(model)
Remove a model from the list of allowed models.
RAISES | DESCRIPTION |
---|---|
ValueError
|
If the model is not in the allowed models list. |
Source code in swarmauri_base/llms/LLMBase.py
47 48 49 50 51 52 53 54 55 56 |
|