Add prompt support

Author: seratch

src/agents/realtime/agent.py

@@ -6,6 +6,8 @@
 from dataclasses import dataclass, field
 from typing import Any, Callable, Generic, cast
 
+from agents.prompts import Prompt
+
 from ..agent import AgentBase
 from ..guardrail import OutputGuardrail
 from ..handoffs import Handoff
@@ -55,6 +57,12 @@ class RealtimeAgent(AgentBase, Generic[TContext]):
     return a string.
     """
 
+    prompt: Prompt | None = None
+    """A prompt object (or a function that returns a Prompt). Prompts allow you to dynamically
+    configure the instructions, tools and other config for an agent outside of your code. Only
+    usable with OpenAI models, using the Responses API.
+    """
+
     handoffs: list[RealtimeAgent[Any] | Handoff[TContext, RealtimeAgent[Any]]] = field(
         default_factory=list
     )

src/agents/realtime/config.py

@@ -8,6 +8,8 @@
 
 from typing_extensions import NotRequired, TypeAlias, TypedDict
 
+from agents.prompts import Prompt
+
 from ..guardrail import OutputGuardrail
 from ..handoffs import Handoff
 from ..model_settings import ToolChoice
@@ -92,6 +94,9 @@ class RealtimeSessionModelSettings(TypedDict):
     instructions: NotRequired[str]
     """System instructions for the model."""
 
+    prompt: NotRequired[Prompt]
+    """The prompt to use for the model."""
+
     modalities: NotRequired[list[Literal["text", "audio"]]]
     """The modalities the model should support."""
 

src/agents/realtime/openai_realtime.py

@@ -75,11 +75,13 @@
 from openai.types.realtime.session_update_event import (
     SessionUpdateEvent as OpenAISessionUpdateEvent,
 )
+from openai.types.responses.response_prompt import ResponsePrompt
 from pydantic import Field, TypeAdapter
 from typing_extensions import assert_never
 from websockets.asyncio.client import ClientConnection
 
 from agents.handoffs import Handoff
+from agents.prompts import Prompt
 from agents.realtime._default_tracker import ModelAudioTracker
 from agents.tool import FunctionTool, Tool
 from agents.util._types import MaybeAwaitable
@@ -837,11 +839,22 @@ def _get_session_config(
                 output=output_audio_config,
             )
 
+        prompt: ResponsePrompt | None = None
+        if model_settings.get("prompt") is not None:
+            _passed_prompt: Prompt = model_settings["prompt"]
+            variables: dict[str, Any] | None = _passed_prompt.get("variables")
+            prompt = ResponsePrompt(
+                id=_passed_prompt["id"],
+                variables=variables,
+                version=_passed_prompt.get("version"),
+            )
+
         # Construct full session object. `type` will be excluded at serialization time for updates.
         return OpenAISessionCreateRequest(
             model=model_name,
             type="realtime",
             instructions=model_settings.get("instructions"),
+            prompt=prompt,
             output_modalities=modalities,
             audio=audio_config,
             max_output_tokens=cast(Any, model_settings.get("max_output_tokens")),

src/agents/realtime/session.py

@@ -626,6 +626,9 @@ async def _get_updated_model_settings_from_agent(
         if starting_settings:
             updated_settings.update(starting_settings)
 
+        if agent.prompt is not None:
+            updated_settings["prompt"] = agent.prompt
+
         instructions, tools, handoffs = await asyncio.gather(
             agent.get_system_prompt(self._context_wrapper),
             agent.get_all_tools(self._context_wrapper),