ChatMessageRole enum

The role of a message author.

The role indicates the source of the message or the intended perspective. For example, a system message is sent to the model to set context, a user message is sent to the model as a request, and a model message is a response to the user request.

Inheritance
Available extensions

Values

system → const ChatMessageRole

A message from the system that sets context or instructions for the model.

System messages are typically sent to the model to define its behavior or persona ("system prompt"). They are not usually shown to the end user.

user → const ChatMessageRole

A message from the end user to the model ("user prompt").

model → const ChatMessageRole

A message from the model to the user ("model response").

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<ChatMessageRole>
A constant List of the values in this enum, in order of their declaration.