API Reference
Class
OpenAIRealtimeEvent
Represents one server event received from an OpenAI Realtime WebSocket.
Inheritance
- Object
- OpenAIRealtimeEvent
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String RawJson { get; } #Gets the unmodified event JSON for fields not projected by this type.
public String? TextDelta { get; } #Gets a streamed text delta when the event contains one.
public String? AudioDelta { get; } #Gets a base64-encoded streamed audio delta when the event contains one.
public String? Transcript { get; } #Gets the final transcript carried by a completion event.
public String? ItemId { get; } #Gets the input item identifier associated with the event.
public String[] TranscriptionLanguages { get; } #Gets languages detected by a completed gpt-transcribe turn.
public String? ErrorMessage { get; } #Gets the server error message when the event represents an error.