fix: Add speaker_name field to SimpleTranscriptSegment response model #3991
Conversation
The speaker_name field was being added by _add_speaker_names_to_segments() but was stripped from the API response because it wasn't defined in the Pydantic model. This fixes BasedHardware#3962 where webhook showed speaker_name but the developer API did not.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly fixes a bug where the speaker_name field was missing from the developer API response for transcript segments. The change adds the missing field to the SimpleTranscriptSegment Pydantic model, which is the right solution. The suggestion to make the API contract even more precise by defining the new field as non-optional, since the backend logic ensures it's always provided, is valid and kept.
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug where the speaker_name field was being stripped from developer API responses despite being populated by the backend. The issue occurred because the Pydantic SimpleTranscriptSegment model didn't include the field that was being added dynamically.
- Added
speaker_name: Optional[str] = Noneto theSimpleTranscriptSegmentresponse model - Ensures speaker names appear in developer API responses (
/v1/dev/user/conversations), matching webhook behavior - Fixes the Pydantic validation issue where dynamically added fields were being filtered out
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2 participants
Summary
speaker_namefield in developer API responses_add_speaker_names_to_segments()but stripped by Pydantic because it wasn't in the modelProblem
PR #3962 added
speaker_nameto transcript segments, but the field only appeared in webhooks, not in the developer API (/v1/dev/user/conversations). This was becauseSimpleTranscriptSegmentPydantic model didn't include the field.Fix
Added
speaker_name: Optional[str] = NonetoSimpleTranscriptSegmentmodel.