API Reference
Class
OpenAIRealtimeSessionOptions
Describes a Realtime session and its short-lived client credential.
Inheritance
- Object
- OpenAIRealtimeSessionOptions
Usage
Explore 2 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.
Accepted by parameters 2
Constructors
public OpenAIRealtimeSessionOptions() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String? Instructions { get; set; } #Optional session instructions.
public String[] OutputModalities { get; set; } #Output modalities requested from the model. Voice sessions normally use audio; text-only sessions can set this to text.
public String? Voice { get; set; } #Optional Realtime voice name. When omitted, the service default is used.
public OpenAIRealtimeTranscriptionOptions? InputTranscription { get; set; } #Gets or sets input transcription. Leave null when the client does not need user-audio transcript events.
public TimeSpan ClientSecretLifetime { get; set; } #Lifetime requested for the short-lived client credential.