fix: add missing properties to Transcript class (#7)

Co-authored-by: AssemblyAI <[email protected]>

Author: s0h3yl

assemblyai/__init__.py

@@ -1,34 +1,32 @@
-from .transcriber import Transcriber, Transcript, TranscriptGroup
 from .client import Client
 from .lemur import Lemur
-
+from .transcriber import Transcriber, Transcript, TranscriptGroup
 from .types import (
     AssemblyAIError,
-    Settings,
-    TranscriptError,
-    TranscriptStatus,
-    TranscriptionConfig,
-    Utterance,
-    UtteranceWord,
     LanguageCode,
-    Paragraph,
-    Sentence,
-    LemurModel,
     LemurError,
+    LemurModel,
     LemurQuestion,
     LemurQuestionResult,
-    SummarizationModel,
+    Paragraph,
+    PIIRedactionPolicy,
     PIISubstitutionPolicy,
     RawTranscriptionConfig,
+    Sentence,
+    Settings,
+    SummarizationModel,
     SummarizationType,
+    Timestamp,
+    TranscriptError,
+    TranscriptionConfig,
+    TranscriptStatus,
+    Utterance,
+    UtteranceWord,
+    Word,
     WordBoost,
     WordSearchMatch,
-    Word,
-    Timestamp,
-    PIIRedactionPolicy,
 )
 
-
 settings = Settings()
 """Global settings object that applies to all classes that use the `Client` class."""
 

assemblyai/api.py

@@ -1,9 +1,9 @@
-from typing import Optional, List, BinaryIO
-
-from . import types
+from typing import BinaryIO, List, Optional
 
 import httpx
 
+from . import types
+
 
 def _get_error_message(response: httpx.Response) -> str:
     """

assemblyai/client.py

@@ -1,11 +1,11 @@
 import threading
-from typing import Optional, ClassVar
+from typing import ClassVar, Optional
+
+import httpx
 from typing_extensions import Self
 
 from . import types
 
-import httpx
-
 
 class Client:
     _default: ClassVar[Optional["Client"]] = None

assemblyai/lemur.py

@@ -1,7 +1,8 @@
-from typing import Optional, List, Union, Dict, Any
+from typing import Any, Dict, List, Optional, Union
 
-from . import api, types
+from . import api
 from . import client as _client
+from . import types
 
 
 class _LemurImpl:

assemblyai/transcriber.py

@@ -1,13 +1,16 @@
 from __future__ import annotations
+
+import concurrent.futures
 import os
 import time
+from typing import Dict, Iterator, List, Optional, Union
 from urllib.parse import urlparse
-import concurrent.futures
-from typing import Dict, Iterator, Optional, List, Union
+
 from typing_extensions import Self
 
-from . import lemur, types, api
+from . import api
 from . import client as _client
+from . import lemur, types
 
 
 class _TranscriptImpl:
@@ -213,6 +216,45 @@ def error(self) -> Optional[str]:
 
         return self._impl.transcript.error
 
+    @property
+    def words(self) -> Optional[List[types.Word]]:
+        "The list of words in the transcript"
+
+        return self._impl.transcript.words
+
+    @property
+    def utterances(self) -> Optional[List[types.Utterance]]:
+        """
+        When `dual_channel` or `speaker_labels` is enabled,
+        a list of utterances in the transcript.
+        """
+
+        return self._impl.transcript.utterances
+
+    @property
+    def confidence(self) -> Optional[float]:
+        "The confidence our model has in the transcribed text, between 0 and 1"
+
+        return self._impl.transcript.confidence
+
+    @property
+    def audio_duration(self) -> Optional[float]:
+        "The duration of the audio in seconds"
+
+        return self._impl.transcript.audio_duration
+
+    @property
+    def webhook_status_code(self) -> Optional[int]:
+        "The status code we received from your server when delivering your webhook"
+
+        return self._impl.transcript.webhook_status_code
+
+    @property
+    def webhook_auth(self) -> Optional[bool]:
+        "Whether the webhook was sent with an HTTP authentication header"
+
+        return self._impl.transcript.webhook_auth
+
     @property
     def lemur(self) -> lemur.Lemur:
         """

assemblyai/types.py

@@ -1,9 +1,8 @@
 from enum import Enum
-
-from typing import Optional, Dict, Any, List, Tuple, Union, Sequence
-from typing_extensions import Self
+from typing import Any, Dict, List, Optional, Sequence, Tuple, Union
 
 from pydantic import BaseModel, BaseSettings, Extra
+from typing_extensions import Self
 
 
 class AssemblyAIError(Exception):
@@ -1271,7 +1270,7 @@ class BaseTranscript(BaseModel):
     # iab_categories: bool = False
     # "Enable Topic Detection."
 
-    custom_spelling: Optional[List[dict]]
+    custom_spelling: Optional[List[Dict[str, str]]]
     "Customize how words are spelled and formatted using to and from values"
 
     disfluencies: Optional[bool]
@@ -1347,7 +1346,7 @@ class TranscriptResponse(BaseTranscript):
     audio_duration: Optional[float]
     "The duration of your media file, in seconds"
 
-    webhook_status_code: Optional[str]
+    webhook_status_code: Optional[int]
     "The status code we received from your server when delivering your webhook"
     webhook_auth: Optional[bool]
     "Whether the webhook was sent with an HTTP authentication header"

setup.py

@@ -1,13 +1,13 @@
 from pathlib import Path
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 long_description = (Path(__file__).parent / "README.md").read_text()
 
 
 setup(
     name="assemblyai",
-    version="0.4.0",
+    version="0.4.1",
     description="AssemblyAI Python SDK",
     author="AssemblyAI",
     author_email="[email protected]",

tests/unit/factories.py

@@ -4,7 +4,7 @@
 """
 
 from functools import partial
-from typing import Any, Dict, Callable
+from typing import Any, Callable, Dict
 
 import factory
 import factory.base

tests/unit/test_config.py

@@ -1,9 +1,9 @@
 import inspect
 
-import assemblyai as aai
-
 import pytest
 
+import assemblyai as aai
+
 
 def test_configuration_are_none_by_default():
     """

tests/unit/test_lemur.py

@@ -1,14 +1,12 @@
-import httpx
-from pytest_httpx import HTTPXMock
 import uuid
 
+import httpx
+import pytest
+from pytest_httpx import HTTPXMock
 
 import assemblyai as aai
 from tests.unit import factories
 
-import pytest
-
-
 aai.settings.api_key = "test"