SessionUpdateRealtimeClientMessage Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.RealtimeClientMessagepublic class SessionUpdateRealtimeClientMessage : Microsoft.Extensions.AI.RealtimeClientMessage[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type SessionUpdateRealtimeClientMessage = class
inherit RealtimeClientMessagetype SessionUpdateRealtimeClientMessage = class
inherit RealtimeClientMessagePublic Class SessionUpdateRealtimeClientMessage
Inherits RealtimeClientMessage- Inheritance
- Attributes
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) |
