LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
    • Overview
    • Graphs
    • Functional API
    • Pregel
    • Checkpointing
    • Storage
    • Caching
    • Types
    • Runtime
    • Config
    • Errors
    • Constants
    • Channels
    • Agents
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    OverviewGraphsFunctional APIPregelCheckpointingStorageCachingTypesRuntimeConfigErrorsConstantsChannelsAgents
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    PythonlanggraphgraphuiUIMessage
    Class●Since v0.3

    UIMessage

    A message type for UI updates in LangGraph.

    This TypedDict represents a UI message that can be sent to update the UI state. It contains information about the UI component to render and its properties.

    Copy
    UIMessage()

    Bases

    TypedDict

    Constructors

    constructor
    __init__
    NameType
    typeLiteral['ui']
    idstr
    namestr
    propsdict[str, Any]
    metadatadict[str, Any]

    Attributes

    attribute
    type: Literal['ui']
    attribute
    id: str
    attribute
    name: str
    attribute
    props: dict[str, Any]
    attribute
    metadata: dict[str, Any]
    View source on GitHub