AdapterConnectOptions

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:26

Options a RealtimeSession hands an adapter on connect.

Properties

backendInstructions?

readonly optional backendInstructions?: string

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:30

Tool-routing instructions for a separate managed backend. Adapters without one ignore this field; managed adapters fall back to instructions when omitted.

conversationInstructions?

readonly optional conversationInstructions?: string

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:37

Conversation-only instructions for providers with a separate conversational frontend. backendInstructions (or instructions when absent) and tools configure their managed tool backend. Legacy adapters may ignore this field and keep their existing instruction path.

getInitialGrounding?

readonly optional getInitialGrounding?: () => string

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:39

Concise observed UI data for adapters that seed grounding when ready; never behavioral instructions.

Returns

string

getRecoveryContext?

readonly optional getRecoveryContext?: () => VoiceRecoverySnapshot

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:41

Lazy bounded application evidence for startup recovery; never provider commands or authoritative final turns.

Returns

VoiceRecoverySnapshot

instructions

readonly instructions: string

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:28

prepareGreeting?

readonly optional prepareGreeting?: boolean

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:48

Whether this connection may present the configured fixed greeting. Defaults to true for direct adapter callers. RealtimeSession always sets this explicitly so reconnects with terminal greeting proof can skip greeting-only microphone preparation.

tools

readonly tools: readonly RealtimeToolSpec<string>[]

Defined in: packages/realtime/src/lib/realtime-session/provider-adapter.types.ts:27