Skip to content

MessagesUpdatedPayload

Payload for “messages_updated” events — the conversation state has changed.

---
title: MessagesUpdatedPayload
config:
  look: handDrawn
  theme: colorful
  class:
    hideEmptyMembersBox: true
---
classDiagram
    class MessagesUpdatedPayload {
        +Message[] messages
    }
    class Message {
        +string role
        +ContentPart[] parts
        +dictionary metadata
        +toTextContent() unknown [async-capable]
        +text() string [async-capable]
    }
    MessagesUpdatedPayload *-- Message
NameTypeDescription
messagesMessage[]The current full message list after the update

The following types are composed within MessagesUpdatedPayload: