API Reference
OpenAIRealtimeSession
Owns an active OpenAI Realtime WebSocket session.
Inheritance
- Object
- OpenAIRealtimeSession
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
Methods
public Task AppendAudioAsync(Byte[] audioBytes, CancellationToken cancellationToken = default) #TaskAppends base64-encoded PCM audio bytes to the session input buffer.
Parameters
- audioBytes System.Byte[]
- cancellationToken System.Threading.CancellationToken = default
public async Task CloseAsync(CancellationToken cancellationToken = default) #TaskCloses the Realtime WebSocket when possible.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public async Task CommitAudioAsync(Boolean requestResponse = true, CancellationToken cancellationToken = default) #TaskCommits the current input audio buffer and optionally asks the model to respond.
Parameters
- requestResponse System.Boolean = true
- cancellationToken System.Threading.CancellationToken = default
public Void Dispose() #VoidPerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public async Task<OpenAIRealtimeEvent?> ReceiveEventAsync(CancellationToken cancellationToken = default) #Task<OpenAIRealtimeEvent?>Receives the next complete Realtime server event. Only one receive operation may run at a time.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public Task RequestResponseAsync(CancellationToken cancellationToken = default) #TaskRequests a model response for the current conversation state.
Parameters
- cancellationToken System.Threading.CancellationToken = default
public async Task SendEventAsync(String eventJson, CancellationToken cancellationToken = default) #TaskSends a raw Realtime client event.
Parameters
- eventJson System.String
- cancellationToken System.Threading.CancellationToken = default
public async Task SendImageAsync(String imageUrl, Boolean requestResponse = true, CancellationToken cancellationToken = default) #TaskSends an image URL or data URL as a user input item and optionally asks the model to respond.
Parameters
- imageUrl System.String
- requestResponse System.Boolean = true
- cancellationToken System.Threading.CancellationToken = default
public async Task SendTextAsync(String text, Boolean requestResponse = true, CancellationToken cancellationToken = default) #TaskSends a user text item and optionally asks the model to respond.
Parameters
- text System.String
- requestResponse System.Boolean = true
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?