Class SessionConfiguration

Namespace

OpenAI.Realtime

Assembly

OpenAI-DotNet.dll

public class SessionConfiguration

Inheritance

object

SessionConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SessionConfiguration()

public SessionConfiguration()

SessionConfiguration(Model, Modality, Voice, string, RealtimeAudioFormat, RealtimeAudioFormat, Model, VoiceActivityDetectionSettings, IEnumerable<Tool>, string, float?, int?)

public SessionConfiguration(Model model, Modality modalities = Modality.Text | Modality.Audio, Voice voice = null, string instructions = null, RealtimeAudioFormat inputAudioFormat = RealtimeAudioFormat.PCM16, RealtimeAudioFormat outputAudioFormat = RealtimeAudioFormat.PCM16, Model transcriptionModel = null, VoiceActivityDetectionSettings turnDetectionSettings = null, IEnumerable<Tool> tools = null, string toolChoice = null, float? temperature = null, int? maxResponseOutputTokens = null)

Parameters

model Model

modalities Modality

voice Voice

instructions string

inputAudioFormat RealtimeAudioFormat

outputAudioFormat RealtimeAudioFormat

transcriptionModel Model

turnDetectionSettings VoiceActivityDetectionSettings

tools IEnumerable<Tool>

toolChoice string

temperature float?

maxResponseOutputTokens int?

Properties

InputAudioFormat

[JsonInclude]
[JsonPropertyName("input_audio_format")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonConverter(typeof(JsonStringEnumConverter<RealtimeAudioFormat>))]
public RealtimeAudioFormat InputAudioFormat { get; }

Property Value

RealtimeAudioFormat

InputAudioTranscriptionSettings

[JsonInclude]
[JsonPropertyName("input_audio_transcription")]
public InputAudioTranscriptionSettings InputAudioTranscriptionSettings { get; }

Property Value

InputAudioTranscriptionSettings

Instructions

[JsonInclude]
[JsonPropertyName("instructions")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Instructions { get; }

Property Value

string

MaxResponseOutputTokens

[JsonInclude]
[JsonPropertyName("max_response_output_tokens")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public object MaxResponseOutputTokens { get; }

Property Value

object

Modalities

[JsonInclude]
[JsonPropertyName("modalities")]
[JsonConverter(typeof(ModalityConverter))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Modality Modalities { get; }

Property Value

Modality

Model

[JsonInclude]
[JsonPropertyName("model")]
public string Model { get; }

Property Value

string

OutputAudioFormat

[JsonInclude]
[JsonPropertyName("output_audio_format")]
[JsonIgnore(Condition = JsonIgnoreCondition.Never)]
[JsonConverter(typeof(JsonStringEnumConverter<RealtimeAudioFormat>))]
public RealtimeAudioFormat OutputAudioFormat { get; }

Property Value

RealtimeAudioFormat

Temperature

[JsonInclude]
[JsonPropertyName("temperature")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public float? Temperature { get; }

Property Value

float?

ToolChoice

[JsonInclude]
[JsonPropertyName("tool_choice")]
public object ToolChoice { get; }

Property Value

object

Tools

[JsonInclude]
[JsonPropertyName("tools")]
public IReadOnlyList<Function> Tools { get; }

Property Value

IReadOnlyList<Function>

Voice

[JsonInclude]
[JsonPropertyName("voice")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Voice { get; }

Property Value

string

VoiceActivityDetectionSettings

[JsonInclude]
[JsonPropertyName("turn_detection")]
[JsonConverter(typeof(VoiceActivityDetectionSettingsConverter))]
public VoiceActivityDetectionSettings VoiceActivityDetectionSettings { get; }

Property Value

VoiceActivityDetectionSettings