`langchain_community.callbacks.context_callback`.ContextCallbackHandler¶

class langchain_community.callbacks.context_callback.ContextCallbackHandler(token: str = '', verbose: bool = False, **kwargs: Any)[source]¶

将转录记录到 Context 服务的 Callback Handler。

(https://context.ai)。

关键词参数

token (可选) – 用于验证 Context 服务请求的令牌。访问 https://with.context.ai/settings 生成令牌。如果未提供，将使用 CONTEXT_TOKEN 环境变量的值。

引发

ImportError – 如果未安装 context-python 包。

参数

token (str) –
verbose (bool) –
kwargs (Any) –

聊天示例

>>> from langchain_community.llms import ChatOpenAI
>>> from langchain_community.callbacks import ContextCallbackHandler
>>> context_callback = ContextCallbackHandler(
...     token="<CONTEXT_TOKEN_HERE>",
... )
>>> chat = ChatOpenAI(
...     temperature=0,
...     headers={"user_id": "123"},
...     callbacks=[context_callback],
...     openai_api_key="API_KEY_HERE",
... )
>>> messages = [
...     SystemMessage(content="You translate English to French."),
...     HumanMessage(content="I love programming with LangChain."),
... ]
>>> chat.invoke(messages)

链示例

>>> from langchain.chains import LLMChain
>>> from langchain_community.chat_models import ChatOpenAI
>>> from langchain_community.callbacks import ContextCallbackHandler
>>> context_callback = ContextCallbackHandler(
...     token="<CONTEXT_TOKEN_HERE>",
... )
>>> human_message_prompt = HumanMessagePromptTemplate(
...     prompt=PromptTemplate(
...         template="What is a good name for a company that makes {product}?",
...         input_variables=["product"],
...    ),
... )
>>> chat_prompt_template = ChatPromptTemplate.from_messages(
...   [human_message_prompt]
... )
>>> callback = ContextCallbackHandler(token)
>>> # Note: the same callback object must be shared between the
...   LLM and the chain.
>>> chat = ChatOpenAI(temperature=0.9, callbacks=[callback])
>>> chain = LLMChain(
...   llm=chat,
...   prompt=chat_prompt_template,
...   callbacks=[callback]
... )
>>> chain.run("colorful socks")

属性

`ignore_agent`	是否忽略 agent 回调。
`ignore_chain`	是否忽略 chain 回调。
`ignore_chat_model`	是否忽略 chat model 回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略 LLM 回调。
`ignore_retriever`	是否忽略 retriever 回调。
`ignore_retry`	是否忽略 retry 回调。
`raise_error`	如果发生异常是否引发错误。
`run_inline`	是否内联运行回调。

方法

`__init__`([token, verbose])
`on_agent_action`(action, *, run_id[, ...])	在 agent action 上运行。
`on_agent_finish`(finish, *, run_id[, ...])	在 agent 结束时运行。
`on_chain_end`(outputs, **kwargs)	当链结束时运行。
`on_chain_error`(error, *, run_id[, parent_run_id])	当链出错时运行。
`on_chain_start`(serialized, inputs, **kwargs)	当链开始时运行。
`on_chat_model_start`(serialized, messages, *, ...)	当 chat model 开始时运行。
`on_custom_event`(name, data, *, run_id[, ...])	覆盖以定义自定义事件的处理程序。
`on_llm_end`(response, **kwargs)	当 LLM 结束时运行。
`on_llm_error`(error, *, run_id[, parent_run_id])	当 LLM 出错时运行。
`on_llm_new_token`(token, *[, chunk, ...])	在新 LLM token 上运行。
`on_llm_start`(serialized, prompts, *, run_id)	当 LLM 开始运行时运行。
`on_retriever_end`(documents, *, run_id[, ...])	当 Retriever 结束运行时运行。
`on_retriever_error`(error, *, run_id[, ...])	当 Retriever 出错时运行。
`on_retriever_start`(serialized, query, *, run_id)	当 Retriever 开始运行时运行。
`on_retry`(retry_state, *, run_id[, parent_run_id])	在 retry 事件时运行。
`on_text`(text, *, run_id[, parent_run_id])	在任意文本上运行。
`on_tool_end`(output, *, run_id[, parent_run_id])	当 tool 结束运行时运行。
`on_tool_error`(error, *, run_id[, parent_run_id])	当 tool 出错时运行。
`on_tool_start`(serialized, input_str, *, run_id)	当 tool 开始运行时运行。

__init__(token: str = '', verbose: bool = False, **kwargs: Any) → None[source]¶

参数

token (str) –
verbose (bool) –
kwargs (Any) –

返回类型

None

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

在 agent action 上运行。

参数

action (AgentAction) – Agent 的 action。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

在 agent 结束时运行。

参数

finish (AgentFinish) – Agent 的 finish。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

当链结束时运行。

参数

outputs (Dict[str, Any]) –
kwargs (Any) –

返回类型

None

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

当链出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

当链开始时运行。

参数

serialized (Dict[str, Any]) –
inputs (Dict[str, Any]) –
kwargs (Any) –

返回类型

None

on_chat_model_start(serialized: Dict[str, Any], messages: List[List[BaseMessage]], *, run_id: UUID, **kwargs: Any) → Any[source]¶

当 chat model 开始时运行。

参数

serialized (Dict[str, Any]) –
messages (List[List[BaseMessage]]) –
run_id (UUID) –
kwargs (Any) –

返回类型

Any

on_custom_event(name: str, data: Any, *, run_id: UUID, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → Any¶

覆盖以定义自定义事件的处理程序。

参数

name (str) – 自定义事件的名称。
data (Any) – 自定义事件的数据。格式将与用户指定的格式匹配。
run_id (UUID) – Run 的 ID。
tags (Optional[List[str]]) – 与自定义事件关联的标签（包括继承的标签）。
metadata (Optional[Dict[str, Any]]) – 与自定义事件关联的元数据（包括继承的元数据）。
kwargs (Any) –

返回类型

Any

0.2.15 版本新增功能。

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

当 LLM 结束时运行。

参数

response (LLMResult) –
kwargs (Any) –

返回类型

None

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

当 LLM 出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

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¶

在新 LLM token 上运行时运行。仅在启用流式处理时可用。

参数

token (str) – 新 token。
chunk (GenerationChunk | ChatGenerationChunk) – 新生成的 chunk，包含内容和其他信息。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

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) → Any¶

当 LLM 开始运行时运行。

注意：此方法为非聊天模型（常规 LLM）调用。如果: 您正在为聊天模型实现处理程序，则应使用 on_chat_model_start 代替。

参数

serialized (Dict[str, Any]) – 序列化的 LLM。
prompts (List[str]) – 提示。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
tags (Optional[List[str]]) – 标签。
metadata (Optional[Dict[str, Any]]) – 元数据。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

当 Retriever 结束运行时运行。

参数

documents (Sequence[Document]) – 检索到的文档。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

当 Retriever 出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

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¶

当 Retriever 开始运行时运行。

参数

serialized (Dict[str, Any]) – 序列化的 Retriever。
query (str) – 查询。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
tags (Optional[List[str]]) – 标签。
metadata (Optional[Dict[str, Any]]) – 元数据。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

在 retry 事件时运行。

参数

retry_state (RetryCallState) – 重试状态。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

在任意文本上运行。

参数

text (str) – 文本。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

当 tool 结束运行时运行。

参数

output (Any) – 工具的输出。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

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

当 tool 出错时运行。

参数

error (BaseException) – 发生的错误。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
kwargs (Any) – 额外的关键词参数。

返回类型

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

当 tool 开始运行时运行。

参数

serialized (Dict[str, Any]) – 序列化的工具。
input_str (str) – 输入字符串。
run_id (UUID) – Run ID。这是当前 run 的 ID。
parent_run_id (UUID) – 父 run ID。这是父 run 的 ID。
tags (Optional[List[str]]) – 标签。
metadata (Optional[Dict[str, Any]]) – 元数据。
inputs (Optional[Dict[str, Any]]) – 输入。
kwargs (Any) – 额外的关键词参数。

返回类型

Any

ContextCallbackHandler 的使用示例¶

上下文

langchain_community.callbacks.context_callback.ContextCallbackHandler¶

ContextCallbackHandler 的使用示例¶

`langchain_community.callbacks.context_callback`.ContextCallbackHandler¶