chore: sync sdk code with DeepLearning repo (#183)

Co-authored-by: AssemblyAI <engineering.sdk@assemblyai.com>

Author: dylan-duan-aai

assemblyai/__init__.py

@@ -42,6 +42,7 @@
     ListTranscriptResponse,
     PageDetails,
     Paragraph,
+    PIIRedactedAudioMethod,
     PIIRedactedAudioQuality,
     PIIRedactionPolicy,
     PIISubstitutionPolicy,
@@ -53,6 +54,7 @@
     RealtimeSessionOpened,
     RealtimeTranscript,
     RealtimeWord,
+    RedactPiiAudioOptions,
     Sentence,
     Sentiment,
     SentimentType,
@@ -159,9 +161,11 @@
     "Utterance",
     "UtteranceWord",
     "Paragraph",
+    "PIIRedactedAudioMethod",
     "PIIRedactedAudioQuality",
     "PIISubstitutionPolicy",
     "PIIRedactionPolicy",
+    "RedactPiiAudioOptions",
     "RawTranscriptionConfig",
     "Word",
     "WordBoost",

assemblyai/__version__.py

@@ -1 +1 @@
-__version__ = "0.57.0"
+__version__ = "0.58.0"

assemblyai/types.py

@@ -245,6 +245,19 @@ class PIIRedactedAudioQuality(str, Enum):
     wav = "wav"
 
 
+class PIIRedactedAudioMethod(str, Enum):
+    silence = "silence"
+
+
+class RedactPiiAudioOptions(BaseModel):
+    """Options for controlling PII audio redaction behavior."""
+
+    override_audio_redaction_method: Optional[PIIRedactedAudioMethod] = Field(
+        None,
+        description="Override the default audio redaction method (beep) with an alternative (silence).",
+    )
+
+
 class EntityType(str, Enum):
     """
     Used for AssemblyAI's Entity Detection feature.
@@ -854,6 +867,8 @@ class RawTranscriptionConfig(BaseModel):
     "Generate a copy of the original media file with spoken PII 'beeped' out."
     redact_pii_audio_quality: Optional[PIIRedactedAudioQuality] = None
     "The quality of the redacted audio file in case `redact_pii_audio` is enabled."
+    redact_pii_audio_options: Optional[RedactPiiAudioOptions] = None
+    "Options for controlling PII audio redaction behavior."
     redact_pii_policies: Optional[List[PIIRedactionPolicy]] = None
     "The list of PII Redaction policies to enable."
     redact_pii_sub: Optional[PIISubstitutionPolicy] = None
@@ -987,6 +1002,7 @@ def __init__(
         redact_pii: Optional[bool] = None,
         redact_pii_audio: Optional[bool] = None,
         redact_pii_audio_quality: Optional[PIIRedactedAudioQuality] = None,
+        redact_pii_audio_options: Optional[RedactPiiAudioOptions] = None,
         redact_pii_policies: Optional[List[PIIRedactionPolicy]] = None,
         redact_pii_sub: Optional[PIISubstitutionPolicy] = None,
         speaker_labels: Optional[bool] = None,
@@ -1038,6 +1054,7 @@ def __init__(
             redact_pii: Redact PII from the transcribed text.
             redact_pii_audio: Generate a copy of the original media file with spoken PII 'beeped' out (new audio only available for 24 hours).
             redact_pii_audio_quality: The quality of the redacted audio file in case `redact_pii_audio` is enabled.
+            redact_pii_audio_options: Options for controlling PII audio redaction behavior (e.g., override the redaction method to silence).
             redact_pii_policies: The list of PII Redaction policies to enable.
             redact_pii_sub: The replacement logic for detected PII.
             speaker_labels: Enable Speaker Diarization.
@@ -1094,6 +1111,7 @@ def __init__(
             redact_pii,
             redact_pii_audio,
             redact_pii_audio_quality,
+            redact_pii_audio_options,
             redact_pii_policies,
             redact_pii_sub,
         )
@@ -1358,6 +1376,12 @@ def redact_pii_audio_quality(self) -> Optional[PIIRedactedAudioQuality]:
 
         return self._raw_transcription_config.redact_pii_audio_quality
 
+    @property
+    def redact_pii_audio_options(self) -> Optional[RedactPiiAudioOptions]:
+        "Options for controlling PII audio redaction behavior."
+
+        return self._raw_transcription_config.redact_pii_audio_options
+
     @property
     def redact_pii_policies(self) -> Optional[List[PIIRedactionPolicy]]:
         "Returns a list of set of defined PII redaction policies."
@@ -1767,6 +1791,7 @@ def set_redact_pii(
         enable: Optional[bool] = True,
         redact_audio: Optional[bool] = None,
         redact_audio_quality: Optional[PIIRedactedAudioQuality] = None,
+        redact_audio_options: Optional[RedactPiiAudioOptions] = None,
         policies: Optional[List[PIIRedactionPolicy]] = None,
         substitution: Optional[PIISubstitutionPolicy] = None,
     ) -> Self:
@@ -1777,6 +1802,7 @@ def set_redact_pii(
             enable: whether to enable or disable the PII Redaction feature.
             redact_audio: Generate a copy of the original media file with spoken PII 'beeped' out. NOTE: The copy is available for 24h
             redact_audio_quality: The quality of the redacted audio file in case `redact_audio` is enabled.
+            redact_audio_options: Options for controlling PII audio redaction behavior (e.g., override the redaction method to silence).
             policies: A list of PII redaction policies to enable.
             substitution: The replacement logic for detected PII (`PIISubstutionPolicy.hash` by default).
         """
@@ -1785,6 +1811,7 @@ def set_redact_pii(
             self._raw_transcription_config.redact_pii = None
             self._raw_transcription_config.redact_pii_audio = None
             self._raw_transcription_config.redact_pii_audio_quality = None
+            self._raw_transcription_config.redact_pii_audio_options = None
             self._raw_transcription_config.redact_pii_policies = None
             self._raw_transcription_config.redact_pii_sub = None
 
@@ -1796,6 +1823,7 @@ def set_redact_pii(
         self._raw_transcription_config.redact_pii = True
         self._raw_transcription_config.redact_pii_audio = redact_audio
         self._raw_transcription_config.redact_pii_audio_quality = redact_audio_quality
+        self._raw_transcription_config.redact_pii_audio_options = redact_audio_options
         self._raw_transcription_config.redact_pii_policies = policies
         self._raw_transcription_config.redact_pii_sub = substitution
 
@@ -2243,6 +2271,8 @@ class BaseTranscript(BaseModel):
     "Generate a copy of the original media file with spoken PII 'beeped' out."
     redact_pii_audio_quality: Optional[PIIRedactedAudioQuality] = None
     "The quality of the redacted audio file in case `redact_pii_audio` is enabled."
+    redact_pii_audio_options: Optional[RedactPiiAudioOptions] = None
+    "Options for controlling PII audio redaction behavior."
     redact_pii_policies: Optional[List[PIIRedactionPolicy]] = None
     "The list of PII Redaction policies to enable."
     redact_pii_sub: Optional[PIISubstitutionPolicy] = None

tests/unit/test_redact_pii.py

@@ -95,6 +95,63 @@ def test_redact_pii_enabled_with_optional_params(httpx_mock: HTTPXMock):
     assert request_body.get("redact_pii_sub") == sub_type
 
 
+def test_redact_pii_audio_options(httpx_mock: HTTPXMock):
+    """
+    Tests that `redact_pii_audio_options` is included in the request body
+    when provided alongside `redact_pii_audio`.
+    """
+    policies = [
+        aai.types.PIIRedactionPolicy.person_name,
+    ]
+    audio_options = aai.RedactPiiAudioOptions(
+        override_audio_redaction_method=aai.PIIRedactedAudioMethod.silence,
+    )
+
+    request_body, _ = unit_test_utils.submit_mock_transcription_request(
+        httpx_mock,
+        mock_response=factories.generate_dict_factory(
+            TranscriptWithPIIRedactionResponseFactory
+        )(),
+        config=aai.TranscriptionConfig(
+            redact_pii=True,
+            redact_pii_audio=True,
+            redact_pii_audio_options=audio_options,
+            redact_pii_policies=policies,
+        ),
+    )
+
+    assert request_body.get("redact_pii") is True
+    assert request_body.get("redact_pii_audio") is True
+    assert request_body.get("redact_pii_audio_options") == {
+        "override_audio_redaction_method": "silence",
+    }
+
+
+def test_redact_pii_audio_options_excluded_when_disabled(httpx_mock: HTTPXMock):
+    """
+    Tests that `redact_pii_audio_options` is excluded from the request body
+    when `redact_pii` is not enabled.
+    """
+    audio_options = aai.RedactPiiAudioOptions(
+        override_audio_redaction_method=aai.PIIRedactedAudioMethod.silence,
+    )
+
+    request_body, _ = unit_test_utils.submit_mock_transcription_request(
+        httpx_mock,
+        mock_response=factories.generate_dict_factory(
+            factories.TranscriptCompletedResponseFactory
+        )(),
+        config=aai.TranscriptionConfig(
+            redact_pii=False,
+            redact_pii_audio=True,
+            redact_pii_audio_options=audio_options,
+            redact_pii_policies=[aai.types.PIIRedactionPolicy.date],
+        ),
+    )
+
+    assert request_body.get("redact_pii_audio_options") is None
+
+
 def test_redact_pii_fails_without_policies(httpx_mock: HTTPXMock):
     """
     Tests that enabling `redact_pii` without specifying any policies
@@ -136,6 +193,7 @@ def test_redact_pii_params_excluded_when_disabled(httpx_mock: HTTPXMock):
 
     assert request_body.get("redact_pii") is None
     assert request_body.get("redact_pii_audio") is None
+    assert request_body.get("redact_pii_audio_options") is None
     assert request_body.get("redact_pii_policies") is None
     assert request_body.get("redact_pii_sub") is None