ModelWithSyncStream Class — langchain Architecture

Architecture documentation for the ModelWithSyncStream class in test_base.py from the langchain codebase.

Class python

Entity Profile

Dependency Diagram

graph TD
  6acd915c_62c8_4da2_4a2e_663314a73908["ModelWithSyncStream"]
  76008743_94c2_792b_9e4f_e1278ae47565["BaseLLM"]
  6acd915c_62c8_4da2_4a2e_663314a73908 -->|extends| 76008743_94c2_792b_9e4f_e1278ae47565
  4404310a_b16c_e9e6_1de2_90e5ea6f3ce3["test_base.py"]
  6acd915c_62c8_4da2_4a2e_663314a73908 -->|defined in| 4404310a_b16c_e9e6_1de2_90e5ea6f3ce3
  012386ad_772c_66bf_0ce8_d57c91ebe9e0["_generate()"]
  6acd915c_62c8_4da2_4a2e_663314a73908 -->|method| 012386ad_772c_66bf_0ce8_d57c91ebe9e0
  88ec2373_b56d_d9e3_df5d_3f80b119679e["_stream()"]
  6acd915c_62c8_4da2_4a2e_663314a73908 -->|method| 88ec2373_b56d_d9e3_df5d_3f80b119679e
  342ac5e2_15b5_a4cf_0844_80f66e4e9ad4["_llm_type()"]
  6acd915c_62c8_4da2_4a2e_663314a73908 -->|method| 342ac5e2_15b5_a4cf_0844_80f66e4e9ad4

Relationship Graph

Source Code

libs/core/tests/unit_tests/language_models/llms/test_base.py lines 167–192

    class ModelWithSyncStream(BaseLLM):
        def _generate(
            self,
            prompts: list[str],
            stop: list[str] | None = None,
            run_manager: CallbackManagerForLLMRun | None = None,
            **kwargs: Any,
        ) -> LLMResult:
            """Top Level call."""
            raise NotImplementedError

        @override
        def _stream(
            self,
            prompt: str,
            stop: list[str] | None = None,
            run_manager: CallbackManagerForLLMRun | None = None,
            **kwargs: Any,
        ) -> Iterator[GenerationChunk]:
            """Stream the output of the model."""
            yield GenerationChunk(text="a")
            yield GenerationChunk(text="b")

        @property
        def _llm_type(self) -> str:
            return "fake-chat-model"