MessagesUpdatedPayload

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

Class Diagram

---
title: MessagesUpdatedPayload
config:
  look: handDrawn
  theme: colorful
  class:
    hideEmptyMembersBox: true
---
classDiagram
    class MessagesUpdatedPayload {
        +Message[] messages
        +string reason
        +Message[] appended
        +int32 removed
    }
    class Message {
        +string role
        +ContentPart[] parts
        +dictionary metadata
    }
    MessagesUpdatedPayload *-- Message
    class Message {
        +string role
        +ContentPart[] parts
        +dictionary metadata
    }
    MessagesUpdatedPayload *-- Message

Yaml Example

reason: tool_results
removed: 2

Properties

Name	Type	Description
messages	Message[]	The current full message list after the update
reason	string	Why the message list changed
appended	Message[]	Messages appended by this update, when available
removed	int32	Number of messages removed by this update, when available

Composed Types

The following types are composed within MessagesUpdatedPayload:

• Message
• Message