deepgram.clients.analyze.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
 5import logging
 6from typing import List, Union, Optional
 7
 8from dataclasses import dataclass, field
 9from dataclasses_json import config as dataclass_config
10
11from ....utils import verboselogs
12from ...common import (
13    TextSource,
14    FileSource,
15    BufferSource,
16    StreamSource,
17    UrlSource,
18    BaseResponse,
19)
20
21
22@dataclass
23class AnalyzeOptions(BaseResponse):  # pylint: disable=too-many-instance-attributes
24    """
25    Contains all the options for the AnalyzeOptions.
26
27    Reference:
28    https://developers.deepgram.com/reference/text-intelligence-apis
29    """
30
31    callback: Optional[str] = field(
32        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
33    )
34    callback_method: Optional[str] = field(
35        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
36    )
37    custom_intent: Optional[Union[List[str], str]] = field(
38        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
39    )
40    custom_intent_mode: Optional[str] = field(
41        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
42    )
43    custom_topic: Optional[Union[List[str], str]] = field(
44        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
45    )
46    custom_topic_mode: Optional[str] = field(
47        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
48    )
49    intents: Optional[bool] = field(
50        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
51    )
52    language: Optional[str] = field(
53        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
54    )
55    sentiment: Optional[bool] = field(
56        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
57    )
58    summarize: Optional[bool] = field(
59        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
60    )
61    topics: Optional[bool] = field(
62        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
63    )
64
65    def check(self):
66        """
67        Check the options for the AnalyzeOptions.
68        """
69        logger = verboselogs.VerboseLogger(__name__)
70        logger.addHandler(logging.StreamHandler())
71        prev = logger.level
72        logger.setLevel(verboselogs.ERROR)
73
74        # no op at the moment
75
76        logger.setLevel(prev)
77
78        return True
79
80
81# unique
82AnalyzeSource = Union[UrlSource, FileSource]
83AnalyzeStreamSource = StreamSource