deepgram.clients.speak.v1.rest.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 Optional, Dict, Any
 6import io
 7
 8from dataclasses import dataclass, field
 9from dataclasses_json import config as dataclass_config
10
11from ....common import (
12    BaseResponse,
13)
14
15
16# Speak Response Types:
17
18
19@dataclass
20class SpeakRESTResponse(BaseResponse):  # pylint: disable=too-many-instance-attributes
21    """
22    A class for representing a response from the speak endpoint.
23    """
24
25    content_type: str = ""
26    request_id: str = ""
27    model_uuid: str = ""
28    model_name: str = ""
29    characters: int = 0
30    transfer_encoding: str = ""
31    date: str = ""
32    filename: Optional[str] = field(
33        default=None, metadata=dataclass_config(exclude=lambda f: f is None)
34    )
35    # pylint: disable=W0511
36    # TODO: stream will be deprecated in a future release. Please use stream_memory instead.
37    stream: Optional[io.BytesIO] = field(
38        default=None,
39        metadata=dataclass_config(exclude=lambda f: True),
40    )
41    # pylint: enable=W0511
42    stream_memory: Optional[io.BytesIO] = field(
43        default=None,
44        metadata=dataclass_config(exclude=lambda f: True),
45    )