Update model_inputs.py

Author: DanielHashmi

src/agents/realtime/model_inputs.py

@@ -1,35 +1,66 @@
+"""
+Realtime model input classes with Pydantic validation.
+
+This module defines input classes for sending data to realtime models.
+"""
+
 from __future__ import annotations
 
-from dataclasses import dataclass
 from typing import Any, Literal, Union
 
-from typing_extensions import NotRequired, TypeAlias, TypedDict
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import TypeAlias
 
 from .config import RealtimeSessionModelSettings
-from .model_events import RealtimeModelToolCallEvent
 
 
-class RealtimeModelRawClientMessage(TypedDict):
+class RealtimeModelRawClientMessage(BaseModel):
     """A raw message to be sent to the model."""
 
-    type: str  # explicitly required
-    other_data: NotRequired[dict[str, Any]]
-    """Merged into the message body."""
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
 
+    type: str = Field(..., description="Message type identifier.")
+    other_data: dict[str, Any] = Field(
+        default_factory=dict, description="Additional data merged into the message body."
+    )
 
-class RealtimeModelInputTextContent(TypedDict):
+
+class RealtimeModelInputTextContent(BaseModel):
     """A piece of text to be sent to the model."""
 
-    type: Literal["input_text"]
-    text: str
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
+
+    type: Literal["input_text"] = Field(
+        default="input_text", description="Content type identifier."
+    )
+    text: str = Field(..., description="The text content.")
 
 
-class RealtimeModelUserInputMessage(TypedDict):
+class RealtimeModelUserInputMessage(BaseModel):
     """A message to be sent to the model."""
 
-    type: Literal["message"]
-    role: Literal["user"]
-    content: list[RealtimeModelInputTextContent]
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
+
+    type: Literal["message"] = Field(default="message", description="Message type identifier.")
+    role: Literal["user"] = Field(default="user", description="Message role identifier.")
+    content: list[RealtimeModelInputTextContent] = Field(
+        ..., description="List of content items for the message."
+    )
 
 
 RealtimeModelUserInput: TypeAlias = Union[str, RealtimeModelUserInputMessage]
@@ -39,62 +70,117 @@ class RealtimeModelUserInputMessage(TypedDict):
 # Model messages
 
 
-@dataclass
-class RealtimeModelSendRawMessage:
+class RealtimeModelSendRawMessage(BaseModel):
     """Send a raw message to the model."""
 
-    message: RealtimeModelRawClientMessage
-    """The message to send."""
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
+
+    message: RealtimeModelRawClientMessage = Field(..., description="The message to send.")
+    type: Literal["raw_message"] = Field(
+        default="raw_message", description="Event type identifier."
+    )
 
 
-@dataclass
-class RealtimeModelSendUserInput:
+class RealtimeModelSendUserInput(BaseModel):
     """Send a user input to the model."""
 
-    user_input: RealtimeModelUserInput
-    """The user input to send."""
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
+
+    user_input: RealtimeModelUserInput = Field(..., description="The user input to send.")
+    type: Literal["user_input"] = Field(default="user_input", description="Event type identifier.")
 
 
-@dataclass
-class RealtimeModelSendAudio:
+class RealtimeModelSendAudio(BaseModel):
     """Send audio to the model."""
 
-    audio: bytes
-    commit: bool = False
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
 
+    audio: bytes = Field(..., description="The audio data to send.")
+    commit: bool = Field(default=False, description="Whether to commit the audio buffer.")
+    type: Literal["send_audio"] = Field(default="send_audio", description="Event type identifier.")
 
-@dataclass
-class RealtimeModelSendToolOutput:
-    """Send tool output to the model."""
 
-    tool_call: RealtimeModelToolCallEvent
-    """The tool call to send."""
+class RealtimeModelSendInterrupt(BaseModel):
+    """Send interrupt signal to the model."""
+
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
 
-    output: str
-    """The output to send."""
+    type: Literal["interrupt"] = Field(default="interrupt", description="Event type identifier.")
 
-    start_response: bool
-    """Whether to start a response."""
 
+class RealtimeModelSendSessionUpdate(BaseModel):
+    """Send session update to the model."""
 
-@dataclass
-class RealtimeModelSendInterrupt:
-    """Send an interrupt to the model."""
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
 
+    session: RealtimeSessionModelSettings = Field(
+        ..., description="The session configuration to update."
+    )
+    type: Literal["session_update"] = Field(
+        default="session_update", description="Event type identifier."
+    )
 
-@dataclass
-class RealtimeModelSendSessionUpdate:
-    """Send a session update to the model."""
 
-    session_settings: RealtimeSessionModelSettings
-    """The updated session settings to send."""
+class RealtimeModelSendToolOutput(BaseModel):
+    """Send tool output to the model."""
+
+    model_config = ConfigDict(
+        arbitrary_types_allowed=True,
+        validate_assignment=True,
+        extra="forbid",
+        frozen=True,
+    )
+
+    call_id: str = Field(..., description="ID of the tool call this output is for.")
+    output: str = Field(..., description="The tool output result.")
+    type: Literal["tool_output"] = Field(
+        default="tool_output", description="Event type identifier."
+    )
 
 
 RealtimeModelSendEvent: TypeAlias = Union[
     RealtimeModelSendRawMessage,
     RealtimeModelSendUserInput,
     RealtimeModelSendAudio,
-    RealtimeModelSendToolOutput,
     RealtimeModelSendInterrupt,
     RealtimeModelSendSessionUpdate,
+    RealtimeModelSendToolOutput,
 ]
+"""An event to be sent to the realtime model."""
+
+
+# Rebuild models after all definitions
+RealtimeModelRawClientMessage.model_rebuild()
+RealtimeModelInputTextContent.model_rebuild()
+RealtimeModelUserInputMessage.model_rebuild()
+RealtimeModelSendRawMessage.model_rebuild()
+RealtimeModelSendUserInput.model_rebuild()
+RealtimeModelSendAudio.model_rebuild()
+RealtimeModelSendInterrupt.model_rebuild()
+RealtimeModelSendSessionUpdate.model_rebuild()
+RealtimeModelSendToolOutput.model_rebuild()