ContextCallbackHandler#

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

记录转录到上下文服务的回调处理程序。

(https://context.ai).

Keyword Arguments:

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

Raises:

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

Parameters:

token (str)
verbose (布尔值)
kwargs (Any)

Chat Example:

>>> 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)

Chain Example:

>>> 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`	是否忽略代理回调。
`ignore_chain`	是否忽略链式回调。
`ignore_chat_model`	是否忽略聊天模型回调。
`ignore_custom_event`	忽略自定义事件。
`ignore_llm`	是否忽略LLM回调。
`ignore_retriever`	是否忽略检索器回调。
`ignore_retry`	是否忽略重试回调。
`raise_error`	如果发生异常，是否引发错误。
`run_inline`	是否内联运行回调。

方法

`__init__`([token, verbose])
`on_agent_action`(action, *, run_id[, ...])	在代理操作时运行。
`on_agent_finish`(finish, *, run_id[, ...])	在代理结束时运行。
`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, *, ...)	当聊天模型启动时运行。
`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[, ...])	当检索器结束运行时执行。
`on_retriever_error`(error, *, run_id[, ...])	当检索器出错时运行。
`on_retriever_start`(serialized, query, *, run_id)	当检索器开始运行时执行。
`on_retry`(retry_state, *, run_id[, parent_run_id])	在重试事件上运行。
`on_text`(text, *, run_id[, parent_run_id])	在任意文本上运行。
`on_tool_end`(output, *, run_id[, parent_run_id])	当工具结束运行时执行。
`on_tool_error`(error, *, run_id[, parent_run_id])	当工具出错时运行。
`on_tool_start`(serialized, input_str, *, run_id)	当工具开始运行时执行。

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

Parameters:

token (str)
verbose (布尔值)
kwargs (Any)

Return type:

无

on_agent_action(action: AgentAction, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在代理操作上运行。

Parameters:

action (AgentAction) – 代理动作。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_agent_finish(finish: AgentFinish, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在代理端运行。

Parameters:

finish (AgentFinish) – 代理完成。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

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

当链结束时运行。

Parameters:

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

Return type:

无

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

当链发生错误时运行。

Parameters:

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

Return type:

任何

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

当链开始时运行。

Parameters:

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

Return type:

无

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

当聊天模型启动时运行。

Parameters:

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

Return type:

任何

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

重写以定义自定义事件的处理程序。

Parameters:

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

Return type:

任何

在版本0.2.15中添加。

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

当LLM结束时运行。

Parameters:

response (LLMResult)
kwargs (Any)

Return type:

无

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

当LLM出错时运行。

Parameters:

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

Return type:

任何

on_llm_new_token(token: str, *, chunk: GenerationChunk | ChatGenerationChunk | None = None, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

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

Parameters:

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

Return type:

任何

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

当LLM开始运行时执行。

ATTENTION: This method is called for non-chat models (regular LLMs). If: 你正在为聊天模型实现一个处理程序，你应该使用on_chat_model_start来代替。

Parameters:

serialized (Dict[str, Any]) – 序列化的LLM。
prompts (List[str]) – 提示词。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

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

当Retriever结束运行时执行。

Parameters:

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

Return type:

任何

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

当Retriever出错时运行。

Parameters:

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

Return type:

任何

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#

当Retriever开始运行时执行。

Parameters:

serialized (Dict[str, Any]) – 序列化的检索器。
query (str) – 查询。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

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

在重试事件上运行。

Parameters:

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

Return type:

任何

on_text(text: str, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

在任意文本上运行。

Parameters:

文本 (str) – 文本内容。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

on_tool_end(output: Any, *, run_id: UUID, parent_run_id: UUID | None = None, **kwargs: Any) → Any#

当工具结束运行时执行。

Parameters:

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

Return type:

任何

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

当工具出错时运行。

Parameters:

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

Return type:

任何

on_tool_start(serialized: dict[str, Any], input_str: str, *, run_id: UUID, parent_run_id: UUID | None = None, tags: list[str] | None = None, metadata: dict[str, Any] | None = None, inputs: dict[str, Any] | None = None, **kwargs: Any) → Any#

当工具开始运行时执行。

Parameters:

serialized (Dict[str, Any]) – 序列化的工具。
input_str (str) – 输入字符串。
run_id (UUID) – 运行ID。这是当前运行的ID。
parent_run_id (UUID) – 父运行ID。这是父运行的ID。
tags (可选[列表[字符串]]) – 标签。
metadata (可选[字典[字符串, 任意类型]]) – 元数据。
inputs (可选[Dict[str, Any]]) – 输入。
kwargs (Any) – 额外的关键字参数。

Return type:

任何

使用 ContextCallbackHandler 的示例

Context