langchain_community.callbacks.llmonitor_callback.LLMonitorCallbackHandler

class langchain_community.callbacks.llmonitor_callback.LLMonitorCallbackHandler(app_id: Optional[str] = None, api_url: Optional[str] = None, verbose: bool = False)

Callback Handler for LLMonitor`.

#### Parameters:

• app_id: The app id of the app you want to report to. Defaults to

None, which means that LLMONITOR_APP_ID will be used. - api_url: The url of the LLMonitor API. Defaults to None, which means that either LLMONITOR_API_URL environment variable or https://app.llmonitor.com will be used.

#### Raises:

• ValueError: if app_id is not provided either as an

argument or as an environment variable. - ConnectionError: if the connection to the API fails.

#### Example: ```python from langchain_community.llms import OpenAI from langchain_community.callbacks import LLMonitorCallbackHandler

llmonitor_callback = LLMonitorCallbackHandler() llm = OpenAI(callbacks=[llmonitor_callback],

metadata={“userId”: “user-123”})

llm.predict(“Hello, how are you?”) ```

Attributes

ignore_agent	Whether to ignore agent callbacks.
ignore_chain	Whether to ignore chain callbacks.
ignore_chat_model	Whether to ignore chat model callbacks.
ignore_llm	Whether to ignore LLM callbacks.
ignore_retriever	Whether to ignore retriever callbacks.
ignore_retry	Whether to ignore retry callbacks.
raise_error
run_inline

Methods

__init__([app_id, api_url, verbose])
on_agent_action(action, *, run_id[, ...])	Run on agent action.
on_agent_finish(finish, *, run_id[, ...])	Run on agent end.
on_chain_end(outputs, *, run_id[, parent_run_id])	Run when chain ends running.
on_chain_error(error, *, run_id[, parent_run_id])	Run when chain errors.
on_chain_start(serialized, inputs, *, run_id)	Run when chain starts running.
on_chat_model_start(serialized, messages, *, ...)	Run when a chat model starts running.
on_llm_end(response, *, run_id[, parent_run_id])	Run when LLM ends running.
on_llm_error(error, *, run_id[, parent_run_id])	Run when LLM errors. :param error: The error that occurred. :type error: BaseException :param kwargs: Additional keyword arguments. - response (LLMResult): The response which was generated before the error occurred. :type kwargs: Any.
on_llm_new_token(token, *[, chunk, ...])	Run on new LLM token.
on_llm_start(serialized, prompts, *, run_id)	Run when LLM starts running.
on_retriever_end(documents, *, run_id[, ...])	Run when Retriever ends running.
on_retriever_error(error, *, run_id[, ...])	Run when Retriever errors.
on_retriever_start(serialized, query, *, run_id)	Run when Retriever starts running.
on_retry(retry_state, *, run_id[, parent_run_id])	Run on a retry event.
on_text(text, *, run_id[, parent_run_id])	Run on arbitrary text.
on_tool_end(output, *, run_id[, ...])	Run when tool ends running.
on_tool_error(error, *, run_id[, parent_run_id])	Run when tool errors.
on_tool_start(serialized, input_str, *, run_id)	Run when tool starts running.

Parameters

• app_id (Optional[str]) –

• api_url (Optional[str]) –

• verbose (bool) –

__init__(app_id: Optional[str] = None, api_url: Optional[str] = None, verbose: bool = False) → None

Parameters

• app_id (Optional[str]) –

• api_url (Optional[str]) –

• verbose (bool) –

Return type

None

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on agent action.

Parameters

• action (AgentAction) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on agent end.

Parameters

• finish (AgentFinish) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_chain_end(outputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run when chain ends running.

Parameters

• outputs (Dict[str, Any]) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_chain_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run when chain errors.

Parameters

• error (BaseException) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

Run when chain starts running.

Parameters

• serialized (Dict[str, Any]) –

• inputs (Dict[str, Any]) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• tags (Optional[List[str]]) –

• metadata (Optional[Dict[str, Any]]) –

• kwargs (Any) –

Return type

Any

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

Run when a chat model starts running.

ATTENTION: This method is called for chat models. If you’re implementing

a handler for a non-chat model, you should use on_llm_start instead.

Parameters

• serialized (Dict[str, Any]) –

• messages (List[List[BaseMessage]]) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• tags (Optional[List[str]]) –

• metadata (Optional[Dict[str, Any]]) –

• kwargs (Any) –

Return type

Any

on_llm_end(response: LLMResult, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → None

Run when LLM ends running.

Parameters

• response (LLMResult) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

None

on_llm_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run when LLM errors. :param error: The error that occurred. :type error: BaseException :param kwargs: Additional keyword arguments.

• response (LLMResult): The response which was generated before

  the error occurred.

Parameters

• error (BaseException) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_llm_new_token(token: str, *, chunk: Optional[Union[GenerationChunk, ChatGenerationChunk]] = None, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on new LLM token. Only available when streaming is enabled.

Parameters

• token (str) – The new token.

• chunk (GenerationChunk | ChatGenerationChunk) – The new generated chunk,

• information. (containing content and other) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_llm_start(serialized: Dict[str, Any], prompts: List[str], *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → None

Run when LLM starts running.

ATTENTION: This method is called for non-chat models (regular LLMs). If

you’re implementing a handler for a chat model, you should use on_chat_model_start instead.

Parameters

• serialized (Dict[str, Any]) –

• prompts (List[str]) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• tags (Optional[List[str]]) –

• metadata (Optional[Dict[str, Any]]) –

• kwargs (Any) –

Return type

None

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run when Retriever ends running.

Parameters

• documents (Sequence[Document]) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_retriever_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run when Retriever errors.

Parameters

• error (BaseException) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_retriever_start(serialized: Dict[str, Any], query: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any

Run when Retriever starts running.

Parameters

• serialized (Dict[str, Any]) –

• query (str) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• tags (Optional[List[str]]) –

• metadata (Optional[Dict[str, Any]]) –

• kwargs (Any) –

Return type

Any

on_retry(retry_state: RetryCallState, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on a retry event.

Parameters

• retry_state (RetryCallState) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_text(text: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run on arbitrary text.

Parameters

• text (str) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_tool_end(output: Any, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, **kwargs: Any) → None

Run when tool ends running.

Parameters

• output (Any) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• tags (Optional[List[str]]) –

• kwargs (Any) –

Return type

None

on_tool_error(error: BaseException, *, run_id: UUID, parent_run_id: Optional[UUID] = None, **kwargs: Any) → Any

Run when tool errors.

Parameters

• error (BaseException) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• kwargs (Any) –

Return type

Any

on_tool_start(serialized: Dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: Optional[UUID] = None, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → None

Run when tool starts running.

Parameters

• serialized (Dict[str, Any]) –

• input_str (str) –

• run_id (UUID) –

• parent_run_id (Optional[UUID]) –

• tags (Optional[List[str]]) –

• metadata (Optional[Dict[str, Any]]) –

• kwargs (Any) –

Return type

None

Examples using LLMonitorCallbackHandler

• LLMonitor