Class swarmauri_standard.stt.OpenaiSTT.OpenaiSTT
OpenaiSTT(**data)
              Bases: STTBase
OpenaiSTT is a class that provides transcription and translation capabilities using OpenAI's audio models. It supports both synchronous and asynchronous methods for processing audio files.
| ATTRIBUTE | DESCRIPTION | 
|---|---|
| api_key | API key for authentication. 
                  
                    TYPE:
                       | 
| allowed_models | List of supported model names. 
                  
                    TYPE:
                       | 
| name | The default model name to be used for predictions. 
                  
                    TYPE:
                       | 
| type | The type identifier for the class. 
                  
                    TYPE:
                       | 
Provider Resources: https://platform.openai.com/docs/api-reference/audio/createTranscription
Initialize the OpenaiSTT class with the provided data.
| PARAMETER | DESCRIPTION | 
|---|---|
| **data | Arbitrary keyword arguments containing initialization data. 
                  
                    TYPE:
                       | 
Source code in swarmauri_standard/stt/OpenaiSTT.py
                    | 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |  | 
instance-attribute
  
api_key
class-attribute
      instance-attribute
  
allowed_models = [
    "whisper-1",
    "gpt-4o-transcribe",
    "gpt-4o-mini-transcribe",
]
class-attribute
      instance-attribute
  
name = 'whisper-1'
class-attribute
      instance-attribute
  
type = 'OpenaiSTT'
class-attribute
      instance-attribute
  
model_config = ConfigDict(
    extra="forbid", arbitrary_types_allowed=True
)
class-attribute
      instance-attribute
  
id = Field(default_factory=generate_id)
class-attribute
      instance-attribute
  
members = None
class-attribute
      instance-attribute
  
owners = None
class-attribute
      instance-attribute
  
host = None
class-attribute
  
default_logger = None
class-attribute
      instance-attribute
  
logger = None
class-attribute
      instance-attribute
  
version = '0.1.0'
predict(audio_path, task='transcription')
Perform synchronous transcription or translation on the provided audio file.
| PARAMETER | DESCRIPTION | 
|---|---|
| audio_path | Path to the audio file. 
                  
                    TYPE:
                       | 
| task | Task type. Defaults to "transcription". 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| str | The resulting transcription or translation text. 
                  
                    TYPE:
                       | 
| RAISES | DESCRIPTION | 
|---|---|
| ValueError | If the specified task is not supported. | 
| HTTPStatusError | If the API request fails. | 
Source code in swarmauri_standard/stt/OpenaiSTT.py
              | 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 |  | 
async
  
apredict(audio_path, task='transcription')
Perform asynchronous transcription or translation on the provided audio file.
| PARAMETER | DESCRIPTION | 
|---|---|
| audio_path | Path to the audio file. 
                  
                    TYPE:
                       | 
| task | Task type. Defaults to "transcription". 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| str | The resulting transcription or translation text. 
                  
                    TYPE:
                       | 
| RAISES | DESCRIPTION | 
|---|---|
| ValueError | If the specified task is not supported. | 
| HTTPStatusError | If the API request fails. | 
Source code in swarmauri_standard/stt/OpenaiSTT.py
              | 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 |  | 
batch(path_task_dict)
Synchronously process multiple audio files for transcription or translation.
| PARAMETER | DESCRIPTION | 
|---|---|
| path_task_dict | A dictionary where the keys are paths to audio files and the values are the tasks. 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| List | A list of resulting texts from each audio file. 
                  
                    TYPE:
                       | 
Source code in swarmauri_standard/stt/OpenaiSTT.py
              | 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |  | 
async
  
abatch(path_task_dict, max_concurrent=5)
Asynchronously process multiple audio files for transcription or translation with controlled concurrency.
| PARAMETER | DESCRIPTION | 
|---|---|
| path_task_dict | A dictionary where the keys are paths to audio files and the values are the tasks. 
                  
                    TYPE:
                       | 
| max_concurrent | Maximum number of concurrent tasks. Defaults to 5. 
                  
                    TYPE:
                       | 
| RETURNS | DESCRIPTION | 
|---|---|
| List | A list of resulting texts from each audio file. 
                  
                    TYPE:
                       | 
Source code in swarmauri_standard/stt/OpenaiSTT.py
              | 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 |  | 
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/stt/OpenaiSTT.py
              | 202 203 204 205 206 207 208 209 210 |  | 
stream(audio_path, task='transcription')
Source code in swarmauri_standard/stt/OpenaiSTT.py
              | 212 213 214 215 216 217 |  | 
async
  
astream(audio_path, task='transcription')
Source code in swarmauri_standard/stt/OpenaiSTT.py
              | 219 220 221 222 223 224 225 226 |  | 
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 |  | 
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 |  | 
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(
    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 |  | 
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(
    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(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(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/stt/STTBase.py
              | 27 28 29 30 31 32 33 34 35 36 |  | 
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/stt/STTBase.py
              | 38 39 40 41 42 43 44 45 46 47 |  |