_stream() — langchain Function Reference

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

Function python LangChainCore LanguageModelBase calls 2 called by 1

Entity Profile

LangChainCore→ LanguageModelBase→ _stream() — langchain Function Reference

Dependency Diagram

graph TD
  9a3f8476_ed23_4017_8e21_6ee0b6176365["_stream()"]
  6bee45b2_b649_e251_1fdc_dcf49f8bb331["BaseOpenAI"]
  9a3f8476_ed23_4017_8e21_6ee0b6176365 -->|defined in| 6bee45b2_b649_e251_1fdc_dcf49f8bb331
  f5892a19_915a_df0a_fbd3_f7a5a0993b64["_generate()"]
  f5892a19_915a_df0a_fbd3_f7a5a0993b64 -->|calls| 9a3f8476_ed23_4017_8e21_6ee0b6176365
  11f618dd_a369_1622_0130_0cc8a952e5cd["get_sub_prompts()"]
  9a3f8476_ed23_4017_8e21_6ee0b6176365 -->|calls| 11f618dd_a369_1622_0130_0cc8a952e5cd
  15d3c1cb_a282_c6f2_5db8_1d781bb37535["_stream_response_to_generation_chunk()"]
  9a3f8476_ed23_4017_8e21_6ee0b6176365 -->|calls| 15d3c1cb_a282_c6f2_5db8_1d781bb37535
  style 9a3f8476_ed23_4017_8e21_6ee0b6176365 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/partners/openai/langchain_openai/llms/base.py lines 373–398

    def _stream(
        self,
        prompt: str,
        stop: list[str] | None = None,
        run_manager: CallbackManagerForLLMRun | None = None,
        **kwargs: Any,
    ) -> Iterator[GenerationChunk]:
        params = {**self._invocation_params, **kwargs, "stream": True}
        self.get_sub_prompts(params, [prompt], stop)  # this mutates params
        for stream_resp in self.client.create(prompt=prompt, **params):
            if not isinstance(stream_resp, dict):
                stream_resp = stream_resp.model_dump()
            chunk = _stream_response_to_generation_chunk(stream_resp)

            if run_manager:
                run_manager.on_llm_new_token(
                    chunk.text,
                    chunk=chunk,
                    verbose=self.verbose,
                    logprobs=(
                        chunk.generation_info["logprobs"]
                        if chunk.generation_info
                        else None
                    ),
                )
            yield chunk