refactor!: remove redundant suffixes from Transcript properties

GitOrigin-RevId: 9962b01c2508f60d64c9e0c09548a544b1137c92

Author: dmccrystal

README.md

@@ -323,7 +323,7 @@ transcript = transcriber.transcribe(
 
 
 # Get the parts of the transcript which were flagged as sensitive
-for result in transcript.content_safety_labels.results:
+for result in transcript.content_safety.results:
   print(result.text)  # sensitive text snippet
   print(result.timestamp.start)
   print(result.timestamp.end)
@@ -334,11 +334,11 @@ for result in transcript.content_safety_labels.results:
     print(label.severity) # severity of the text in relation to the category
 
 # Get the confidence of the most common labels in relation to the entire audio file
-for label, confidence in transcript.content_safety_labels.summary.items():
+for label, confidence in transcript.content_safety.summary.items():
   print(f"{confidence * 100}% confident that the audio contains {label}")
 
 # Get the overall severity of the most common labels in relation to the entire audio file
-for label, severity_confidence in transcript.content_safety_labels.severity_score_summary.items():
+for label, severity_confidence in transcript.content_safety.severity_score_summary.items():
   print(f"{severity_confidence.low * 100}% confident that the audio contains low-severity {label}")
   print(f"{severity_confidence.medium * 100}% confident that the audio contains mid-severity {label}")
   print(f"{severity_confidence.high * 100}% confident that the audio contains high-severity {label}")
@@ -369,7 +369,7 @@ transcript = transcriber.transcribe(
   config=aai.TranscriptionConfig(sentiment_analysis=True)
 )
 
-for sentiment_result in transcript.sentiment_analysis_results:
+for sentiment_result in transcript.sentiment_analysis:
   print(sentiment_result.text)
   print(sentiment_result.sentiment)  # POSITIVE, NEUTRAL, or NEGATIVE
   print(sentiment_result.confidence)
@@ -385,7 +385,7 @@ config = aai.TranscriptionConfig(sentiment_analysis=True, speaker_labels=True)
 
 # ...
 
-for sentiment_result in transcript.sentiment_analysis_results:
+for sentiment_result in transcript.sentiment_analysis:
   print(sentiment_result.speaker)
 ```
 
@@ -453,7 +453,7 @@ transcript = transcriber.transcribe(
   config=aai.TranscriptionConfig(auto_highlights=True)
 )
 
-for result in transcript.auto_highlights_result.results:
+for result in transcript.auto_highlights.results:
   print(result.text) # the important phrase
   print(result.rank) # relevancy of the phrase
   print(result.count) # number of instances of the phrase

assemblyai/transcriber.py

@@ -212,26 +212,38 @@ def summary(self) -> Optional[str]:
 
     @property
     def chapters(self) -> Optional[List[types.Chapter]]:
+        "The list of auto-chapters results"
+
         return self._impl.transcript.chapters
 
     @property
-    def content_safety_labels(self) -> Optional[types.ContentSafetyResponse]:
+    def content_safety(self) -> Optional[types.ContentSafetyResponse]:
+        "The results from the content safety analysis"
+
         return self._impl.transcript.content_safety_labels
 
     @property
-    def sentiment_analysis_results(self) -> Optional[List[types.Sentiment]]:
+    def sentiment_analysis(self) -> Optional[List[types.Sentiment]]:
+        "The list of sentiment analysis results"
+
         return self._impl.transcript.sentiment_analysis_results
 
     @property
     def entities(self) -> Optional[List[types.Entity]]:
+        "The list of entity detection results"
+
         return self._impl.transcript.entities
 
     @property
     def iab_categories(self) -> Optional[types.IABResponse]:
+        "The results from the IAB category detection"
+
         return self._impl.transcript.iab_categories_result
 
     @property
-    def auto_highlights_result(self) -> Optional[types.AutohighlightResponse]:
+    def auto_highlights(self) -> Optional[types.AutohighlightResponse]:
+        "The results from the auto-highlights model"
+
         return self._impl.transcript.auto_highlights_result
 
     @property

tests/unit/test_auto_highlights.py

@@ -99,7 +99,7 @@ def test_auto_highlights_disabled_by_default(httpx_mock: HTTPXMock):
         config=aai.TranscriptionConfig(),
     )
     assert request_body.get("auto_highlights") is None
-    assert transcript.auto_highlights_result is None
+    assert transcript.auto_highlights is None
 
 
 def test_auto_highlights_enabled(httpx_mock: HTTPXMock):
@@ -122,21 +122,21 @@ def test_auto_highlights_enabled(httpx_mock: HTTPXMock):
 
     # Check that transcript was properly parsed from JSON response
     assert transcript.error is None
-    assert transcript.auto_highlights_result is not None
+    assert transcript.auto_highlights is not None
     assert (
-        transcript.auto_highlights_result.status
+        transcript.auto_highlights.status
         == mock_response["auto_highlights_result"]["status"]
     )
 
-    assert transcript.auto_highlights_result.results is not None
-    assert len(transcript.auto_highlights_result.results) > 0
-    assert len(transcript.auto_highlights_result.results) == len(
+    assert transcript.auto_highlights.results is not None
+    assert len(transcript.auto_highlights.results) > 0
+    assert len(transcript.auto_highlights.results) == len(
         mock_response["auto_highlights_result"]["results"]
     )
 
     for response_result, transcript_result in zip(
         mock_response["auto_highlights_result"]["results"],
-        transcript.auto_highlights_result.results,
+        transcript.auto_highlights.results,
     ):
         assert transcript_result.count == response_result["count"]
         assert transcript_result.rank == response_result["rank"]

tests/unit/test_content_safety.py

@@ -132,7 +132,7 @@ def test_content_safety_disabled_by_default(httpx_mock: HTTPXMock):
         config=aai.TranscriptionConfig(),
     )
     assert request_body.get("content_safety") is None
-    assert transcript.content_safety_labels is None
+    assert transcript.content_safety is None
 
 
 def test_content_safety_enabled(httpx_mock: HTTPXMock):
@@ -155,20 +155,20 @@ def test_content_safety_enabled(httpx_mock: HTTPXMock):
 
     # Check that transcript was properly parsed from JSON response
     assert transcript.error is None
-    assert transcript.content_safety_labels is not None
+    assert transcript.content_safety is not None
 
     # Verify status
-    assert transcript.content_safety_labels.status == aai.types.StatusResult.success
+    assert transcript.content_safety.status == aai.types.StatusResult.success
 
     # Verify results
-    assert transcript.content_safety_labels.results is not None
-    assert len(transcript.content_safety_labels.results) > 0
-    assert len(transcript.content_safety_labels.results) == len(
+    assert transcript.content_safety.results is not None
+    assert len(transcript.content_safety.results) > 0
+    assert len(transcript.content_safety.results) == len(
         mock_response["content_safety_labels"]["results"]
     )
     for response_result, transcript_result in zip(
         mock_response["content_safety_labels"]["results"],
-        transcript.content_safety_labels.results,
+        transcript.content_safety.results,
     ):
         assert transcript_result.text == response_result["text"]
 
@@ -187,14 +187,14 @@ def test_content_safety_enabled(httpx_mock: HTTPXMock):
             assert transcript_label.severity == response_label["severity"]
 
     # Verify summary
-    assert transcript.content_safety_labels.summary is not None
-    assert len(transcript.content_safety_labels.summary) > 0
-    assert len(transcript.content_safety_labels.summary) == len(
+    assert transcript.content_safety.summary is not None
+    assert len(transcript.content_safety.summary) > 0
+    assert len(transcript.content_safety.summary) == len(
         mock_response["content_safety_labels"]["summary"]
     )
     for response_summary_items, transcript_summary_items in zip(
         mock_response["content_safety_labels"]["summary"].items(),
-        transcript.content_safety_labels.summary.items(),
+        transcript.content_safety.summary.items(),
     ):
         response_summary_key, response_summary_value = response_summary_items
         transcript_summary_key, transcript_summary_value = transcript_summary_items
@@ -203,17 +203,17 @@ def test_content_safety_enabled(httpx_mock: HTTPXMock):
         assert transcript_summary_value == response_summary_value
 
     # Verify severity score summary
-    assert transcript.content_safety_labels.severity_score_summary is not None
-    assert len(transcript.content_safety_labels.severity_score_summary) > 0
-    assert len(transcript.content_safety_labels.severity_score_summary) == len(
+    assert transcript.content_safety.severity_score_summary is not None
+    assert len(transcript.content_safety.severity_score_summary) > 0
+    assert len(transcript.content_safety.severity_score_summary) == len(
         mock_response["content_safety_labels"]["severity_score_summary"]
     )
     for (
         response_severity_score_summary_items,
         transcript_severity_score_summary_items,
     ) in zip(
         mock_response["content_safety_labels"]["severity_score_summary"].items(),
-        transcript.content_safety_labels.severity_score_summary.items(),
+        transcript.content_safety.severity_score_summary.items(),
     ):
         (
             response_severity_score_summary_key,

tests/unit/test_sentiment_analysis.py

@@ -84,7 +84,7 @@ def test_sentiment_analysis_disabled_by_default(httpx_mock: HTTPXMock):
         config=aai.TranscriptionConfig(),
     )
     assert request_body.get("sentiment_analysis") is None
-    assert transcript.sentiment_analysis_results is None
+    assert transcript.sentiment_analysis is None
 
 
 def test_sentiment_analysis_enabled(httpx_mock: HTTPXMock):
@@ -106,15 +106,15 @@ def test_sentiment_analysis_enabled(httpx_mock: HTTPXMock):
     # Check that transcript was properly parsed from JSON response
     assert transcript.error is None
 
-    assert transcript.sentiment_analysis_results is not None
-    assert len(transcript.sentiment_analysis_results) > 0
-    assert len(transcript.sentiment_analysis_results) == len(
+    assert transcript.sentiment_analysis is not None
+    assert len(transcript.sentiment_analysis) > 0
+    assert len(transcript.sentiment_analysis) == len(
         mock_response["sentiment_analysis_results"]
     )
 
     for response_sentiment_result, transcript_sentiment_result in zip(
         mock_response["sentiment_analysis_results"],
-        transcript.sentiment_analysis_results,
+        transcript.sentiment_analysis,
     ):
         assert transcript_sentiment_result.text == response_sentiment_result["text"]
         assert transcript_sentiment_result.start == response_sentiment_result["start"]