Class UpdateSessionRequest

Namespace

OpenAI.Realtime

Assembly

OpenAI-DotNet.dll

Send this event to update the session’s default configuration. The client may send this event at any time to update the session configuration, and any field may be updated at any time, except for "voice". The server will respond with a session.updated event that shows the full effective configuration. Only fields that are present are updated, thus the correct way to clear a field like "instructions" is to pass an empty string.

public sealed class UpdateSessionRequest : BaseRealtimeEvent, IClientEvent, IRealtimeEvent

Inheritance

object

BaseRealtimeEvent

UpdateSessionRequest

Implements

IClientEvent

IRealtimeEvent

Inherited Members

BaseRealtimeEvent.ToJsonString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UpdateSessionRequest()

public UpdateSessionRequest()

UpdateSessionRequest(SessionConfiguration)

public UpdateSessionRequest(SessionConfiguration configuration)

Parameters

configuration SessionConfiguration

Properties

Configuration

The session configuration options.

[JsonInclude]
[JsonPropertyName("session")]
public SessionConfiguration Configuration { get; }

Property Value

SessionConfiguration

EventId

The unique ID of the server event.

[JsonInclude]
[JsonPropertyName("event_id")]
public override string EventId { get; }

Property Value

string

Session

[JsonIgnore]
[Obsolete("use UpdateSessionRequest.Configuration")]
public SessionConfiguration Session { get; }

Property Value

SessionConfiguration

Type

[JsonInclude]
[JsonPropertyName("type")]
public override string Type { get; protected set; }

Property Value

string