langchain_core.runnables.schema.CustomStreamEvent¶

class langchain_core.runnables.schema.CustomStreamEvent[source]¶

Custom stream event created by the user.

New in version 0.2.15.

event: Literal['on_custom_event']¶

The event type.

run_id: str¶
tags: NotRequired[List[str]]¶
metadata: NotRequired[Dict[str, Any]]¶
parent_ids: Sequence[str]¶
name: str¶

User defined name for the event.

data: Any¶

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