CompletionUsage class abstract

Usage statistics for the completion request.

Available extensions

• CompletionUsagePatterns

Annotations

• @freezed

Constructors

CompletionUsage({@JsonKey.new(name: 'completion_tokens', includeIfNull: false) int? completionTokens, @JsonKey.new(name: 'prompt_tokens', includeIfNull: false) int? promptTokens, @JsonKey.new(name: 'total_tokens', includeIfNull: false) int? totalTokens, @JsonKey.new(name: 'completion_tokens_details', includeIfNull: false) CompletionTokensDetails? completionTokensDetails})

Factory constructor for CompletionUsage

const

factory

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

Object construction from a JSON representation

factory

Properties

completionTokens → int?

Number of tokens in the generated completion.

no setter, inherited

completionTokensDetails → CompletionTokensDetails?

Breakdown of tokens used in a completion.

no setter, inherited

copyWith → $CompletionUsageCopyWith<CompletionUsage>

Create a copy of CompletionUsage 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

promptTokens → int?

Number of tokens in the prompt.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

totalTokens → int?

Total number of tokens used in the request (prompt + completion).

no setter, inherited

Methods

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

Available on CompletionUsage, provided by the CompletionUsagePatterns extension

A switch-like method, using callbacks.

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

Available on CompletionUsage, provided by the CompletionUsagePatterns extension

A variant of map that fallback to returning null.

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

Available on CompletionUsage, provided by the CompletionUsagePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(int? completionTokens, int? promptTokens, int? totalTokens, CompletionTokensDetails? completionTokensDetails)?, {required TResult orElse()}) → TResult

Available on CompletionUsage, provided by the CompletionUsagePatterns 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 CompletionUsage 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(int? completionTokens, int? promptTokens, int? totalTokens, CompletionTokensDetails? completionTokensDetails)) → TResult

Available on CompletionUsage, provided by the CompletionUsagePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(int? completionTokens, int? promptTokens, int? totalTokens, CompletionTokensDetails? completionTokensDetails)?) → TResult?

Available on CompletionUsage, provided by the CompletionUsagePatterns 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