CreateMessageRequest class

Request object for the Create message endpoint.

Annotations

• @freezed

Constructors

CreateMessageRequest.new({required MessageRole role, @_CreateMessageRequestContentConverter() required CreateMessageRequestContent content, @JsonKey(includeIfNull: false) List<MessageAttachment>? attachments, @JsonKey(includeIfNull: false) Map<String, dynamic>? metadata})

Factory constructor for CreateMessageRequest

const

factory

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

Object construction from a JSON representation

factory

Properties

attachments → List<MessageAttachment>?

A list of files attached to the message, and the tools they were added to.

no setter, inherited

content → CreateMessageRequestContent

The content of the message.

no setter, inherited

copyWith → $CreateMessageRequestCopyWith<CreateMessageRequest>

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

metadata → Map<String, dynamic>?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

no setter, inherited

role → MessageRole

The entity that produced the message. One of user or assistant.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this CreateMessageRequest 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

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

propertyNames → const List<String>

List of all property names of schema