langchain.callbacks.tracers.logging.LoggingCallbackHandler

class langchain.callbacks.tracers.logging.LoggingCallbackHandler(logger: Logger, log_level: int = 20, extra: Optional[dict] = None, **kwargs: Any)[source]

通过输入日志记录器记录的追踪器。

初始化跟踪器。

参数:
_schema_format: 主要用于改变输入和输出的处理方式。仅供内部使用。此API将会更改。
  • ‘original’ 是所有当前跟踪器使用的格式。

    该格式在处理输入和输出方面略有不一致。

  • ‘streaming_events’ 用于支持流事件,仅供内部使用。将来可能会更改,或者

    完全弃用,转而使用专门的异步跟踪器来支持流事件。

kwargs: 将传递给超类的额外关键字参数。

Attributes

ignore_agent

是否忽略代理回调。

ignore_chain

是否忽略链式回调。

ignore_chat_model

是否忽略聊天模型的回调。

ignore_llm

是否忽略LLM回调。

ignore_retriever

是否忽略检索器回调函数。

ignore_retry

是否忽略重试回调。

name

raise_error

run_inline

Methods

__init__(logger[, log_level, extra])

初始化跟踪器。

get_breadcrumbs(run)

get_parents(run)

on_agent_action(action, *, run_id[, ...])

在代理程序上运行的动作。

on_agent_finish(finish, *, run_id[, ...])

在代理端运行。

on_chain_end(outputs, *, run_id[, inputs])

结束链式运行的跟踪。

on_chain_error(error, *[, inputs])

处理链式运行的错误。

on_chain_start(serialized, inputs, *, run_id)

开始跟踪链运行。

on_chat_model_start(serialized, messages, *, ...)

开始跟踪LLM运行。

on_llm_end(response, *, run_id, **kwargs)

结束LLM运行的跟踪。

on_llm_error(error, *, run_id, **kwargs)

处理LLM运行的错误。

on_llm_new_token(token, *[, chunk, ...])

在新的LLM令牌上运行。仅在启用流式传输时可用。

on_llm_start(serialized, prompts, *, run_id)

开始跟踪LLM运行。

on_retriever_end(documents, *, run_id, **kwargs)

当Retriever运行结束时运行。

on_retriever_error(error, *, run_id, **kwargs)

当Retriever发生错误时运行。

on_retriever_start(serialized, query, *, run_id)

当Retriever开始运行时运行。

on_retry(retry_state, *, run_id, **kwargs)

在重试事件上运行。

on_text(text, *, run_id[, parent_run_id])

在任意文本上运行。

on_tool_end(output, *, run_id, **kwargs)

结束工具运行的跟踪。

on_tool_error(error, *, run_id, **kwargs)

处理工具运行时的错误。

on_tool_start(serialized, input_str, *, run_id)

开始跟踪工具运行。

Parameters
  • logger (Logger) –

  • log_level (int) –

  • extra (Optional[dict]) –

  • kwargs (Any) –

Return type

None

__init__(logger: Logger, log_level: int = 20, extra: Optional[dict] = None, **kwargs: Any) None[source]

初始化跟踪器。

参数:
_schema_format: 主要用于改变输入和输出的处理方式。仅供内部使用。此API将会更改。
  • ‘original’ 是所有当前跟踪器使用的格式。

    该格式在处理输入和输出方面略有不一致。

  • ‘streaming_events’ 用于支持流事件,仅供内部使用。将来可能会更改,或者

    完全弃用,转而使用专门的异步跟踪器来支持流事件。

kwargs: 将传递给超类的额外关键字参数。

Parameters
  • logger (Logger) –

  • log_level (int) –

  • extra (Optional[dict]) –

  • kwargs (Any) –

Return type

None

get_breadcrumbs(run: Run) str
Parameters

run (Run) –

Return type

str

get_parents(run: Run) List[Run]
Parameters

run (Run) –

Return type

List[Run]

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

在代理程序上运行的动作。

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

在代理端运行。

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, inputs: Optional[Dict[str, Any]] = None, **kwargs: Any) Run

结束链式运行的跟踪。

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

  • run_id (UUID) –

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

  • kwargs (Any) –

Return type

Run

on_chain_error(error: BaseException, *, inputs: Optional[Dict[str, Any]] = None, run_id: UUID, **kwargs: Any) Run

处理链式运行的错误。

Parameters
  • error (BaseException) –

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

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

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

开始跟踪链运行。

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

  • inputs (Dict[str, Any]) –

  • run_id (UUID) –

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

  • parent_run_id (Optional[UUID]) –

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

  • run_type (Optional[str]) –

  • name (Optional[str]) –

  • kwargs (Any) –

Return type

Run

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

开始跟踪LLM运行。

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

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

  • run_id (UUID) –

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

  • parent_run_id (Optional[UUID]) –

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

  • name (Optional[str]) –

  • kwargs (Any) –

Return type

Run

on_llm_end(response: LLMResult, *, run_id: UUID, **kwargs: Any) Run

结束LLM运行的跟踪。

Parameters
  • response (LLMResult) –

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

on_llm_error(error: BaseException, *, run_id: UUID, **kwargs: Any) Run

处理LLM运行的错误。

Parameters
  • error (BaseException) –

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

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

在新的LLM令牌上运行。仅在启用流式传输时可用。

Parameters
Return type

Run

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

开始跟踪LLM运行。

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

  • prompts (List[str]) –

  • run_id (UUID) –

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

  • parent_run_id (Optional[UUID]) –

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

  • name (Optional[str]) –

  • kwargs (Any) –

Return type

Run

on_retriever_end(documents: Sequence[Document], *, run_id: UUID, **kwargs: Any) Run

当Retriever运行结束时运行。

Parameters
  • documents (Sequence[Document]) –

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

on_retriever_error(error: BaseException, *, run_id: UUID, **kwargs: Any) Run

当Retriever发生错误时运行。

Parameters
  • error (BaseException) –

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

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, name: Optional[str] = None, **kwargs: Any) Run

当Retriever开始运行时运行。

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

  • query (str) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

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

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

  • name (Optional[str]) –

  • kwargs (Any) –

Return type

Run

on_retry(retry_state: RetryCallState, *, run_id: UUID, **kwargs: Any) Run

在重试事件上运行。

Parameters
  • retry_state (RetryCallState) –

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

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

在任意文本上运行。

Parameters
  • text (str) –

  • run_id (UUID) –

  • parent_run_id (Optional[UUID]) –

  • kwargs (Any) –

Return type

None

on_tool_end(output: Any, *, run_id: UUID, **kwargs: Any) Run

结束工具运行的跟踪。

Parameters
  • output (Any) –

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

on_tool_error(error: BaseException, *, run_id: UUID, **kwargs: Any) Run

处理工具运行时的错误。

Parameters
  • error (BaseException) –

  • run_id (UUID) –

  • kwargs (Any) –

Return type

Run

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

开始跟踪工具运行。

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

  • input_str (str) –

  • run_id (UUID) –

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

  • parent_run_id (Optional[UUID]) –

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

  • name (Optional[str]) –

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

  • kwargs (Any) –

Return type

Run