astream_events() — langchain Function Reference

Architecture documentation for the astream_events() function in base.py from the langchain codebase.

Function python LangChainCore LanguageModelBase calls 1

Entity Profile

LangChainCore→ LanguageModelBase→ astream_events() — langchain Function Reference

Dependency Diagram

graph TD
  2d7676d1_5221_aea7_db16_d8ae1dc9b012["astream_events()"]
  74f697e6_2555_becc_640e_6f41ea707eba["_ConfigurableModel"]
  2d7676d1_5221_aea7_db16_d8ae1dc9b012 -->|defined in| 74f697e6_2555_becc_640e_6f41ea707eba
  4d79fd76_22aa_8160_64a3_c62bd0bfe875["_model()"]
  2d7676d1_5221_aea7_db16_d8ae1dc9b012 -->|calls| 4d79fd76_22aa_8160_64a3_c62bd0bfe875
  style 2d7676d1_5221_aea7_db16_d8ae1dc9b012 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/langchain_v1/langchain/chat_models/base.py lines 952–978

    async def astream_events(
        self,
        input: Any,
        config: RunnableConfig | None = None,
        *,
        version: Literal["v1", "v2"] = "v2",
        include_names: Sequence[str] | None = None,
        include_types: Sequence[str] | None = None,
        include_tags: Sequence[str] | None = None,
        exclude_names: Sequence[str] | None = None,
        exclude_types: Sequence[str] | None = None,
        exclude_tags: Sequence[str] | None = None,
        **kwargs: Any,
    ) -> AsyncIterator[StreamEvent]:
        async for x in self._model(config).astream_events(
            input,
            config=config,
            version=version,
            include_names=include_names,
            include_types=include_types,
            include_tags=include_tags,
            exclude_tags=exclude_tags,
            exclude_types=exclude_types,
            exclude_names=exclude_names,
            **kwargs,
        ):
            yield x