ChatCompletionAudioOptions class abstract

Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

Available extensions

• ChatCompletionAudioOptionsPatterns

Annotations

• @freezed

Constructors

ChatCompletionAudioOptions({required ChatCompletionAudioVoice voice, required ChatCompletionAudioFormat format})

Factory constructor for ChatCompletionAudioOptions

const

factory

ChatCompletionAudioOptions.fromJson(Map<String, dynamic> json)

Object construction from a JSON representation

factory

Properties

copyWith → $ChatCompletionAudioOptionsCopyWith<ChatCompletionAudioOptions>

Create a copy of ChatCompletionAudioOptions with the given fields replaced by the non-null parameter values.

no setter, inherited

format → ChatCompletionAudioFormat

Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

voice → ChatCompletionAudioVoice

The voice the model uses to respond. Supported voices are alloy, ash, ballad, coral, echo, sage, shimmer, and verse.

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_ChatCompletionAudioOptions value)) → TResult

Available on ChatCompletionAudioOptions, provided by the ChatCompletionAudioOptionsPatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_ChatCompletionAudioOptions value)?) → TResult?

Available on ChatCompletionAudioOptions, provided by the ChatCompletionAudioOptionsPatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_ChatCompletionAudioOptions value)?, {required TResult orElse()}) → TResult

Available on ChatCompletionAudioOptions, provided by the ChatCompletionAudioOptionsPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(ChatCompletionAudioVoice voice, ChatCompletionAudioFormat format)?, {required TResult orElse()}) → TResult

Available on ChatCompletionAudioOptions, provided by the ChatCompletionAudioOptionsPatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this ChatCompletionAudioOptions to a JSON map.

inherited

toMap() → Map<String, dynamic>

Map representation of object (not serialized)

toString() → String

A string representation of this object.

inherited

validateSchema() → String?

Perform validations on the schema property values

when<TResult extends Object?>(TResult $default(ChatCompletionAudioVoice voice, ChatCompletionAudioFormat format)) → TResult

Available on ChatCompletionAudioOptions, provided by the ChatCompletionAudioOptionsPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(ChatCompletionAudioVoice voice, ChatCompletionAudioFormat format)?) → TResult?

Available on ChatCompletionAudioOptions, provided by the ChatCompletionAudioOptionsPatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

propertyNames → const List<String>

List of all property names of schema