deepgram.clients.manage.v1.response
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, Dict, Any 6 7from dataclasses import dataclass, field 8from dataclasses_json import config as dataclass_config 9 10from ...common import ( 11 BaseResponse, 12) 13 14 15# Result Message 16 17 18@dataclass 19class Message(BaseResponse): 20 """ 21 Message from the Deepgram Platform 22 """ 23 24 message: str = "" 25 26 27# Projects 28 29 30@dataclass 31class Project(BaseResponse): 32 """ 33 Project object 34 """ 35 36 project_id: str = "" 37 name: str = "" 38 39 40@dataclass 41class ProjectsResponse(BaseResponse): 42 """ 43 Projects Response object 44 """ 45 46 projects: List[Project] = field(default_factory=list) 47 48 def __getitem__(self, key): 49 _dict = self.to_dict() 50 if "projects" in _dict: 51 _dict["projects"] = [ 52 Project.from_dict(projects) for projects in _dict["projects"] 53 ] 54 return _dict[key] 55 56 57# Models 58 59 60@dataclass 61class STTDetails(BaseResponse): # pylint: disable=too-many-instance-attributes 62 """ 63 STTDetails class used to define the properties of the Speech-to-Text model response object. 64 """ 65 66 name: str = "" 67 canonical_name: str = "" 68 architecture: str = "" 69 languages: List[str] = field(default_factory=list) 70 version: str = "" 71 uuid: str = "" 72 batch: bool = False 73 streaming: bool = False 74 formatted_output: bool = False 75 76 def __getitem__(self, key): 77 _dict = self.to_dict() 78 if "languages" in _dict: 79 _dict["languages"] = [str(languages) for languages in _dict["languages"]] 80 return _dict[key] 81 82 83@dataclass 84class TTSMetadata(BaseResponse): 85 """ 86 TTSMetadata class used to define the properties for a given STT or TTS model. 87 """ 88 89 accent: str = "" 90 color: str = "" 91 image: str = "" 92 sample: str = "" 93 tags: Optional[List[str]] = field( 94 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 95 ) 96 97 98@dataclass 99class TTSDetails(BaseResponse): 100 """ 101 TTSDetails class used to define the properties of the Text-to-Speech model response object. 102 """ 103 104 name: str = "" 105 canonical_name: str = "" 106 architecture: str = "" 107 languages: List[str] = field(default_factory=list) 108 version: str = "" 109 uuid: str = "" 110 metadata: Optional[TTSMetadata] = field( 111 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 112 ) 113 114 def __getitem__(self, key): 115 _dict = self.to_dict() 116 if "metadata" in _dict: 117 _dict["metadata"] = [ 118 TTSMetadata.from_dict(metadata) for metadata in _dict["metadata"] 119 ] 120 return _dict[key] 121 122 123# responses 124 125 126@dataclass 127class ModelResponse(BaseResponse): 128 """ 129 ModelResponse class used to define the properties of a single model. 130 """ 131 132 name: str = "" 133 canonical_name: str = "" 134 architecture: str = "" 135 language: str = "" 136 version: str = "" 137 uuid: str = "" 138 metadata: Optional[TTSMetadata] = field( 139 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 140 ) 141 142 def __getitem__(self, key): 143 _dict = self.to_dict() 144 if "metadata" in _dict: 145 _dict["metadata"] = [ 146 TTSMetadata.from_dict(metadata) for metadata in _dict["metadata"] 147 ] 148 return _dict[key] 149 150 151@dataclass 152class ModelsResponse(BaseResponse): 153 """ 154 ModelsResponse class used to obtain a list of models. 155 """ 156 157 stt: List[STTDetails] = field(default_factory=list) 158 tts: List[TTSDetails] = field(default_factory=list) 159 160 def __getitem__(self, key): 161 _dict = self.to_dict() 162 if "stt" in _dict: 163 _dict["stt"] = [STTDetails.from_dict(stt) for stt in _dict["stt"]] 164 if "tts" in _dict: 165 _dict["tts"] = [TTSDetails.from_dict(tts) for tts in _dict["tts"]] 166 return _dict[key] 167 168 169# Members 170 171 172@dataclass 173class Member(BaseResponse): 174 """ 175 Member object 176 """ 177 178 email: str = "" 179 first_name: str = "" 180 last_name: str = "" 181 member_id: str = "" 182 183 184@dataclass 185class MembersResponse(BaseResponse): 186 """ 187 Members Response object 188 """ 189 190 members: List[Member] = field(default_factory=list) 191 192 def __getitem__(self, key): 193 _dict = self.to_dict() 194 if "members" in _dict: 195 _dict["members"] = [ 196 Member.from_dict(members) for members in _dict["members"] 197 ] 198 return _dict[key] 199 200 201# Keys 202 203 204@dataclass 205class Key(BaseResponse): 206 """ 207 Key object 208 """ 209 210 api_key_id: str = "" 211 key: Optional[str] = field( 212 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 213 ) 214 comment: Optional[str] = "" 215 created: str = "" 216 scopes: List[str] = field(default_factory=list) 217 expiration_date: str = field( 218 default="", metadata=dataclass_config(exclude=lambda f: f is None) 219 ) 220 221 def __getitem__(self, key): 222 _dict = self.to_dict() 223 if "scopes" in _dict: 224 _dict["scopes"] = [str(scopes) for scopes in _dict["scopes"]] 225 return _dict[key] 226 227 228@dataclass 229class KeyResponse(BaseResponse): 230 """ 231 Key Response object 232 """ 233 234 api_key: Key 235 member: Member 236 237 def __getitem__(self, key): 238 _dict = self.to_dict() 239 if "api_key" in _dict: 240 _dict["api_key"] = Key.from_dict(_dict["api_key"]) 241 if "member" in _dict: 242 _dict["member"] = Member.from_dict(_dict["member"]) 243 return _dict[key] 244 245 246@dataclass 247class KeysResponse(BaseResponse): 248 """ 249 Keys Response object 250 """ 251 252 api_keys: List[KeyResponse] = field(default_factory=list) 253 254 def __getitem__(self, key): 255 _dict = self.to_dict() 256 if "api_keys" in _dict: 257 _dict["api_keys"] = [ 258 KeyResponse.from_dict(api_keys) for api_keys in _dict["api_keys"] 259 ] 260 return _dict[key] 261 262 263# Scopes 264 265 266@dataclass 267class ScopesResponse(BaseResponse): 268 """ 269 Scopes Response object 270 """ 271 272 scopes: List[str] = field(default_factory=list) 273 274 def __getitem__(self, key): 275 _dict = self.to_dict() 276 if "scopes" in _dict: 277 _dict["scopes"] = [str(scopes) for scopes in _dict["scopes"]] 278 return _dict[key] 279 280 281# Invites 282 283 284@dataclass 285class Invite(BaseResponse): 286 """ 287 Invite object 288 """ 289 290 email: str = "" 291 scope: str = "" 292 293 294@dataclass 295class InvitesResponse(BaseResponse): 296 """ 297 Invites Response object 298 """ 299 300 invites: List[Invite] = field(default_factory=list) 301 302 def __getitem__(self, key): 303 _dict = self.to_dict() 304 if "invites" in _dict: 305 _dict["invites"] = [ 306 Invite.from_dict(invites) for invites in _dict["invites"] 307 ] 308 return _dict[key] 309 310 311# Usage 312 313 314@dataclass 315class Config(BaseResponse): # pylint: disable=too-many-instance-attributes 316 """ 317 Config object 318 """ 319 320 language: str = "" 321 model: str = "" 322 punctuate: Optional[bool] = field( 323 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 324 ) 325 utterances: Optional[bool] = field( 326 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 327 ) 328 diarize: Optional[bool] = field( 329 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 330 ) 331 smart_format: Optional[bool] = field( 332 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 333 ) 334 interim_results: Optional[bool] = field( 335 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 336 ) 337 topics: Optional[bool] = field( 338 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 339 ) 340 intents: Optional[bool] = field( 341 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 342 ) 343 sentiment: Optional[bool] = field( 344 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 345 ) 346 summarize: Optional[bool] = field( 347 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 348 ) 349 350 351@dataclass 352class STTUsageDetails(BaseResponse): # pylint: disable=too-many-instance-attributes 353 """ 354 Details object 355 """ 356 357 config: Config 358 usd: float = 0 359 duration: Optional[float] = field( 360 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 361 ) 362 total_audio: Optional[float] = field( 363 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 364 ) 365 channels: Optional[int] = field( 366 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 367 ) 368 streams: Optional[int] = field( 369 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 370 ) 371 method: str = "" 372 tier: Optional[str] = "" 373 models: List[str] = field(default_factory=list) 374 tags: Optional[List[str]] = field( 375 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 376 ) 377 features: List[str] = field(default_factory=list) 378 379 def __getitem__(self, key): 380 _dict = self.to_dict() 381 if "models" in _dict: 382 _dict["models"] = [str(models) for models in _dict["models"]] 383 if "tags" in _dict: 384 _dict["tags"] = [str(tags) for tags in _dict["tags"]] 385 if "features" in _dict: 386 _dict["features"] = [str(features) for features in _dict["features"]] 387 if "config" in _dict: 388 _dict["config"] = Config.from_dict(_dict["config"]) 389 return _dict[key] 390 391 392@dataclass 393class Callback(BaseResponse): 394 """ 395 Callback object 396 """ 397 398 attempts: int = 0 399 code: int = 0 400 completed: str = "" 401 402 403@dataclass 404class TokenDetail(BaseResponse): 405 """ 406 Token Detail object 407 """ 408 409 feature: str = "" 410 input: int = 0 411 model: str = "" 412 output: int = 0 413 414 415@dataclass 416class SpeechSegment(BaseResponse): 417 """ 418 Speech Segment object 419 """ 420 421 characters: int = 0 422 model: str = "" 423 tier: str = "" 424 425 426@dataclass 427class TTSUsageDetails(BaseResponse): 428 """ 429 TTS Details object 430 """ 431 432 duration: float = 0 433 speech_segments: List[SpeechSegment] = field(default_factory=list) 434 # pylint: disable=fixme 435 # TODO: audio_metadata: None 436 # pylint: enable=fixme 437 438 def __getitem__(self, key): 439 _dict = self.to_dict() 440 if "speech_segments" in _dict: 441 _dict["speech_segments"] = [ 442 SpeechSegment.from_dict(speech_segments) 443 for speech_segments in _dict["speech_segments"] 444 ] 445 return _dict[key] 446 447 448@dataclass 449class UsageResponse(BaseResponse): 450 """ 451 UsageResponse object 452 """ 453 454 details: Optional[STTUsageDetails] = field( 455 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 456 ) 457 code: int = 0 458 completed: str = "" 459 message: Optional[str] = field( 460 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 461 ) 462 tts_details: Optional[TTSUsageDetails] = field( 463 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 464 ) 465 token_details: List[TokenDetail] = field( 466 default_factory=list, metadata=dataclass_config(exclude=lambda f: f is list) 467 ) 468 469 def __getitem__(self, key): 470 _dict = self.to_dict() 471 if "details" in _dict: 472 _dict["details"] = STTUsageDetails.from_dict(_dict["details"]) 473 if "tts_details" in _dict: 474 _dict["tts_details"] = TTSUsageDetails.from_dict(_dict["tts_details"]) 475 if "token_details" in _dict: 476 _dict["token_details"] = [ 477 TokenDetail.from_dict(token_details) 478 for token_details in _dict["token_details"] 479 ] 480 return _dict[key] 481 482 483@dataclass 484class UsageRequest(BaseResponse): # pylint: disable=too-many-instance-attributes 485 """ 486 Usage Request object 487 """ 488 489 response: UsageResponse 490 project_uuid: str = "" 491 request_id: str = "" 492 created: str = "" 493 path: str = "" 494 api_key_id: str = "" 495 callback: Optional[Callback] = field( 496 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 497 ) 498 accessor: Optional[str] = field( 499 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 500 ) 501 502 def __getitem__(self, key): 503 _dict = self.to_dict() 504 if "response" in _dict: 505 _dict["response"] = UsageResponse.from_dict(_dict["response"]) 506 if "callback" in _dict: 507 _dict["callback"] = Callback.from_dict(_dict["callback"]) 508 return _dict[key] 509 510 511@dataclass 512class UsageRequestsResponse(BaseResponse): 513 """ 514 Usage Requests Response object 515 """ 516 517 page: int = 0 518 limit: int = 0 519 requests: List[UsageRequest] = field(default_factory=list) 520 521 def __getitem__(self, key): 522 _dict = self.to_dict() 523 if "requests" in _dict: 524 _dict["requests"] = [ 525 UsageRequest.from_dict(requests) for requests in _dict["requests"] 526 ] 527 return _dict[key] 528 529 530@dataclass 531class STTTokens(BaseResponse): 532 """ 533 STTTokens object 534 """ 535 536 tokens_in: int = 0 537 out: int = 0 538 539 540@dataclass 541class TTSTokens(BaseResponse): 542 """ 543 TTSTokens object 544 """ 545 546 characters: int = 0 547 requests: int = 0 548 549 550@dataclass 551class UsageSummaryResults(BaseResponse): 552 """ 553 Results object 554 """ 555 556 tokens: STTTokens 557 tts: TTSTokens 558 start: str = "" 559 end: str = "" 560 hours: int = 0 561 total_hours: int = 0 562 requests: int = 0 563 564 def __getitem__(self, key): 565 _dict = self.to_dict() 566 if "tokens" in _dict: 567 _dict["tokens"] = STTTokens.from_dict(_dict["tokens"]) 568 if "tts" in _dict: 569 _dict["tts"] = TTSTokens.from_dict(_dict["tts"]) 570 return _dict[key] 571 572 573@dataclass 574class Resolution(BaseResponse): 575 """ 576 Resolution object 577 """ 578 579 units: str = "" 580 amount: int = 0 581 582 583@dataclass 584class UsageSummaryResponse(BaseResponse): 585 """ 586 Usage Summary Response object 587 """ 588 589 resolution: Resolution 590 start: str = "" 591 end: str = "" 592 results: List[UsageSummaryResults] = field(default_factory=list) 593 594 def __getitem__(self, key): 595 _dict = self.to_dict() 596 if "resolution" in _dict: 597 _dict["resolution"] = Resolution.from_dict(_dict["resolution"]) 598 if "results" in _dict: 599 _dict["results"] = [ 600 UsageSummaryResults.from_dict(results) for results in _dict["results"] 601 ] 602 return _dict[key] 603 604 605@dataclass 606class UsageModel(BaseResponse): 607 """ 608 Usage Model object 609 """ 610 611 name: str = "" 612 language: str = "" 613 version: str = "" 614 model_id: str = "" 615 616 617@dataclass 618class UsageFieldsResponse(BaseResponse): 619 """ 620 Usage Fields Response object 621 """ 622 623 tags: Optional[List[str]] = field( 624 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 625 ) 626 models: List[UsageModel] = field(default_factory=list) 627 processing_methods: List[str] = field(default_factory=list) 628 features: List[str] = field(default_factory=list) 629 languages: Optional[List[str]] = field( 630 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 631 ) 632 633 def __getitem__(self, key): 634 _dict = self.to_dict() 635 if "tags" in _dict: 636 _dict["tags"] = [str(tags) for tags in _dict["tags"]] 637 if "models" in _dict: 638 _dict["models"] = [ 639 UsageModel.from_dict(models) for models in _dict["models"] 640 ] 641 if "processing_methods" in _dict: 642 _dict["processing_methods"] = [ 643 str(processing_methods) 644 for processing_methods in _dict["processing_methods"] 645 ] 646 if "features" in _dict: 647 _dict["features"] = [str(features) for features in _dict["features"]] 648 if "languages" in _dict: 649 _dict["languages"] = [str(languages) for languages in _dict["languages"]] 650 return _dict[key] 651 652 653# Billing 654 655 656@dataclass 657class Balance(BaseResponse): 658 """ 659 Balance object 660 """ 661 662 balance_id: str = "" 663 amount: str = "" 664 units: str = "" 665 purchase_order_id: str = "" 666 667 668@dataclass 669class BalancesResponse(BaseResponse): 670 """ 671 Balances Response object 672 """ 673 674 balances: List[Balance] = field(default_factory=list) 675 676 def __getitem__(self, key): 677 _dict = self.to_dict() 678 if "balances" in _dict: 679 _dict["balances"] = [ 680 Balance.from_dict(balances) for balances in _dict["balances"] 681 ] 682 return _dict[key]
19@dataclass 20class Message(BaseResponse): 21 """ 22 Message from the Deepgram Platform 23 """ 24 25 message: str = ""
Message from the Deepgram Platform
Inherited Members
31@dataclass 32class Project(BaseResponse): 33 """ 34 Project object 35 """ 36 37 project_id: str = "" 38 name: str = ""
Project object
Inherited Members
41@dataclass 42class ProjectsResponse(BaseResponse): 43 """ 44 Projects Response object 45 """ 46 47 projects: List[Project] = field(default_factory=list) 48 49 def __getitem__(self, key): 50 _dict = self.to_dict() 51 if "projects" in _dict: 52 _dict["projects"] = [ 53 Project.from_dict(projects) for projects in _dict["projects"] 54 ] 55 return _dict[key]
Projects Response object
ProjectsResponse( projects: List[Project] = <factory>)
projects: List[Project]
Inherited Members
61@dataclass 62class STTDetails(BaseResponse): # pylint: disable=too-many-instance-attributes 63 """ 64 STTDetails class used to define the properties of the Speech-to-Text model response object. 65 """ 66 67 name: str = "" 68 canonical_name: str = "" 69 architecture: str = "" 70 languages: List[str] = field(default_factory=list) 71 version: str = "" 72 uuid: str = "" 73 batch: bool = False 74 streaming: bool = False 75 formatted_output: bool = False 76 77 def __getitem__(self, key): 78 _dict = self.to_dict() 79 if "languages" in _dict: 80 _dict["languages"] = [str(languages) for languages in _dict["languages"]] 81 return _dict[key]
STTDetails class used to define the properties of the Speech-to-Text model response object.
STTDetails( name: str = '', canonical_name: str = '', architecture: str = '', languages: List[str] = <factory>, version: str = '', uuid: str = '', batch: bool = False, streaming: bool = False, formatted_output: bool = False)
Inherited Members
84@dataclass 85class TTSMetadata(BaseResponse): 86 """ 87 TTSMetadata class used to define the properties for a given STT or TTS model. 88 """ 89 90 accent: str = "" 91 color: str = "" 92 image: str = "" 93 sample: str = "" 94 tags: Optional[List[str]] = field( 95 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 96 )
TTSMetadata class used to define the properties for a given STT or TTS model.
TTSMetadata( accent: str = '', color: str = '', image: str = '', sample: str = '', tags: Optional[List[str]] = None)
Inherited Members
99@dataclass 100class TTSDetails(BaseResponse): 101 """ 102 TTSDetails class used to define the properties of the Text-to-Speech model response object. 103 """ 104 105 name: str = "" 106 canonical_name: str = "" 107 architecture: str = "" 108 languages: List[str] = field(default_factory=list) 109 version: str = "" 110 uuid: str = "" 111 metadata: Optional[TTSMetadata] = field( 112 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 113 ) 114 115 def __getitem__(self, key): 116 _dict = self.to_dict() 117 if "metadata" in _dict: 118 _dict["metadata"] = [ 119 TTSMetadata.from_dict(metadata) for metadata in _dict["metadata"] 120 ] 121 return _dict[key]
TTSDetails class used to define the properties of the Text-to-Speech model response object.
TTSDetails( name: str = '', canonical_name: str = '', architecture: str = '', languages: List[str] = <factory>, version: str = '', uuid: str = '', metadata: Optional[TTSMetadata] = None)
Inherited Members
127@dataclass 128class ModelResponse(BaseResponse): 129 """ 130 ModelResponse class used to define the properties of a single model. 131 """ 132 133 name: str = "" 134 canonical_name: str = "" 135 architecture: str = "" 136 language: str = "" 137 version: str = "" 138 uuid: str = "" 139 metadata: Optional[TTSMetadata] = field( 140 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 141 ) 142 143 def __getitem__(self, key): 144 _dict = self.to_dict() 145 if "metadata" in _dict: 146 _dict["metadata"] = [ 147 TTSMetadata.from_dict(metadata) for metadata in _dict["metadata"] 148 ] 149 return _dict[key]
ModelResponse class used to define the properties of a single model.
ModelResponse( name: str = '', canonical_name: str = '', architecture: str = '', language: str = '', version: str = '', uuid: str = '', metadata: Optional[TTSMetadata] = None)
Inherited Members
152@dataclass 153class ModelsResponse(BaseResponse): 154 """ 155 ModelsResponse class used to obtain a list of models. 156 """ 157 158 stt: List[STTDetails] = field(default_factory=list) 159 tts: List[TTSDetails] = field(default_factory=list) 160 161 def __getitem__(self, key): 162 _dict = self.to_dict() 163 if "stt" in _dict: 164 _dict["stt"] = [STTDetails.from_dict(stt) for stt in _dict["stt"]] 165 if "tts" in _dict: 166 _dict["tts"] = [TTSDetails.from_dict(tts) for tts in _dict["tts"]] 167 return _dict[key]
ModelsResponse class used to obtain a list of models.
ModelsResponse( stt: List[STTDetails] = <factory>, tts: List[TTSDetails] = <factory>)
stt: List[STTDetails]
tts: List[TTSDetails]
Inherited Members
173@dataclass 174class Member(BaseResponse): 175 """ 176 Member object 177 """ 178 179 email: str = "" 180 first_name: str = "" 181 last_name: str = "" 182 member_id: str = ""
Member object
Inherited Members
185@dataclass 186class MembersResponse(BaseResponse): 187 """ 188 Members Response object 189 """ 190 191 members: List[Member] = field(default_factory=list) 192 193 def __getitem__(self, key): 194 _dict = self.to_dict() 195 if "members" in _dict: 196 _dict["members"] = [ 197 Member.from_dict(members) for members in _dict["members"] 198 ] 199 return _dict[key]
Members Response object
MembersResponse( members: List[Member] = <factory>)
members: List[Member]
Inherited Members
205@dataclass 206class Key(BaseResponse): 207 """ 208 Key object 209 """ 210 211 api_key_id: str = "" 212 key: Optional[str] = field( 213 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 214 ) 215 comment: Optional[str] = "" 216 created: str = "" 217 scopes: List[str] = field(default_factory=list) 218 expiration_date: str = field( 219 default="", metadata=dataclass_config(exclude=lambda f: f is None) 220 ) 221 222 def __getitem__(self, key): 223 _dict = self.to_dict() 224 if "scopes" in _dict: 225 _dict["scopes"] = [str(scopes) for scopes in _dict["scopes"]] 226 return _dict[key]
Key object
Key( api_key_id: str = '', key: Optional[str] = None, comment: Optional[str] = '', created: str = '', scopes: List[str] = <factory>, expiration_date: str = '')
Inherited Members
229@dataclass 230class KeyResponse(BaseResponse): 231 """ 232 Key Response object 233 """ 234 235 api_key: Key 236 member: Member 237 238 def __getitem__(self, key): 239 _dict = self.to_dict() 240 if "api_key" in _dict: 241 _dict["api_key"] = Key.from_dict(_dict["api_key"]) 242 if "member" in _dict: 243 _dict["member"] = Member.from_dict(_dict["member"]) 244 return _dict[key]
Key Response object
api_key: Key
member: Member
Inherited Members
247@dataclass 248class KeysResponse(BaseResponse): 249 """ 250 Keys Response object 251 """ 252 253 api_keys: List[KeyResponse] = field(default_factory=list) 254 255 def __getitem__(self, key): 256 _dict = self.to_dict() 257 if "api_keys" in _dict: 258 _dict["api_keys"] = [ 259 KeyResponse.from_dict(api_keys) for api_keys in _dict["api_keys"] 260 ] 261 return _dict[key]
Keys Response object
KeysResponse( api_keys: List[KeyResponse] = <factory>)
api_keys: List[KeyResponse]
Inherited Members
267@dataclass 268class ScopesResponse(BaseResponse): 269 """ 270 Scopes Response object 271 """ 272 273 scopes: List[str] = field(default_factory=list) 274 275 def __getitem__(self, key): 276 _dict = self.to_dict() 277 if "scopes" in _dict: 278 _dict["scopes"] = [str(scopes) for scopes in _dict["scopes"]] 279 return _dict[key]
Scopes Response object
Inherited Members
285@dataclass 286class Invite(BaseResponse): 287 """ 288 Invite object 289 """ 290 291 email: str = "" 292 scope: str = ""
Invite object
Inherited Members
295@dataclass 296class InvitesResponse(BaseResponse): 297 """ 298 Invites Response object 299 """ 300 301 invites: List[Invite] = field(default_factory=list) 302 303 def __getitem__(self, key): 304 _dict = self.to_dict() 305 if "invites" in _dict: 306 _dict["invites"] = [ 307 Invite.from_dict(invites) for invites in _dict["invites"] 308 ] 309 return _dict[key]
Invites Response object
InvitesResponse( invites: List[Invite] = <factory>)
invites: List[Invite]
Inherited Members
315@dataclass 316class Config(BaseResponse): # pylint: disable=too-many-instance-attributes 317 """ 318 Config object 319 """ 320 321 language: str = "" 322 model: str = "" 323 punctuate: Optional[bool] = field( 324 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 325 ) 326 utterances: Optional[bool] = field( 327 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 328 ) 329 diarize: Optional[bool] = field( 330 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 331 ) 332 smart_format: Optional[bool] = field( 333 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 334 ) 335 interim_results: Optional[bool] = field( 336 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 337 ) 338 topics: Optional[bool] = field( 339 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 340 ) 341 intents: Optional[bool] = field( 342 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 343 ) 344 sentiment: Optional[bool] = field( 345 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 346 ) 347 summarize: Optional[bool] = field( 348 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 349 )
Config object
Config( language: str = '', model: str = '', punctuate: Optional[bool] = None, utterances: Optional[bool] = None, diarize: Optional[bool] = None, smart_format: Optional[bool] = None, interim_results: Optional[bool] = None, topics: Optional[bool] = None, intents: Optional[bool] = None, sentiment: Optional[bool] = None, summarize: Optional[bool] = None)
Inherited Members
352@dataclass 353class STTUsageDetails(BaseResponse): # pylint: disable=too-many-instance-attributes 354 """ 355 Details object 356 """ 357 358 config: Config 359 usd: float = 0 360 duration: Optional[float] = field( 361 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 362 ) 363 total_audio: Optional[float] = field( 364 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 365 ) 366 channels: Optional[int] = field( 367 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 368 ) 369 streams: Optional[int] = field( 370 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 371 ) 372 method: str = "" 373 tier: Optional[str] = "" 374 models: List[str] = field(default_factory=list) 375 tags: Optional[List[str]] = field( 376 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 377 ) 378 features: List[str] = field(default_factory=list) 379 380 def __getitem__(self, key): 381 _dict = self.to_dict() 382 if "models" in _dict: 383 _dict["models"] = [str(models) for models in _dict["models"]] 384 if "tags" in _dict: 385 _dict["tags"] = [str(tags) for tags in _dict["tags"]] 386 if "features" in _dict: 387 _dict["features"] = [str(features) for features in _dict["features"]] 388 if "config" in _dict: 389 _dict["config"] = Config.from_dict(_dict["config"]) 390 return _dict[key]
Details object
STTUsageDetails( config: Config, usd: float = 0, duration: Optional[float] = None, total_audio: Optional[float] = None, channels: Optional[int] = None, streams: Optional[int] = None, method: str = '', tier: Optional[str] = '', models: List[str] = <factory>, tags: Optional[List[str]] = None, features: List[str] = <factory>)
config: Config
Inherited Members
393@dataclass 394class Callback(BaseResponse): 395 """ 396 Callback object 397 """ 398 399 attempts: int = 0 400 code: int = 0 401 completed: str = ""
Callback object
Inherited Members
404@dataclass 405class TokenDetail(BaseResponse): 406 """ 407 Token Detail object 408 """ 409 410 feature: str = "" 411 input: int = 0 412 model: str = "" 413 output: int = 0
Token Detail object
Inherited Members
416@dataclass 417class SpeechSegment(BaseResponse): 418 """ 419 Speech Segment object 420 """ 421 422 characters: int = 0 423 model: str = "" 424 tier: str = ""
Speech Segment object
Inherited Members
427@dataclass 428class TTSUsageDetails(BaseResponse): 429 """ 430 TTS Details object 431 """ 432 433 duration: float = 0 434 speech_segments: List[SpeechSegment] = field(default_factory=list) 435 # pylint: disable=fixme 436 # TODO: audio_metadata: None 437 # pylint: enable=fixme 438 439 def __getitem__(self, key): 440 _dict = self.to_dict() 441 if "speech_segments" in _dict: 442 _dict["speech_segments"] = [ 443 SpeechSegment.from_dict(speech_segments) 444 for speech_segments in _dict["speech_segments"] 445 ] 446 return _dict[key]
TTS Details object
TTSUsageDetails( duration: float = 0, speech_segments: List[SpeechSegment] = <factory>)
speech_segments: List[SpeechSegment]
Inherited Members
449@dataclass 450class UsageResponse(BaseResponse): 451 """ 452 UsageResponse object 453 """ 454 455 details: Optional[STTUsageDetails] = field( 456 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 457 ) 458 code: int = 0 459 completed: str = "" 460 message: Optional[str] = field( 461 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 462 ) 463 tts_details: Optional[TTSUsageDetails] = field( 464 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 465 ) 466 token_details: List[TokenDetail] = field( 467 default_factory=list, metadata=dataclass_config(exclude=lambda f: f is list) 468 ) 469 470 def __getitem__(self, key): 471 _dict = self.to_dict() 472 if "details" in _dict: 473 _dict["details"] = STTUsageDetails.from_dict(_dict["details"]) 474 if "tts_details" in _dict: 475 _dict["tts_details"] = TTSUsageDetails.from_dict(_dict["tts_details"]) 476 if "token_details" in _dict: 477 _dict["token_details"] = [ 478 TokenDetail.from_dict(token_details) 479 for token_details in _dict["token_details"] 480 ] 481 return _dict[key]
UsageResponse object
UsageResponse( details: Optional[STTUsageDetails] = None, code: int = 0, completed: str = '', message: Optional[str] = None, tts_details: Optional[TTSUsageDetails] = None, token_details: List[TokenDetail] = <factory>)
token_details: List[TokenDetail]
Inherited Members
484@dataclass 485class UsageRequest(BaseResponse): # pylint: disable=too-many-instance-attributes 486 """ 487 Usage Request object 488 """ 489 490 response: UsageResponse 491 project_uuid: str = "" 492 request_id: str = "" 493 created: str = "" 494 path: str = "" 495 api_key_id: str = "" 496 callback: Optional[Callback] = field( 497 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 498 ) 499 accessor: Optional[str] = field( 500 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 501 ) 502 503 def __getitem__(self, key): 504 _dict = self.to_dict() 505 if "response" in _dict: 506 _dict["response"] = UsageResponse.from_dict(_dict["response"]) 507 if "callback" in _dict: 508 _dict["callback"] = Callback.from_dict(_dict["callback"]) 509 return _dict[key]
Usage Request object
UsageRequest( response: UsageResponse, project_uuid: str = '', request_id: str = '', created: str = '', path: str = '', api_key_id: str = '', callback: Optional[Callback] = None, accessor: Optional[str] = None)
response: UsageResponse
Inherited Members
512@dataclass 513class UsageRequestsResponse(BaseResponse): 514 """ 515 Usage Requests Response object 516 """ 517 518 page: int = 0 519 limit: int = 0 520 requests: List[UsageRequest] = field(default_factory=list) 521 522 def __getitem__(self, key): 523 _dict = self.to_dict() 524 if "requests" in _dict: 525 _dict["requests"] = [ 526 UsageRequest.from_dict(requests) for requests in _dict["requests"] 527 ] 528 return _dict[key]
Usage Requests Response object
UsageRequestsResponse( page: int = 0, limit: int = 0, requests: List[UsageRequest] = <factory>)
requests: List[UsageRequest]
Inherited Members
531@dataclass 532class STTTokens(BaseResponse): 533 """ 534 STTTokens object 535 """ 536 537 tokens_in: int = 0 538 out: int = 0
STTTokens object
Inherited Members
541@dataclass 542class TTSTokens(BaseResponse): 543 """ 544 TTSTokens object 545 """ 546 547 characters: int = 0 548 requests: int = 0
TTSTokens object
Inherited Members
551@dataclass 552class UsageSummaryResults(BaseResponse): 553 """ 554 Results object 555 """ 556 557 tokens: STTTokens 558 tts: TTSTokens 559 start: str = "" 560 end: str = "" 561 hours: int = 0 562 total_hours: int = 0 563 requests: int = 0 564 565 def __getitem__(self, key): 566 _dict = self.to_dict() 567 if "tokens" in _dict: 568 _dict["tokens"] = STTTokens.from_dict(_dict["tokens"]) 569 if "tts" in _dict: 570 _dict["tts"] = TTSTokens.from_dict(_dict["tts"]) 571 return _dict[key]
Results object
UsageSummaryResults( tokens: STTTokens, tts: TTSTokens, start: str = '', end: str = '', hours: int = 0, total_hours: int = 0, requests: int = 0)
tokens: STTTokens
tts: TTSTokens
Inherited Members
574@dataclass 575class Resolution(BaseResponse): 576 """ 577 Resolution object 578 """ 579 580 units: str = "" 581 amount: int = 0
Resolution object
Inherited Members
584@dataclass 585class UsageSummaryResponse(BaseResponse): 586 """ 587 Usage Summary Response object 588 """ 589 590 resolution: Resolution 591 start: str = "" 592 end: str = "" 593 results: List[UsageSummaryResults] = field(default_factory=list) 594 595 def __getitem__(self, key): 596 _dict = self.to_dict() 597 if "resolution" in _dict: 598 _dict["resolution"] = Resolution.from_dict(_dict["resolution"]) 599 if "results" in _dict: 600 _dict["results"] = [ 601 UsageSummaryResults.from_dict(results) for results in _dict["results"] 602 ] 603 return _dict[key]
Usage Summary Response object
UsageSummaryResponse( resolution: Resolution, start: str = '', end: str = '', results: List[UsageSummaryResults] = <factory>)
resolution: Resolution
results: List[UsageSummaryResults]
Inherited Members
606@dataclass 607class UsageModel(BaseResponse): 608 """ 609 Usage Model object 610 """ 611 612 name: str = "" 613 language: str = "" 614 version: str = "" 615 model_id: str = ""
Usage Model object
Inherited Members
618@dataclass 619class UsageFieldsResponse(BaseResponse): 620 """ 621 Usage Fields Response object 622 """ 623 624 tags: Optional[List[str]] = field( 625 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 626 ) 627 models: List[UsageModel] = field(default_factory=list) 628 processing_methods: List[str] = field(default_factory=list) 629 features: List[str] = field(default_factory=list) 630 languages: Optional[List[str]] = field( 631 default=None, metadata=dataclass_config(exclude=lambda f: f is None) 632 ) 633 634 def __getitem__(self, key): 635 _dict = self.to_dict() 636 if "tags" in _dict: 637 _dict["tags"] = [str(tags) for tags in _dict["tags"]] 638 if "models" in _dict: 639 _dict["models"] = [ 640 UsageModel.from_dict(models) for models in _dict["models"] 641 ] 642 if "processing_methods" in _dict: 643 _dict["processing_methods"] = [ 644 str(processing_methods) 645 for processing_methods in _dict["processing_methods"] 646 ] 647 if "features" in _dict: 648 _dict["features"] = [str(features) for features in _dict["features"]] 649 if "languages" in _dict: 650 _dict["languages"] = [str(languages) for languages in _dict["languages"]] 651 return _dict[key]
Usage Fields Response object
UsageFieldsResponse( tags: Optional[List[str]] = None, models: List[UsageModel] = <factory>, processing_methods: List[str] = <factory>, features: List[str] = <factory>, languages: Optional[List[str]] = None)
models: List[UsageModel]
Inherited Members
657@dataclass 658class Balance(BaseResponse): 659 """ 660 Balance object 661 """ 662 663 balance_id: str = "" 664 amount: str = "" 665 units: str = "" 666 purchase_order_id: str = ""
Balance object
Inherited Members
669@dataclass 670class BalancesResponse(BaseResponse): 671 """ 672 Balances Response object 673 """ 674 675 balances: List[Balance] = field(default_factory=list) 676 677 def __getitem__(self, key): 678 _dict = self.to_dict() 679 if "balances" in _dict: 680 _dict["balances"] = [ 681 Balance.from_dict(balances) for balances in _dict["balances"] 682 ] 683 return _dict[key]
Balances Response object
BalancesResponse( balances: List[Balance] = <factory>)
balances: List[Balance]