CreateEmbeddingResponse class abstract

Represents an embedding vector returned by embedding endpoint.

Available extensions

• CreateEmbeddingResponsePatterns

Annotations

• @freezed

Constructors

CreateEmbeddingResponse({required List<Embedding> data, required String model, required CreateEmbeddingResponseObject object, @JsonKey.new(includeIfNull: false) EmbeddingUsage? usage})

Factory constructor for CreateEmbeddingResponse

const

factory

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

Object construction from a JSON representation

factory

Properties

copyWith → $CreateEmbeddingResponseCopyWith<CreateEmbeddingResponse>

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

no setter, inherited

data → List<Embedding>

The list of embeddings generated by the model.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

model → String

The name of the model used to generate the embedding.

no setter, inherited

object → CreateEmbeddingResponseObject

The object type, which is always "list".

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

usage → EmbeddingUsage?

The usage information for the request.

no setter, inherited

Methods

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

Available on CreateEmbeddingResponse, provided by the CreateEmbeddingResponsePatterns extension

A switch-like method, using callbacks.

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

Available on CreateEmbeddingResponse, provided by the CreateEmbeddingResponsePatterns extension

A variant of map that fallback to returning null.

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

Available on CreateEmbeddingResponse, provided by the CreateEmbeddingResponsePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(List<Embedding> data, String model, CreateEmbeddingResponseObject object, EmbeddingUsage? usage)?, {required TResult orElse()}) → TResult

Available on CreateEmbeddingResponse, provided by the CreateEmbeddingResponsePatterns 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 CreateEmbeddingResponse 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(List<Embedding> data, String model, CreateEmbeddingResponseObject object, EmbeddingUsage? usage)) → TResult

Available on CreateEmbeddingResponse, provided by the CreateEmbeddingResponsePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(List<Embedding> data, String model, CreateEmbeddingResponseObject object, EmbeddingUsage? usage)?) → TResult?

Available on CreateEmbeddingResponse, provided by the CreateEmbeddingResponsePatterns 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