stream-chat-android-ai-compose/io.getstream.chat.android.ai.compose.conversation/AIMessage

AIMessage

A message in a conversation with an AI agent, as AIConversation shows it.

Implement it on your own message type, such as one wrapping a Stream Chat message, rather than converting: the conversation hands your message back in its views' params, so cast it there to read what else it holds.

Properties

attachments

open val attachments: List<AIMessageAttachment>

What it carries besides its text, such as images and files.

abstract val id: String

The message's stable identity.

isGenerating

open val isGenerating: Boolean

Whether the agent is still writing it.

parts

open val parts: List<AIMessagePart>

The steps the agent took for it, in order: reasoning, tool calls, and kinds of its own.

role

abstract val role: AIMessageRole

Who wrote it.

text

abstract val text: String

What it says. A reply's text is Markdown.

Functions

reasoningText

open fun reasoningText(step: AIReasoningPart): String?

The whole of a reasoning step's thinking when the app has it, such as from live updates. Without it, the step shows its own excerpt. It is read each time the conversation updates, so look it up rather than work it out.