ChatCompletionStreamOptions class abstract

Options for streaming response. Only set this when you set stream: true.

Available extensions

• ChatCompletionStreamOptionsPatterns

Annotations

• @freezed

Constructors

ChatCompletionStreamOptions({@JsonKey.new(name: 'include_usage', includeIfNull: false) bool? includeUsage})

Factory constructor for ChatCompletionStreamOptions

const

factory

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

Object construction from a JSON representation

factory

Properties

copyWith → $ChatCompletionStreamOptionsCopyWith<ChatCompletionStreamOptions>

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

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

includeUsage → bool?

If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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

Available on ChatCompletionStreamOptions, provided by the ChatCompletionStreamOptionsPatterns extension

A switch-like method, using callbacks.

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

Available on ChatCompletionStreamOptions, provided by the ChatCompletionStreamOptionsPatterns extension

A variant of map that fallback to returning null.

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

Available on ChatCompletionStreamOptions, provided by the ChatCompletionStreamOptionsPatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(bool? includeUsage)?, {required TResult orElse()}) → TResult

Available on ChatCompletionStreamOptions, provided by the ChatCompletionStreamOptionsPatterns 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 ChatCompletionStreamOptions 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(bool? includeUsage)) → TResult

Available on ChatCompletionStreamOptions, provided by the ChatCompletionStreamOptionsPatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(bool? includeUsage)?) → TResult?

Available on ChatCompletionStreamOptions, provided by the ChatCompletionStreamOptionsPatterns 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