LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
    • Overview
    • Caches
    • Callbacks
    • Documents
    • Document loaders
    • Embeddings
    • Exceptions
    • Language models
    • Serialization
    • Output parsers
    • Prompts
    • Rate limiters
    • Retrievers
    • Runnables
    • Utilities
    • Vector stores
    MCP Adapters
    Standard Tests
    Text Splitters
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    OverviewCachesCallbacksDocumentsDocument loadersEmbeddingsExceptionsLanguage modelsSerializationOutput parsersPromptsRate limitersRetrieversRunnablesUtilitiesVector stores
    MCP Adapters
    Standard Tests
    Text Splitters
    Language
    Theme
    Pythonlangchain-corerunnablesschemaCustomStreamEvent
    Class●Since v0.2

    CustomStreamEvent

    Custom stream event created by the user.

    Copy
    CustomStreamEvent()

    Bases

    BaseStreamEvent

    Attributes

    attribute
    event: Literal['on_custom_event']

    The event type.

    attribute
    name: str

    User defined name for the event.

    attribute
    data: Any

    The data associated with the event. Free form and can be anything.

    Inherited fromBaseStreamEvent

    Attributes

    Arun_id: UUID
    —

    A unique identifier for the model or chain run.

    Atags: list[str] | None
    —

    Optional list of tags associated with the retriever.

    Ametadata: dict[str, Any] | None
    —

    Optional metadata associated with the retriever.

    Aparent_ids: Sequence[str]
    —

    A list of the parent IDs associated with this event.

    View source on GitHub