langchain Architecture Docs
Home / Class/ FakeCallbackHandler Class — langchain Architecture

FakeCallbackHandler Class — langchain Architecture

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

Class python

Entity Profile

Dependency Diagram

graph TD
  2980af69_b0b8_dfaf_be0a_345d4f2163ad["FakeCallbackHandler"]
  50ee4473_6788_2806_dc06_5fbbc8f64275["BaseCallbackHandler"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|extends| 50ee4473_6788_2806_dc06_5fbbc8f64275
  36d14fc2_cb11_2856_bc3b_120f8e72dda8["BaseFakeCallbackHandlerMixin"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|extends| 36d14fc2_cb11_2856_bc3b_120f8e72dda8
  1a55dbf4_797a_ab13_7a68_4592e2c8463c["callbacks.py"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|defined in| 1a55dbf4_797a_ab13_7a68_4592e2c8463c
  87cb4cb8_dd9d_e6bb_042d_1e1eca285e2a["ignore_llm()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| 87cb4cb8_dd9d_e6bb_042d_1e1eca285e2a
  3abaf609_58e5_b691_1a12_6bb648a56e91["ignore_chain()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| 3abaf609_58e5_b691_1a12_6bb648a56e91
  2ec1d432_1d3d_aedc_9614_ad646c43399c["ignore_agent()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| 2ec1d432_1d3d_aedc_9614_ad646c43399c
  c69966af_29c4_516a_0d63_89c121e65ae1["ignore_retriever()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| c69966af_29c4_516a_0d63_89c121e65ae1
  7d1c36b8_38ad_9bae_d34c_cbcee0c6b548["on_llm_start()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| 7d1c36b8_38ad_9bae_d34c_cbcee0c6b548
  6193edbd_abcb_4a3b_bcef_bec5c419f862["on_llm_new_token()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| 6193edbd_abcb_4a3b_bcef_bec5c419f862
  dc763805_161c_fa95_73bf_35b65bef5159["on_llm_end()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| dc763805_161c_fa95_73bf_35b65bef5159
  bbb53c60_a5a8_4d4c_205e_71cb1cb09226["on_llm_error()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| bbb53c60_a5a8_4d4c_205e_71cb1cb09226
  40d39bcc_45d8_6e15_1eca_3bd70dfc03d4["on_retry()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| 40d39bcc_45d8_6e15_1eca_3bd70dfc03d4
  71bc2eae_ae99_3450_aab2_63759213d201["on_chain_start()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| 71bc2eae_ae99_3450_aab2_63759213d201
  da8873b1_643c_605a_4cc6_99d36d91fda5["on_chain_end()"]
  2980af69_b0b8_dfaf_be0a_345d4f2163ad -->|method| da8873b1_643c_605a_4cc6_99d36d91fda5

Relationship Graph

Source Code

libs/partners/openai/tests/unit_tests/fake/callbacks.py lines 119–194

class FakeCallbackHandler(BaseCallbackHandler, BaseFakeCallbackHandlerMixin):
    """Fake callback handler for testing."""

    @property
    def ignore_llm(self) -> bool:
        """Whether to ignore LLM callbacks."""
        return self.ignore_llm_

    @property
    def ignore_chain(self) -> bool:
        """Whether to ignore chain callbacks."""
        return self.ignore_chain_

    @property
    def ignore_agent(self) -> bool:
        """Whether to ignore agent callbacks."""
        return self.ignore_agent_

    @property
    def ignore_retriever(self) -> bool:
        """Whether to ignore retriever callbacks."""
        return self.ignore_retriever_

    def on_llm_start(self, *args: Any, **kwargs: Any) -> Any:
        self.on_llm_start_common()

    def on_llm_new_token(self, *args: Any, **kwargs: Any) -> Any:
        self.on_llm_new_token_common()

    def on_llm_end(self, *args: Any, **kwargs: Any) -> Any:
        self.on_llm_end_common()

    def on_llm_error(self, *args: Any, **kwargs: Any) -> Any:
        self.on_llm_error_common(*args, **kwargs)

    def on_retry(self, *args: Any, **kwargs: Any) -> Any:
        self.on_retry_common()

    def on_chain_start(self, *args: Any, **kwargs: Any) -> Any:
        self.on_chain_start_common()

    def on_chain_end(self, *args: Any, **kwargs: Any) -> Any:
        self.on_chain_end_common()

    def on_chain_error(self, *args: Any, **kwargs: Any) -> Any:
        self.on_chain_error_common()

    def on_tool_start(self, *args: Any, **kwargs: Any) -> Any:
        self.on_tool_start_common()

    def on_tool_end(self, *args: Any, **kwargs: Any) -> Any:
        self.on_tool_end_common()

    def on_tool_error(self, *args: Any, **kwargs: Any) -> Any:
        self.on_tool_error_common()

    def on_agent_action(self, *args: Any, **kwargs: Any) -> Any:
        self.on_agent_action_common()

    def on_agent_finish(self, *args: Any, **kwargs: Any) -> Any:
        self.on_agent_finish_common()

    def on_text(self, *args: Any, **kwargs: Any) -> Any:
        self.on_text_common()

    def on_retriever_start(self, *args: Any, **kwargs: Any) -> Any:
        self.on_retriever_start_common()

    def on_retriever_end(self, *args: Any, **kwargs: Any) -> Any:
        self.on_retriever_end_common()

    def on_retriever_error(self, *args: Any, **kwargs: Any) -> Any:
        self.on_retriever_error_common()

    def __deepcopy__(self, memo: dict) -> FakeCallbackHandler:  # type: ignore[override]
        return self

Defined In

Extends

Source

Frequently Asked Questions

What is the FakeCallbackHandler class?
FakeCallbackHandler is a class in the langchain codebase, defined in libs/partners/openai/tests/unit_tests/fake/callbacks.py.
Where is FakeCallbackHandler defined?
FakeCallbackHandler is defined in libs/partners/openai/tests/unit_tests/fake/callbacks.py at line 119.
What does FakeCallbackHandler extend?
FakeCallbackHandler extends BaseCallbackHandler, BaseFakeCallbackHandlerMixin.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free