Class Message

entity/messages.py:237–396

Unified message structure shared by executors and providers.

@dataclass
class Message:
    """Unified message structure shared by executors and providers."""

    role: MessageRole
    content: MessageContent
    name: Optional[str] = None
    tool_call_id: Optional[str] = None
    metadata: Dict[str, Any] = field(default_factory=dict)
    tool_calls: List[ToolCallPayload] = field(default_factory=list)
    keep: bool = False
    preserve_role: bool = False

    def with_content(self, content: MessageContent) -> "Message":
        """Return a shallow copy with updated content."""
        return Message(
            role=self.role,
            content=content,
            name=self.name,
            tool_call_id=self.tool_call_id,
            metadata=dict(self.metadata),
            tool_calls=list(self.tool_calls),
            keep=self.keep,
            preserve_role=self.preserve_role,
        )

    def with_role(self, role: MessageRole) -> "Message":
        """Return a shallow copy with updated role."""
        return Message(
            role=role,
            content=self.content,
            name=self.name,
            tool_call_id=self.tool_call_id,
            metadata=dict(self.metadata),
            tool_calls=list(self.tool_calls),
            keep=self.keep,
            preserve_role=self.preserve_role,
        )

    def text_content(self) -> str:
        """Best-effort string representation of the content."""
        if self.content is None:
            return ""
        if isinstance(self.content, str):
            return self.content
        # Some providers (e.g., multimodal) return list content; join textual parts.
        parts = []
        for block in self.blocks():
            description = block.describe()
            if description:
                parts.append(description)
        return "\n".join(parts)

    def blocks(self) -> List[MessageBlock]:
        """Return content as a list of MessageBlock items."""
        if self.content is None:
            return []
        if isinstance(self.content, str):
            return [MessageBlock.text_block(self.content)]