ChatCompletionMessageContentPart class sealed

A content part of a user message.

Implementers

• ChatCompletionMessageContentPartAudio
• ChatCompletionMessageContentPartImage
• ChatCompletionMessageContentPartRefusal
• ChatCompletionMessageContentPartText

Annotations

• @Freezed(unionKey: 'type', unionValueCase: FreezedUnionCase.snake)

Constructors

ChatCompletionMessageContentPart.audio({@Default(ChatCompletionMessageContentPartType.inputAudio) ChatCompletionMessageContentPartType type, @JsonKey(name: 'input_audio') required ChatCompletionMessageInputAudio inputAudio})

An audio content part of a user message. Learn about audio inputs.

const

factory

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

Object construction from a JSON representation

factory

ChatCompletionMessageContentPart.image({@Default(ChatCompletionMessageContentPartType.imageUrl) ChatCompletionMessageContentPartType type, @JsonKey(name: 'image_url') required ChatCompletionMessageImageUrl imageUrl})

An image content part of a user message.

const

factory

ChatCompletionMessageContentPart.refusal({@Default(ChatCompletionMessageContentPartType.refusal) ChatCompletionMessageContentPartType type, required String refusal})

A refusal content part of a message.

const

factory

ChatCompletionMessageContentPart.text({@Default(ChatCompletionMessageContentPartType.text) ChatCompletionMessageContentPartType type, required String text})

A text content part of a message.

const

factory

Properties

copyWith → $ChatCompletionMessageContentPartCopyWith<ChatCompletionMessageContentPart>

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

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → ChatCompletionMessageContentPartType

The type of the content part, in this case text.

no setter, inherited

Methods

map<TResult extends Object?>({required TResult text(ChatCompletionMessageContentPartText value), required TResult image(ChatCompletionMessageContentPartImage value), required TResult audio(ChatCompletionMessageContentPartAudio value), required TResult refusal(ChatCompletionMessageContentPartRefusal value)}) → TResult

inherited

mapOrNull<TResult extends Object?>({TResult? text(ChatCompletionMessageContentPartText value)?, TResult? image(ChatCompletionMessageContentPartImage value)?, TResult? audio(ChatCompletionMessageContentPartAudio value)?, TResult? refusal(ChatCompletionMessageContentPartRefusal value)?}) → TResult?

inherited

maybeMap<TResult extends Object?>({TResult text(ChatCompletionMessageContentPartText value)?, TResult image(ChatCompletionMessageContentPartImage value)?, TResult audio(ChatCompletionMessageContentPartAudio value)?, TResult refusal(ChatCompletionMessageContentPartRefusal value)?, required TResult orElse()}) → TResult

inherited

maybeWhen<TResult extends Object?>({TResult text(ChatCompletionMessageContentPartType type, String text)?, TResult image(ChatCompletionMessageContentPartType type, ChatCompletionMessageImageUrl imageUrl)?, TResult audio(ChatCompletionMessageContentPartType type, ChatCompletionMessageInputAudio inputAudio)?, TResult refusal(ChatCompletionMessageContentPartType type, String refusal)?, required TResult orElse()}) → TResult

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this ChatCompletionMessageContentPart to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>({required TResult text(ChatCompletionMessageContentPartType type, String text), required TResult image(ChatCompletionMessageContentPartType type, ChatCompletionMessageImageUrl imageUrl), required TResult audio(ChatCompletionMessageContentPartType type, ChatCompletionMessageInputAudio inputAudio), required TResult refusal(ChatCompletionMessageContentPartType type, String refusal)}) → TResult

inherited

whenOrNull<TResult extends Object?>({TResult? text(ChatCompletionMessageContentPartType type, String text)?, TResult? image(ChatCompletionMessageContentPartType type, ChatCompletionMessageImageUrl imageUrl)?, TResult? audio(ChatCompletionMessageContentPartType type, ChatCompletionMessageInputAudio inputAudio)?, TResult? refusal(ChatCompletionMessageContentPartType type, String refusal)?}) → TResult?

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited