deepgram.clients.common.v1.shared_response

 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 typing import List, Optional, Dict, Any
 6
 7
 8from dataclasses import dataclass, field
 9from dataclasses_json import config as dataclass_config, DataClassJsonMixin
10
11
12# base class
13
14
15@dataclass
16class BaseResponse(DataClassJsonMixin):
17    """
18    BaseResponse class used to define the common methods and properties for all response classes.
19    """
20
21    def __getitem__(self, key):
22        _dict = self.to_dict()
23        return _dict[key]
24
25    def __setitem__(self, key, val):
26        self.__dict__[key] = val
27
28    def __str__(self) -> str:
29        return self.to_json(indent=4)
30
31    def eval(self, key: str) -> str:
32        """
33        This method is used to evaluate a key in the response object using a dot notation style method.
34        """
35        keys = key.split(".")
36        result: Dict[Any, Any] = self.to_dict()
37        for k in keys:
38            if isinstance(result, dict) and k in result:
39                result = result[k]
40            elif isinstance(result, list) and k.isdigit() and int(k) < len(result):
41                result = result[int(k)]
42            else:
43                return ""
44        return str(result)
45
46
47# shared classes
48
49
50@dataclass
51class ModelInfo(BaseResponse):
52    """
53    ModelInfo object
54    """
55
56    name: str = ""
57    version: str = ""
58    arch: str = ""
59
60
61@dataclass
62class Hit(BaseResponse):
63    """
64    The hit information for the response.
65    """
66
67    confidence: float = 0
68    start: float = 0
69    end: float = 0
70    snippet: Optional[str] = ""
71
72
73@dataclass
74class Search(BaseResponse):
75    """
76    The search information for the response.
77    """
78
79    query: str = ""
80    hits: List[Hit] = field(default_factory=list)
81
82    def __getitem__(self, key):
83        _dict = self.to_dict()
84        if "hits" in _dict:
85            _dict["hits"] = [Hit.from_dict(hits) for hits in _dict["hits"]]
86        return _dict[key]