BaseFakeCallbackHandlerMixin Class — langchain Architecture

Architecture documentation for the BaseFakeCallbackHandlerMixin class in callbacks.py from the langchain codebase.

Class python

Entity Profile

Dependency Diagram

graph TD
  d75c20d0_7179_3b3b_82d8_bf47e61df553["BaseFakeCallbackHandlerMixin"]
  542f3f1e_7782_84d9_777a_e16a365138ae["BaseFakeCallbackHandler"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|extends| 542f3f1e_7782_84d9_777a_e16a365138ae
  1a55dbf4_797a_ab13_7a68_4592e2c8463c["callbacks.py"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|defined in| 1a55dbf4_797a_ab13_7a68_4592e2c8463c
  d6545b37_568a_00ee_f635_109d31945a24["on_llm_start_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| d6545b37_568a_00ee_f635_109d31945a24
  59cb7992_d0a1_6cfe_ab92_bf2c595369fe["on_llm_end_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| 59cb7992_d0a1_6cfe_ab92_bf2c595369fe
  f0da776a_372e_4961_0b86_4c71dcc7ac6b["on_llm_error_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| f0da776a_372e_4961_0b86_4c71dcc7ac6b
  d6d38c8b_4b3d_37a1_7ed0_8a617c349ae8["on_llm_new_token_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| d6d38c8b_4b3d_37a1_7ed0_8a617c349ae8
  5f6bc871_15a1_76d3_e360_aad6ffb8c666["on_retry_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| 5f6bc871_15a1_76d3_e360_aad6ffb8c666
  df0ae189_a1d9_6655_2c00_d48ff62ae2b6["on_chain_start_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| df0ae189_a1d9_6655_2c00_d48ff62ae2b6
  36cd24ef_1546_3b19_8b0f_0786c36c1205["on_chain_end_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| 36cd24ef_1546_3b19_8b0f_0786c36c1205
  45b95b26_8da4_46c1_8b9b_bb9458e37f63["on_chain_error_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| 45b95b26_8da4_46c1_8b9b_bb9458e37f63
  b11528d2_8f55_baa3_073f_87b8ebdc9730["on_tool_start_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| b11528d2_8f55_baa3_073f_87b8ebdc9730
  50428a99_1f1d_59ea_9b14_1503cb76a95a["on_tool_end_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| 50428a99_1f1d_59ea_9b14_1503cb76a95a
  76a2494c_7c83_6e85_fdc5_473c4b028ccf["on_tool_error_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| 76a2494c_7c83_6e85_fdc5_473c4b028ccf
  0e532156_5cb4_1118_6605_43f03f6d7a68["on_agent_action_common()"]
  d75c20d0_7179_3b3b_82d8_bf47e61df553 -->|method| 0e532156_5cb4_1118_6605_43f03f6d7a68

Relationship Graph

Source Code

libs/partners/openai/tests/unit_tests/fake/callbacks.py lines 48–116

class BaseFakeCallbackHandlerMixin(BaseFakeCallbackHandler):
    """Base fake callback handler mixin for testing."""

    def on_llm_start_common(self) -> None:
        self.llm_starts += 1
        self.starts += 1

    def on_llm_end_common(self) -> None:
        self.llm_ends += 1
        self.ends += 1

    def on_llm_error_common(self, *args: Any, **kwargs: Any) -> None:
        self.errors += 1
        self.errors_args.append({"args": args, "kwargs": kwargs})

    def on_llm_new_token_common(self) -> None:
        self.llm_streams += 1

    def on_retry_common(self) -> None:
        self.retries += 1

    def on_chain_start_common(self) -> None:
        self.chain_starts += 1
        self.starts += 1

    def on_chain_end_common(self) -> None:
        self.chain_ends += 1
        self.ends += 1

    def on_chain_error_common(self) -> None:
        self.errors += 1

    def on_tool_start_common(self) -> None:
        self.tool_starts += 1
        self.starts += 1

    def on_tool_end_common(self) -> None:
        self.tool_ends += 1
        self.ends += 1

    def on_tool_error_common(self) -> None:
        self.errors += 1

    def on_agent_action_common(self) -> None:
        self.agent_actions += 1
        self.starts += 1

    def on_agent_finish_common(self) -> None:
        self.agent_ends += 1
        self.ends += 1

    def on_chat_model_start_common(self) -> None:
        self.chat_model_starts += 1
        self.starts += 1

    def on_text_common(self) -> None:
        self.text += 1

    def on_retriever_start_common(self) -> None:
        self.starts += 1
        self.retriever_starts += 1

    def on_retriever_end_common(self) -> None:
        self.ends += 1
        self.retriever_ends += 1

    def on_retriever_error_common(self) -> None:
        self.errors += 1
        self.retriever_errors += 1