BaseFakeCallbackHandlerMixin Class — langchain Architecture

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

Class python

Entity Profile

Dependency Diagram

graph TD
  15a06c6c_a850_1167_4fe2_ed9105c07fd1["BaseFakeCallbackHandlerMixin"]
  542f3f1e_7782_84d9_777a_e16a365138ae["BaseFakeCallbackHandler"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|extends| 542f3f1e_7782_84d9_777a_e16a365138ae
  afcd0a1e_9c9e_7e16_e0ac_5259027d0d05["fake_callback_handler.py"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|defined in| afcd0a1e_9c9e_7e16_e0ac_5259027d0d05
  f6fb7bf2_5802_5fcd_1115_fb81a4f1feab["on_llm_start_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| f6fb7bf2_5802_5fcd_1115_fb81a4f1feab
  b5aa8747_8001_1a2f_5c2e_ae34a45a06f1["on_llm_end_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| b5aa8747_8001_1a2f_5c2e_ae34a45a06f1
  b0b2ed46_6536_8cba_438c_8a53d7355363["on_llm_error_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| b0b2ed46_6536_8cba_438c_8a53d7355363
  da57edb3_52e5_550e_31f0_479965ca2c64["on_llm_new_token_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| da57edb3_52e5_550e_31f0_479965ca2c64
  1b5582b4_6da9_4b0b_46be_a776fdbccbe1["on_retry_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| 1b5582b4_6da9_4b0b_46be_a776fdbccbe1
  9cfddee7_9611_3052_949f_84439bccbd8e["on_chain_start_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| 9cfddee7_9611_3052_949f_84439bccbd8e
  08a2a6e1_ed45_0459_78a8_51ec2094ff26["on_chain_end_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| 08a2a6e1_ed45_0459_78a8_51ec2094ff26
  aa4b0123_17e3_b091_517c_edbbed3d9e7e["on_chain_error_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| aa4b0123_17e3_b091_517c_edbbed3d9e7e
  a918aa30_f42b_1a84_95d5_11cb82759b35["on_tool_start_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| a918aa30_f42b_1a84_95d5_11cb82759b35
  90138c38_d9ad_c1bd_7aa3_b75ff1a084ae["on_tool_end_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| 90138c38_d9ad_c1bd_7aa3_b75ff1a084ae
  752d806a_d9a6_7d8c_5d6d_0658095cef6a["on_tool_error_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| 752d806a_d9a6_7d8c_5d6d_0658095cef6a
  1f2ecc93_905e_ac47_10e3_ac83181858f0["on_agent_action_common()"]
  15a06c6c_a850_1167_4fe2_ed9105c07fd1 -->|method| 1f2ecc93_905e_ac47_10e3_ac83181858f0

Relationship Graph

Source Code

libs/langchain/tests/unit_tests/callbacks/fake_callback_handler.py lines 46–113

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) -> None:
        self.errors += 1

    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