Class Options

Namespace

OpenAI.Realtime

Assembly

OpenAI-DotNet.dll

[Obsolete("use SessionConfiguration or RealtimeResponseCreateParams")]
public sealed class Options

Inheritance

object

Options

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Options()

public Options()

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

public Options(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

ExpiresAt

[JsonInclude]
[JsonIgnore]
public DateTime? ExpiresAt { get; }

Property Value

DateTime?

ExpiresAtTimeUnixSeconds

[JsonInclude]
[JsonPropertyName("expires_at")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? ExpiresAtTimeUnixSeconds { get; }

Property Value

int?

Id

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

Property Value

string

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

Object

[JsonInclude]
[JsonPropertyName("object")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string Object { 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 IVoiceActivityDetectionSettings VoiceActivityDetectionSettings { get; }

Property Value

IVoiceActivityDetectionSettings

Operators

implicit operator RealtimeResponseCreateParams(Options)

public static implicit operator RealtimeResponseCreateParams(Options options)

Parameters

options Options

Returns

RealtimeResponseCreateParams

implicit operator SessionConfiguration(Options)

public static implicit operator SessionConfiguration(Options options)

Parameters

options Options

Returns

SessionConfiguration