CustomStreamEvent Class — langchain Architecture

Architecture documentation for the CustomStreamEvent class in schema.py from the langchain codebase.

Class python

Entity Profile

Dependency Diagram

graph TD
  0123d7ef_491d_fc10_d3e5_9c22dd24f2ec["CustomStreamEvent"]
  c60b06a0_9f02_2896_e0fd_9bacf9546931["BaseStreamEvent"]
  0123d7ef_491d_fc10_d3e5_9c22dd24f2ec -->|extends| c60b06a0_9f02_2896_e0fd_9bacf9546931
  8fc54027_af2e_acf9_1479_472ebaa69eb5["schema.py"]
  0123d7ef_491d_fc10_d3e5_9c22dd24f2ec -->|defined in| 8fc54027_af2e_acf9_1479_472ebaa69eb5

Relationship Graph

Source Code

libs/core/langchain_core/runnables/schema.py lines 176–185

class CustomStreamEvent(BaseStreamEvent):
    """Custom stream event created by the user."""

    # Overwrite the event field to be more specific.
    event: Literal["on_custom_event"]  # type: ignore[misc]
    """The event type."""
    name: str
    """User defined name for the event."""
    data: Any
    """The data associated with the event. Free form and can be anything."""