deepgram.clients.speak.v1.options

 1# Copyright 2024 Deepgram SDK contributors. All Rights Reserved.
 2# Use of this source code is governed by a MIT license that can be found in the LICENSE file.
 3# SPDX-License-Identifier: MIT
 4
 5from io import BufferedReader
 6from typing import Union, Optional
 7import logging
 8
 9from dataclasses import dataclass, field
10from dataclasses_json import config as dataclass_config, DataClassJsonMixin
11
12from ....utils import verboselogs
13from ...common import FileSource
14
15
16@dataclass
17class SpeakOptions(DataClassJsonMixin):
18    """
19    Contains all the options for the SpeakOptions.
20
21    Reference:
22    https://developers.deepgram.com/reference/text-to-speech-preview-api
23    """
24
25    model: Optional[str] = field(
26        default="aura-asteria-en",
27        metadata=dataclass_config(exclude=lambda f: f is None),
28    )
29    encoding: Optional[str] = field(
30        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
31    )
32    container: Optional[str] = field(
33        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
34    )
35    sample_rate: Optional[int] = field(
36        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
37    )
38    bit_rate: Optional[int] = field(
39        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
40    )
41
42    def __getitem__(self, key):
43        _dict = self.to_dict()
44        return _dict[key]
45
46    def __setitem__(self, key, val):
47        self.__dict__[key] = val
48
49    def __str__(self) -> str:
50        return self.to_json(indent=4)
51
52    def check(self):
53        """
54        Check the SpeakOptions for any missing or invalid values.
55        """
56        logger = verboselogs.VerboseLogger(__name__)
57        logger.addHandler(logging.StreamHandler())
58        prev = logger.level
59        logger.setLevel(verboselogs.ERROR)
60
61        # no op at the moment
62
63        logger.setLevel(prev)
64
65        return True
66
67
68SpeakRESTOptions = SpeakOptions
69
70SpeakSource = Union[FileSource, BufferedReader]
71SpeakRestSource = SpeakSource