RealtimeSessionOptions Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.Abstractions.dll

Package:

Microsoft.Extensions.AI.Abstractions v10.9.0

Source:

RealtimeSessionOptions.cs

Represents options for configuring a real-time session.

public ref class RealtimeSessionOptions

[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public class RealtimeSessionOptions

[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type RealtimeSessionOptions = class

Public Class RealtimeSessionOptions

Inheritance

Object

RealtimeSessionOptions

Attributes

ExperimentalAttribute

Constructors

Name	Description
RealtimeSessionOptions()

Properties

Name	Description
InputAudioFormat	Gets or initializes the input audio format for the session.
Instructions	Gets or initializes the default system instructions for the session.
MaxOutputTokens	Gets or initializes the maximum number of response tokens for the session.
Model	Gets or initializes the model name to use for the session.
OutputAudioFormat	Gets or initializes the output audio format for the session.
OutputModalities	Gets or initializes the output modalities for the response, for example, "text" and "audio".
RawRepresentationFactory	Gets a callback responsible for creating the raw representation of the session options from an underlying implementation.
SessionKind	Gets the session kind.
ToolMode	Gets or initializes the tool choice mode for the session.
Tools	Gets or initializes the AI tools available for generating the response.
TranscriptionOptions	Gets or initializes the transcription options for the session.
Voice	Gets or initializes the output voice for the session.
VoiceActivityDetection	Gets or initializes the voice activity detection (VAD) options for the session.