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

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

Author: he-james

assemblyai/__version__.py

@@ -1 +1 @@
-__version__ = "0.59.0"
+__version__ = "0.61.0"

assemblyai/types.py

@@ -645,6 +645,9 @@ class SpeakerIdentificationRequest(BaseModel):
     known_values: Optional[List[str]] = None
     "Known speaker values (required when speaker_type is 'role')"
 
+    speakers: Optional[List[Dict[str, Any]]] = None
+    "Known speaker definitions with optional descriptions for improved accuracy"
+
 
 class TranslationRequest(BaseModel):
     """
@@ -2380,13 +2383,22 @@ class TranscriptRequest(BaseTranscript):
     """
 
 
+class TranscriptWarning(BaseModel):
+    "A warning about the transcription."
+
+    message: str
+    "The warning message."
+
+
 class TranscriptMetadata(BaseModel):
     "Metadata returned from the transcription API."
 
     domain_used: Optional[str] = None
     "The domain that was actually used for the transcription."
     warning: Optional[str] = None
     "An optional warning message, if applicable."
+    warnings: Optional[List[TranscriptWarning]] = None
+    "A list of warnings about the transcription."
 
 
 class TranscriptResponse(BaseTranscript):

tests/unit/test_speaker_identification.py

@@ -0,0 +1,117 @@
+import assemblyai as aai
+
+
+def test_speaker_identification_request_with_known_values_role():
+    req = aai.SpeakerIdentificationRequest(
+        speaker_type=aai.SpeakerType.role,
+        known_values=["Agent", "Customer"],
+    )
+    assert req.speaker_type == aai.SpeakerType.role
+    assert req.known_values == ["Agent", "Customer"]
+    assert req.speakers is None
+
+
+def test_speaker_identification_request_with_known_values_name():
+    req = aai.SpeakerIdentificationRequest(
+        speaker_type=aai.SpeakerType.name,
+        known_values=["Alice", "Bob"],
+    )
+    assert req.speaker_type == aai.SpeakerType.name
+    assert req.known_values == ["Alice", "Bob"]
+    assert req.speakers is None
+
+
+def test_speaker_identification_request_with_speakers_role():
+    req = aai.SpeakerIdentificationRequest(
+        speaker_type=aai.SpeakerType.role,
+        speakers=[
+            {
+                "role": "Operador",
+                "description": "Human agent who starts the call with a standard greeting",
+            },
+            {
+                "role": "IVR",
+                "description": "Automated system playing recorded messages",
+            },
+            {
+                "role": "Customer",
+                "description": "The person who called the service center",
+            },
+        ],
+    )
+    assert req.speaker_type == aai.SpeakerType.role
+    assert req.known_values is None
+    assert len(req.speakers) == 3
+    assert req.speakers[0]["role"] == "Operador"
+    assert req.speakers[1]["role"] == "IVR"
+    assert req.speakers[2]["role"] == "Customer"
+    assert (
+        req.speakers[0]["description"]
+        == "Human agent who starts the call with a standard greeting"
+    )
+
+
+def test_speaker_identification_request_with_speakers_name():
+    req = aai.SpeakerIdentificationRequest(
+        speaker_type=aai.SpeakerType.name,
+        speakers=[
+            {
+                "name": "Michel Martin",
+                "description": "Hosts the program and interviews the guests",
+            },
+            {
+                "name": "Peter DeCarlo",
+                "description": "Answers questions from the interview",
+            },
+        ],
+    )
+    assert req.speaker_type == aai.SpeakerType.name
+    assert req.known_values is None
+    assert len(req.speakers) == 2
+    assert req.speakers[0]["name"] == "Michel Martin"
+    assert req.speakers[1]["name"] == "Peter DeCarlo"
+
+
+def test_speaker_identification_request_with_speakers_custom_properties():
+    req = aai.SpeakerIdentificationRequest(
+        speaker_type=aai.SpeakerType.name,
+        speakers=[
+            {
+                "name": "Michel Martin",
+                "description": "Hosts the program",
+                "company": "NPR",
+                "title": "Host Morning Edition",
+            },
+        ],
+    )
+    assert req.speakers[0]["company"] == "NPR"
+    assert req.speakers[0]["title"] == "Host Morning Edition"
+
+
+def test_speaker_identification_in_speech_understanding():
+    config_args = {}
+    config_args["speech_understanding"] = aai.SpeechUnderstandingRequest(
+        request=aai.SpeechUnderstandingFeatureRequests(
+            speaker_identification=aai.SpeakerIdentificationRequest(
+                speaker_type=aai.SpeakerType.role,
+                speakers=[
+                    {
+                        "role": "Operador",
+                        "description": "Human agent who starts the call with a standard greeting",
+                    },
+                    {
+                        "role": "IVR",
+                        "description": "Automated system playing recorded messages",
+                    },
+                    {
+                        "role": "Customer",
+                        "description": "The person who called the service center",
+                    },
+                ],
+            )
+        )
+    )
+    si = config_args["speech_understanding"].request.speaker_identification
+    assert si.speaker_type == aai.SpeakerType.role
+    assert len(si.speakers) == 3
+    assert si.speakers[0]["role"] == "Operador"

tests/unit/test_transcript.py

@@ -497,3 +497,65 @@ def test_speech_model_used_field_missing():
 
     # The field should be None when not present
     assert transcript_response.speech_model_used is None
+
+
+def test_metadata_warnings_present():
+    """
+    Tests that metadata.warnings is properly deserialized when present.
+    """
+    mock_transcript_response = factories.generate_dict_factory(
+        factories.TranscriptCompletedResponseFactory
+    )()
+    mock_transcript_response["metadata"] = {
+        "domain_used": None,
+        "warnings": [
+            {
+                "message": "Skipped medical-v1 correction because the language is not supported"
+            },
+        ],
+    }
+
+    transcript_response = aai.types.TranscriptResponse(**mock_transcript_response)
+
+    assert transcript_response.metadata is not None
+    assert transcript_response.metadata.warnings is not None
+    assert len(transcript_response.metadata.warnings) == 1
+    assert (
+        transcript_response.metadata.warnings[0].message
+        == "Skipped medical-v1 correction because the language is not supported"
+    )
+    assert transcript_response.metadata.domain_used is None
+
+
+def test_metadata_warnings_key_missing():
+    """
+    Tests that metadata without a warnings key deserializes correctly.
+    """
+    mock_transcript_response = factories.generate_dict_factory(
+        factories.TranscriptCompletedResponseFactory
+    )()
+    mock_transcript_response["metadata"] = {
+        "domain_used": None,
+    }
+
+    transcript_response = aai.types.TranscriptResponse(**mock_transcript_response)
+
+    assert transcript_response.metadata is not None
+    assert transcript_response.metadata.warnings is None
+    assert transcript_response.metadata.domain_used is None
+
+
+def test_metadata_not_present():
+    """
+    Tests that a response without metadata at all deserializes correctly.
+    """
+    mock_transcript_response = factories.generate_dict_factory(
+        factories.TranscriptCompletedResponseFactory
+    )()
+
+    if "metadata" in mock_transcript_response:
+        del mock_transcript_response["metadata"]
+
+    transcript_response = aai.types.TranscriptResponse(**mock_transcript_response)
+
+    assert transcript_response.metadata is None