promptflow.integrations.langchain 模块#
- class promptflow.integrations.langchain.LangChainEventType(value)#
基类:
Enum
一个枚举。
- AGENT = ('AGENT', 3)#
- CHAIN = ('CHAIN', 1)#
- LLM = ('LLM', 0)#
- TOOL = ('TOOL', 2)#
- class promptflow.integrations.langchain.PromptFlowCallbackHandler#
基类:
BaseCallbackHandler
PromptFlowCallbackHandler
实现了 langchain.callbacks.base.BaseCallbackHandler 接口,该接口为每个可订阅的事件都提供了一个方法。当事件触发时,将调用处理程序上相应的方法。- property always_verbose: bool#
是否始终详细输出。
- on_agent_action(action: AgentAction, **kwargs: Any) None #
在代理动作时运行。
- 参数:
action (AgentAction) – 代理的动作。
- on_agent_finish(finish: AgentFinish, **kwargs: Any) None #
在代理结束时运行。
- 参数:
finish (AgentFinish) – 代理的结束信息。
- on_chain_end(outputs: Dict[str, Any], **kwargs: Any) None #
在链停止运行时运行。
- 参数:
outputs (Dict[str, Any]) – 链的输出。
- on_chain_error(error: Union[Exception, KeyboardInterrupt], **kwargs: Any) None #
在链发生错误时运行。
- 参数:
error (Union[Exception, KeyboardInterrupt]) – 链的错误。
- on_chain_start(serialized: Dict[str, Any], inputs: Dict[str, Any], **kwargs: Any) None #
在链开始运行时运行。
- 参数:
serialized (Dict[str, Any]) – 序列化的链对象。
inputs (Dict[str, Any]) – 用于运行链的输入。
- on_llm_end(response: LLMResult, **kwargs: Any) None #
在 LLM 停止运行时运行。
- 参数:
response (LLMResult) – LLM 的响应。
- on_llm_error(error: Union[Exception, KeyboardInterrupt], **kwargs: Any) None #
在 LLM 发生错误时运行。
- 参数:
error (Union[Exception, KeyboardInterrupt]) – LLM 的错误。
- on_llm_new_token(token: str, **kwargs: Any) None #
在新的 LLM 令牌时运行。仅当启用流式传输时可用。
- 参数:
token (str) – 新的令牌。
- on_llm_start(serialized: Dict[str, Any], prompts: List[str], **kwargs: Any) None #
在 LLM 开始运行时运行。
- 参数:
serialized (Dict[str, Any]) – 序列化的 LLM 对象。
prompts (List[str]) – 用于运行 LLM 的提示。
- on_text(text: str, **kwargs: Any) None #
在任意文本时运行。
- 参数:
text (str) – 文本。
- on_tool_end(output: str, **kwargs: Any) None #
在工具停止运行时运行。
- 参数:
output (str) – 工具的输出。
- on_tool_error(error: Union[Exception, KeyboardInterrupt], **kwargs: Any) None #
在工具发生错误时运行。
- 参数:
error (Union[Exception, KeyboardInterrupt]) – 工具的错误。
- on_tool_start(serialized: Dict[str, Any], input_str: str, **kwargs: Any) None #
在工具开始运行时运行。
- 参数:
serialized (Dict[str, Any]) – 序列化的工具对象。
input_str (str) – 用于运行工具的输入字符串。