deepgram.clients.manage.v1.options

  1# Copyright 2023-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 typing import List, Optional
  6
  7from dataclasses import dataclass, field
  8from dataclasses_json import config as dataclass_config
  9
 10from ...common import BaseResponse
 11
 12# Input
 13
 14
 15@dataclass
 16class ProjectOptions(BaseResponse):
 17    """
 18    Project Options
 19    """
 20
 21    name: str = ""
 22
 23
 24@dataclass
 25class ModelOptions(BaseResponse):
 26    """
 27    Model Options
 28    """
 29
 30    include_outdated: bool = False
 31
 32
 33@dataclass
 34class KeyOptions(BaseResponse):
 35    """
 36    Key Options
 37    """
 38
 39    comment: Optional[str] = ""
 40    expiration_date: Optional[str] = field(
 41        default="", metadata=dataclass_config(exclude=lambda f: f == "")
 42    )
 43    time_to_live_in_seconds: Optional[int] = field(
 44        default=-1, metadata=dataclass_config(exclude=lambda f: f == -1)
 45    )
 46    scopes: List[str] = field(default_factory=list)
 47    tags: Optional[List[str]] = field(
 48        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
 49    )
 50
 51    def __getitem__(self, key):
 52        _dict = self.to_dict()
 53        if _dict["scopes"] is not None:
 54            _dict["scopes"] = [str(scopes) for scopes in _dict["scopes"]]
 55        if _dict["tags"] is not None:
 56            _dict["tags"] = [str(tags) for tags in _dict["tags"]]
 57        return _dict[key]
 58
 59
 60@dataclass
 61class ScopeOptions(BaseResponse):
 62    """
 63    Scope Options
 64    """
 65
 66    scope: str = ""
 67
 68
 69@dataclass
 70class InviteOptions(BaseResponse):
 71    """
 72    Invite Options
 73    """
 74
 75    email: str = ""
 76    scope: str = ""
 77
 78
 79@dataclass
 80class UsageRequestOptions(BaseResponse):
 81    """
 82    Usage Request Options
 83    """
 84
 85    start: Optional[str] = field(
 86        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
 87    )
 88    end: Optional[str] = field(
 89        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
 90    )
 91    limit: Optional[int] = field(
 92        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
 93    )
 94    status: Optional[str] = field(
 95        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
 96    )
 97
 98
 99@dataclass
100class UsageSummaryOptions(BaseResponse):  # pylint: disable=too-many-instance-attributes
101    """
102    Usage Summary Options
103    """
104
105    start: Optional[str] = field(
106        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
107    )
108    end: Optional[str] = field(
109        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
110    )
111    accessor: Optional[str] = field(
112        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
113    )
114    tag: Optional[str] = field(
115        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
116    )
117    method: Optional[str] = field(
118        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
119    )
120    model: Optional[str] = field(
121        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
122    )
123    multichannel: Optional[bool] = field(
124        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
125    )
126    interim_results: Optional[bool] = field(
127        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
128    )
129    punctuate: Optional[bool] = field(
130        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
131    )
132    ner: Optional[bool] = field(
133        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
134    )
135    utterances: Optional[bool] = field(
136        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
137    )
138    replace: Optional[bool] = field(
139        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
140    )
141    profanity_filter: Optional[bool] = field(
142        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
143    )
144    keywords: Optional[bool] = field(
145        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
146    )
147    detect_topics: Optional[bool] = field(
148        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
149    )
150    diarize: Optional[bool] = field(
151        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
152    )
153    search: Optional[bool] = field(
154        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
155    )
156    redact: Optional[bool] = field(
157        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
158    )
159    alternatives: Optional[bool] = field(
160        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
161    )
162    numerals: Optional[bool] = field(
163        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
164    )
165    smart_format: Optional[bool] = field(
166        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
167    )
168
169
170@dataclass
171class UsageFieldsOptions(BaseResponse):
172    """
173    Usage Fields Options
174    """
175
176    start: Optional[str] = ""
177    end: Optional[str] = ""