CreateChatCompletionStreamResponse class abstract

Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

Available extensions

• CreateChatCompletionStreamResponsePatterns

Annotations

• @freezed

Constructors

CreateChatCompletionStreamResponse({@JsonKey.new(includeIfNull: false) String? id, @JsonKey.new(includeIfNull: false) List<ChatCompletionStreamResponseChoice>? choices, @JsonKey.new(includeIfNull: false) int? created, @JsonKey.new(includeIfNull: false) String? model, @JsonKey.new(name: 'service_tier', includeIfNull: false, unknownEnumValue: JsonKey.nullForUndefinedEnumValue) ServiceTier? serviceTier, @JsonKey.new(name: 'system_fingerprint', includeIfNull: false) String? systemFingerprint, @JsonKey.new(includeIfNull: false) String? object, @JsonKey.new(includeIfNull: false) CompletionUsage? usage})

Factory constructor for CreateChatCompletionStreamResponse

const

factory

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

Object construction from a JSON representation

factory

Properties

choices → List<ChatCompletionStreamResponseChoice>?

A list of chat completion choices. Can contain more than one elements if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.

no setter, inherited

copyWith → $CreateChatCompletionStreamResponseCopyWith<CreateChatCompletionStreamResponse>

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

no setter, inherited

created → int?

The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String?

A unique identifier for the chat completion. Each chunk has the same ID.

no setter, inherited

model → String?

The model to generate the completion.

no setter, inherited

object → String?

The object type, which is always chat.completion.chunk.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceTier → ServiceTier?

The service tier used for processing the request. This field is only included if the service_tier parameter is specified in the request.

no setter, inherited

systemFingerprint → String?

This fingerprint represents the backend configuration that the model runs with.

no setter, inherited

usage → CompletionUsage?

Usage statistics for the completion request.

no setter, inherited

Methods

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

Available on CreateChatCompletionStreamResponse, provided by the CreateChatCompletionStreamResponsePatterns extension

A switch-like method, using callbacks.

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

Available on CreateChatCompletionStreamResponse, provided by the CreateChatCompletionStreamResponsePatterns extension

A variant of map that fallback to returning null.

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

Available on CreateChatCompletionStreamResponse, provided by the CreateChatCompletionStreamResponsePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String? id, List<ChatCompletionStreamResponseChoice>? choices, int? created, String? model, ServiceTier? serviceTier, String? systemFingerprint, String? object, CompletionUsage? usage)?, {required TResult orElse()}) → TResult

Available on CreateChatCompletionStreamResponse, provided by the CreateChatCompletionStreamResponsePatterns 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 CreateChatCompletionStreamResponse 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(String? id, List<ChatCompletionStreamResponseChoice>? choices, int? created, String? model, ServiceTier? serviceTier, String? systemFingerprint, String? object, CompletionUsage? usage)) → TResult

Available on CreateChatCompletionStreamResponse, provided by the CreateChatCompletionStreamResponsePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String? id, List<ChatCompletionStreamResponseChoice>? choices, int? created, String? model, ServiceTier? serviceTier, String? systemFingerprint, String? object, CompletionUsage? usage)?) → TResult?

Available on CreateChatCompletionStreamResponse, provided by the CreateChatCompletionStreamResponsePatterns 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