Class RealtimeAgentAdapter

Adapter that connects Scenario testing framework to OpenAI Realtime API

This adapter wraps a connected RealtimeSession to provide the Scenario framework interface. The session must be created and connected externally, ensuring the same session creation pattern is used in both browser and tests.

Example

// In beforeAll
const session = createVegetarianRecipeSession();
await session.connect({ apiKey: process.env.OPENAI_API_KEY });
const adapter = new RealtimeAgentAdapter({
  session,
  role: AgentRole.AGENT
});

// In test
await scenario.run({
  agents: [adapter, scenario.userSimulatorAgent()],
  script: [scenario.user("quick recipe"), scenario.agent()]
});

// In afterAll
session.close();

Hierarchy (View Summary)

AgentAdapter
- RealtimeAgentAdapter

Index

Constructors

constructor

new RealtimeAgentAdapter(
config: RealtimeAgentAdapterConfig,
): RealtimeAgentAdapter
Creates a new RealtimeAgentAdapter instance

The session can be either connected or unconnected. If unconnected, call connect() with an API key before use.
Parameters
- config: RealtimeAgentAdapterConfig
  Configuration for the realtime agent adapter
Returns RealtimeAgentAdapter
Overrides AgentAdapter.constructor
- Defined in src/agents/realtime/realtime-agent.adapter.ts:108

Properties

name

name: string

role

role: AgentRole

Methods

call

call(input: AgentInput): Promise<AgentReturnTypes>
Process input and generate response (implements AgentAdapter interface)

This is called by Scenario framework for each agent turn. Handles both text and audio input, returns audio message with transcript.
Parameters
- input: AgentInput
  Scenario agent input with message history
Returns Promise<AgentReturnTypes>
Agent response as audio message or text
Overrides AgentAdapter.call
- Defined in src/agents/realtime/realtime-agent.adapter.ts:145

connect

connect(params?: RealtimeSessionConnectOptions): Promise<void>
Get the connect method from the session
Parameters
- Optionalparams: RealtimeSessionConnectOptions
Returns Promise<void>
- Defined in src/agents/realtime/realtime-agent.adapter.ts:119

disconnect

disconnect(): Promise<void>
Closes the session connection

Returns Promise<void>
- Defined in src/agents/realtime/realtime-agent.adapter.ts:132

offAudioResponse

offAudioResponse(callback: (event: AudioResponseEvent) => void): void
Remove audio response listener
Parameters
- callback: (event: AudioResponseEvent) => void
  The callback function to remove
Returns void
- Defined in src/agents/realtime/realtime-agent.adapter.ts:274

onAudioResponse

onAudioResponse(callback: (event: AudioResponseEvent) => void): void
Subscribe to audio response events
Parameters
- callback: (event: AudioResponseEvent) => void
  Function called when an audio response completes
Returns void
- Defined in src/agents/realtime/realtime-agent.adapter.ts:265

Class RealtimeAgentAdapter

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RealtimeAgentAdapter

Properties

name

role

Methods

call

Parameters

Returns Promise<AgentReturnTypes>

connect

Parameters

Returns Promise<void>

disconnect

Returns Promise<void>

offAudioResponse

Parameters

Returns void

onAudioResponse

Parameters

Returns void

Settings

On This Page