Jaa

SessionUpdateRealtimeClientMessage Class

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v10.4.1
Source:
SessionUpdateRealtimeClientMessage.cs

Represents a client message that requests updating the session configuration.

public ref class SessionUpdateRealtimeClientMessage : Microsoft::Extensions::AI::RealtimeClientMessage
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public class SessionUpdateRealtimeClientMessage : Microsoft.Extensions.AI.RealtimeClientMessage
public class SessionUpdateRealtimeClientMessage : Microsoft.Extensions.AI.RealtimeClientMessage
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type SessionUpdateRealtimeClientMessage = class
    inherit RealtimeClientMessage
type SessionUpdateRealtimeClientMessage = class
    inherit RealtimeClientMessage
Public Class SessionUpdateRealtimeClientMessage
Inherits RealtimeClientMessage
Inheritance
Object
RealtimeClientMessage
SessionUpdateRealtimeClientMessage
Attributes
ExperimentalAttribute

Remarks

Sending this message requests that the provider update the active session with new options. Not all providers support mid-session updates. Providers that do not support this message may ignore it or throw a NotSupportedException.

When a provider processes this message, it should update its Options property to reflect the new configuration.

Constructors

Name Description
SessionUpdateRealtimeClientMessage(RealtimeSessionOptions)

Initializes a new instance of the SessionUpdateRealtimeClientMessage class.

Properties

Name Description
MessageId

Gets or sets the optional message ID associated with the message. This can be used for tracking and correlation purposes.

(Inherited from RealtimeClientMessage)
Options

Gets or sets the session options to apply.
RawRepresentation

Gets or sets the raw representation of the message. This can be used to send the raw data to the model.

(Inherited from RealtimeClientMessage)

Applies to