Function●Since v0.3

delete_ui_message

Delete a UI message by ID from the UI state.

This function creates and sends a message to remove a UI component from the current state. It also updates the graph state to remove the UI message.

delete_ui_message(
  id: str,
  *,
  state_key: str = 'ui'
) -> RemoveUIMessage

Example:

delete_ui_message("message-123")

Parameters

Name	Type	Description
`id`*	`str`	Unique identifier of the UI component to remove.
`state_key`	`str`	Default:`'ui'` Key in the graph state where the UI messages are stored. Defaults to "ui".