LangChain Decorators 项目简介
LangChain Decorators 是一个基于 LangChain 的扩展层,为编写自定义 LangChain 提示和链提供了一种更优雅的语法糖。这个非官方的库旨在简化 LangChain 的使用体验,其许多想法都带有鲜明的个人风格。
主要特点与优势
- Python 风格:LangChain Decorators 以更“Pythonic”的方式写代码,让开发者在使用时更自然。
- 多行提示支持:支持编写多行提示而不会破坏代码的缩进结构。
- IDE 集成功能:利用 IDE 的内置功能,如提示、类型检查和文档弹出等,可以快速查看函数、提示内容和参数。
- LangChain 生态合作:充分利用 LangChain 生态系统的强大功能。
- 可选参数支持:添加对可选参数的支持,更灵活地控制提示。
- 参数共享:通过将参数绑定到类,轻松在不同提示间共享。
快速入门
安装
要安装 LangChain Decorators,只需用以下命令:
pip install langchain_decorators
使用示例
项目中提供了多个示例来帮助用户上手:
提示声明
默认情况下,整个函数文档字符串会被视为提示。不过,你可以通过在文档中标记 <prompt>
代码块的方式来明确提示定义。
您的聊天消息提示
在聊天模型中,定义一组消息模板非常有用。例如:
@llm_prompt
def simulate_conversation(human_input:str, agent_role:str="a pirate"):
"""
## 系统消息
- 注意提示标签中的 `:system` 后缀
```<prompt:system>
你是一名 {agent_role} 黑客。必须表现得像个黑客。
一直用代码回复,使用 Python 或 JavaScript 代码块……
例如:
…… 不能用其它方式回复……只用代码回复——要符合你的角色。
```
"""
pass
输出解析器
LangChain Decorators 的 llm_prompt
装饰器会根据输出类型自动检测最佳输出解析器。如果没有设置输出类型,它将返回原始字符串。项目也天然支持列表、字典和 Pydantic 类型的输出。
LLM 函数及动态功能
对于最新的 OpenAI 聊天模型,只需用 @llm_function
装饰器标记你的函数,并根据文档结构提供相关描述。你还可以利用 functions
参数,以及动态功能提供器来将函数和提示结合在一起,甚至可以更具动态性地提供一组函数。
简化流式传输
该项目允许在流式上下文中使用标记为异步的提示。只需简单地在流式上下文中调用相关提示,就可以捕获到流内容。
更复杂的结构
对于词典或 Pydantic 类型,需要指定格式化指令。LangChain Decorators 支持自动生成这些指令,从而简化复杂结构的处理。
绑定提示到对象
项目允许将提示绑定到对象上,使得在类中可以访问和使用提示。此外,你还可以自定义各种设置,并将全局配置应用于整个项目。
调试与其他功能
LangChain Decorators 提供多种调试选项,如日志输出和 PromptWatch.io 支持。此外,项目还依赖于其他开源库(例如 LangChain)来实现日志存储、提示变化跟踪和比较。
项目依赖于 LangChain 和 PromptWatch,通过这些工具可以轻松记录日志、跟踪提示变化,并通过单元测试比较它们。
贡献
对 LangChain Decorators 项目的反馈、贡献和拉取请求都是非常受欢迎的 🙏。更多关于如何参与的细节可以参考项目的贡献指南。