deepgram.clients.speak.v1.websocket.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
 5
 6from dataclasses import dataclass
 7
 8from ....common import (
 9    BaseResponse,
10    OpenResponse,
11    CloseResponse,
12    ErrorResponse,
13    UnhandledResponse,
14)
15
16
17# Speak Response Types:
18
19
20@dataclass
21class MetadataResponse(BaseResponse):
22    """
23    Metadata object
24    """
25
26    type: str = ""
27    request_id: str = ""
28
29
30@dataclass
31class FlushedResponse(BaseResponse):
32    """
33    Flushed Message from the Deepgram Platform
34    """
35
36    type: str = ""
37    sequence_id: int = 0
38
39
40@dataclass
41class ClearedResponse(BaseResponse):
42    """
43    Cleared object
44    """
45
46    type: str = ""
47    sequence_id: int = 0
48
49
50@dataclass
51class WarningResponse(BaseResponse):
52    """
53    Warning Message from the Deepgram Platform
54    """
55
56    warn_code: str = ""
57    warn_msg: str = ""
58    type: str = ""
@dataclass
class MetadataResponse(deepgram.clients.common.v1.shared_response.BaseResponse):
21@dataclass
22class MetadataResponse(BaseResponse):
23    """
24    Metadata object
25    """
26
27    type: str = ""
28    request_id: str = ""

Metadata object

MetadataResponse(type: str = '', request_id: str = '')
type: str = ''
request_id: str = ''
@dataclass
class FlushedResponse(deepgram.clients.common.v1.shared_response.BaseResponse):
31@dataclass
32class FlushedResponse(BaseResponse):
33    """
34    Flushed Message from the Deepgram Platform
35    """
36
37    type: str = ""
38    sequence_id: int = 0

Flushed Message from the Deepgram Platform

FlushedResponse(type: str = '', sequence_id: int = 0)
type: str = ''
sequence_id: int = 0
@dataclass
class ClearedResponse(deepgram.clients.common.v1.shared_response.BaseResponse):
41@dataclass
42class ClearedResponse(BaseResponse):
43    """
44    Cleared object
45    """
46
47    type: str = ""
48    sequence_id: int = 0

Cleared object

ClearedResponse(type: str = '', sequence_id: int = 0)
type: str = ''
sequence_id: int = 0
@dataclass
class WarningResponse(deepgram.clients.common.v1.shared_response.BaseResponse):
51@dataclass
52class WarningResponse(BaseResponse):
53    """
54    Warning Message from the Deepgram Platform
55    """
56
57    warn_code: str = ""
58    warn_msg: str = ""
59    type: str = ""

Warning Message from the Deepgram Platform

WarningResponse(warn_code: str = '', warn_msg: str = '', type: str = '')
warn_code: str = ''
warn_msg: str = ''
type: str = ''