InfinoCallbackHandler#

class langchain_community.callbacks.infino_callback.InfinoCallbackHandler(
model_id: str | None = None,
model_version: str | None = None,
verbose: bool = False,
)[source]#

Callback Handler that logs to Infino.

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_custom_event

Ignore custom event.

ignore_llm

Whether to ignore LLM callbacks.

ignore_retriever

Whether to ignore retriever callbacks.

ignore_retry

Whether to ignore retry callbacks.

raise_error

Whether to raise an error if an exception occurs.

run_inline

Whether to run the callback inline.

Methods

__init__([model_id, model_version, verbose])

on_agent_action(action, **kwargs)

Do nothing when agent takes a specific action.

on_agent_finish(finish, **kwargs)

Do nothing.

on_chain_end(outputs, **kwargs)

Do nothing when LLM chain ends.

on_chain_error(error, **kwargs)

Need to log the error.

on_chain_start(serialized, inputs, **kwargs)

Do nothing when LLM chain starts.

on_chat_model_start(serialized, messages, ...)

Run when LLM starts running.

on_custom_event(name, data, *, run_id[, ...])

Override to define a handler for a custom event.

on_llm_end(response, **kwargs)

Log the latency, error, token usage, and response to Infino.

on_llm_error(error, **kwargs)

Set the error flag.

on_llm_new_token(token, **kwargs)

Do nothing when a new token is generated.

on_llm_start(serialized, prompts, **kwargs)

Log the prompts to Infino, and set start time and error flag.

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 the Retriever starts running.

on_retry(retry_state, *, run_id[, parent_run_id])

Run on a retry event.

on_text(text, **kwargs)

Do nothing.

on_tool_end(output[, observation_prefix, ...])

Do nothing when tool ends.

on_tool_error(error, **kwargs)

Do nothing when tool outputs an error.

on_tool_start(serialized, input_str, **kwargs)

Do nothing when tool starts.

Parameters:
  • model_id (str | None)

  • model_version (str | None)

  • verbose (bool)

__init__(
model_id: str | None = None,
model_version: str | None = None,
verbose: bool = False,
) None[source]#
Parameters:
  • model_id (str | None)

  • model_version (str | None)

  • verbose (bool)

Return type:

None

on_agent_action(
action: AgentAction,
**kwargs: Any,
) Any[source]#

Do nothing when agent takes a specific action.

Parameters:
Return type:

Any

on_agent_finish(
finish: AgentFinish,
**kwargs: Any,
) None[source]#

Do nothing.

Parameters:
Return type:

None

on_chain_end(
outputs: Dict[str, Any],
**kwargs: Any,
) None[source]#

Do nothing when LLM chain ends.

Parameters:
  • outputs (Dict[str, Any])

  • kwargs (Any)

Return type:

None

on_chain_error(
error: BaseException,
**kwargs: Any,
) None[source]#

Need to log the error.

Parameters:
  • error (BaseException)

  • kwargs (Any)

Return type:

None

on_chain_start(
serialized: Dict[str, Any],
inputs: Dict[str, Any],
**kwargs: Any,
) None[source]#

Do nothing when LLM chain starts.

Parameters:
  • serialized (Dict[str, Any])

  • inputs (Dict[str, Any])

  • kwargs (Any)

Return type:

None

on_chat_model_start(
serialized: Dict[str, Any],
messages: List[List[BaseMessage]],
**kwargs: Any,
) None[source]#

Run when LLM starts running.

Parameters:
  • serialized (Dict[str, Any])

  • messages (List[List[BaseMessage]])

  • kwargs (Any)

Return type:

None

on_custom_event(
name: str,
data: Any,
*,
run_id: UUID,
tags: list[str] | None = None,
metadata: dict[str, Any] | None = None,
**kwargs: Any,
) Any#

Override to define a handler for a custom event.

Parameters:
  • name (str) – The name of the custom event.

  • data (Any) – The data for the custom event. Format will match the format specified by the user.

  • run_id (UUID) – The ID of the run.

  • tags (Optional[list[str]]) – The tags associated with the custom event (includes inherited tags).

  • metadata (Optional[dict[str, Any]]) – The metadata associated with the custom event (includes inherited metadata).

  • kwargs (Any)

Return type:

Any

Added in version 0.2.15.

on_llm_end(
response: LLMResult,
**kwargs: Any,
) None[source]#

Log the latency, error, token usage, and response to Infino.

Parameters:
Return type:

None

on_llm_error(
error: BaseException,
**kwargs: Any,
) None[source]#

Set the error flag.

Parameters:
  • error (BaseException)

  • kwargs (Any)

Return type:

None

on_llm_new_token(
token: str,
**kwargs: Any,
) None[source]#

Do nothing when a new token is generated.

Parameters:
  • token (str)

  • kwargs (Any)

Return type:

None

on_llm_start(
serialized: Dict[str, Any],
prompts: List[str],
**kwargs: Any,
) None[source]#

Log the prompts to Infino, and set start time and error flag.

Parameters:
  • serialized (Dict[str, Any])

  • prompts (List[str])

  • kwargs (Any)

Return type:

None

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

Run when Retriever ends running.

Parameters:
  • documents (Sequence[Document]) – The documents retrieved.

  • run_id (UUID) – The run ID. This is the ID of the current run.

  • parent_run_id (UUID) – The parent run ID. This is the ID of the parent run.

  • kwargs (Any) – Additional keyword arguments.

Return type:

Any

on_retriever_error(
error: BaseException,
*,
run_id: UUID,
parent_run_id: UUID | None = None,
**kwargs: Any,
) Any#

Run when Retriever errors.

Parameters:
  • error (BaseException) – The error that occurred.

  • run_id (UUID) – The run ID. This is the ID of the current run.

  • parent_run_id (UUID) – The parent run ID. This is the ID of the parent run.

  • kwargs (Any) – Additional keyword arguments.

Return type:

Any

on_retriever_start(
serialized: dict[str, Any],
query: str,
*,
run_id: UUID,
parent_run_id: UUID | None = None,
tags: list[str] | None = None,
metadata: dict[str, Any] | None = None,
**kwargs: Any,
) Any#

Run when the Retriever starts running.

Parameters:
  • serialized (dict[str, Any]) – The serialized Retriever.

  • query (str) – The query.

  • run_id (UUID) – The run ID. This is the ID of the current run.

  • parent_run_id (UUID) – The parent run ID. This is the ID of the parent run.

  • tags (Optional[list[str]]) – The tags.

  • metadata (Optional[dict[str, Any]]) – The metadata.

  • kwargs (Any) – Additional keyword arguments.

Return type:

Any

on_retry(
retry_state: RetryCallState,
*,
run_id: UUID,
parent_run_id: UUID | None = None,
**kwargs: Any,
) Any#

Run on a retry event.

Parameters:
  • retry_state (RetryCallState) – The retry state.

  • run_id (UUID) – The run ID. This is the ID of the current run.

  • parent_run_id (UUID) – The parent run ID. This is the ID of the parent run.

  • kwargs (Any) – Additional keyword arguments.

Return type:

Any

on_text(
text: str,
**kwargs: Any,
) None[source]#

Do nothing.

Parameters:
  • text (str)

  • kwargs (Any)

Return type:

None

on_tool_end(
output: str,
observation_prefix: str | None = None,
llm_prefix: str | None = None,
**kwargs: Any,
) None[source]#

Do nothing when tool ends.

Parameters:
  • output (str)

  • observation_prefix (str | None)

  • llm_prefix (str | None)

  • kwargs (Any)

Return type:

None

on_tool_error(
error: BaseException,
**kwargs: Any,
) None[source]#

Do nothing when tool outputs an error.

Parameters:
  • error (BaseException)

  • kwargs (Any)

Return type:

None

on_tool_start(
serialized: Dict[str, Any],
input_str: str,
**kwargs: Any,
) None[source]#

Do nothing when tool starts.

Parameters:
  • serialized (Dict[str, Any])

  • input_str (str)

  • kwargs (Any)

Return type:

None

Examples using InfinoCallbackHandler