Chat Message

A chat message describes a user's interaction with an LLM within the context of a conversation.

Example:

{
   "role": "assistant",
   "message": "The football club is open from 8am to 4pm today.",
   "event_timestamp": "2020-02-20T20:20:23Z",
   "rating": -1
   "metadata": {
     "state": "advancing",
   }
}
Field NameTypeDescriptionRequired

type

String

Chat message identifier. Defaults to message.

role

String

The role of who sent the message.

message

String

The text of this chat message.

event_timestamp

Timestamp

(ISO 8601)

The timestamp of when this message was sent or received.

rating

Integer

The user rating of this message, given by a 'thumbs up' or 'thumbs down' scoring system.

This should be set to one of -1 (for thumbs down), 0 (for no rating given), or 1 (for a thumbs up rating).

metadata

A hash of arbitrary key-value pairs.

Last updated