AI导哈

提示修饰框架

一个用于标准化和增强大型语言模型提示的框架，提供多种预构建的修饰器以控制模型行为。

  • by synaptiai
  • Python
  • 本地部署
  • 44 星标
  • 更新于
在 GitHub 查看 synaptiai/prompt-decorators

使用说明

快速的装饰者

Prompt Decorators是一个全面的框架，它规范了如何增强、结构化和转换大型语言模型（LLM）的提示。此存储库包含官方的Prompt Decorators规范及其完整的Python参考实现。

文档 • 快速装饰规范

📋 目录

🔍 概述

什么是快速装饰？

Prompt Decorators引入了一个受软件设计模式启发的标准化注释系统，允许用户通过简单、可组合的“装饰器”修改LLM行为。通过在提示前添加注释，如 +++Reasoning, +++StepByStep，或 +++OutputFormat，用户可以一致地控制人工智能模型如何在不同的平台和实现上处理和响应他们的请求。

该项目通过提供以下内容来解决人工智能交互日益复杂的问题：

  1. 说明书：定义装饰器语法、行为和扩展机制的正式标准
  2. Python实现：具有全面工具的生产就绪参考实施
  3. MCP集成：一个模型上下文协议服务器，在Claude Desktop等工具中启用提示装饰器功能

关键组件

  • 📝 规格：正式 提示装饰器规范（v1.0） 定义标准
  • 🛠️ 核心框架：一个基于注册表的装饰器管理的Python实现
  • 🧩 140+装饰师：一个全面的预构建装饰库，涵盖推理、格式化等
  • 🔌 MCP服务器：与模型上下文协议集成，用于桌面AI应用程序
  • 🧷 Claude代码插件：一滴 Claude代码插件 内联扩展 ::Name(params) 在模型看到提示之前，签入精确的指令。船与a /decorate slash命令，始终打开配置，以及一个由Haiku驱动的自动选择器。
  • 📚 大量文档：为用户和开发人员提供API参考、指南和示例

背景与动机

随着大型语言模型越来越多地集成到跨行业的工作流程中，与这些系统交互的标准化、一致的方式的需求变得显而易见。当前的快速工程方法在很大程度上是临时的，在系统或用例之间切换时需要大量的文档、重新设计和大量的认知开销。

Prompt Decorators通过提供一种系统的方法，通过简单、可组合的注释来修改AI行为，从而解决了这一挑战。受编程中的Decorator模式和Python的函数装饰器的启发，它们充当了一个抽象层，将核心提示与如何处理和呈现响应的指令解耦。

快速工程中的挑战

当前的快速工程存在几个局限性：

  • 不一致：用户、平台和型号之间的说明差异很大
  • 冗长：详细说明使用可用于内容的令牌上下文
  • 认知开销：用户必须记住或记录特定的提示技巧
  • 缺乏可组合性：结合不同的教学范式很麻烦
  • 无证行为：预期的模型行为通常是隐式的，而不是显式的

快速装饰的好处

Prompt Decorators解决了快速工程中的关键挑战：

  • 不一致：提供跨不同LLM平台的标准语法和行为
  • 冗长：用简洁的注释替换冗长的说明
  • 认知开销：使用可重复使用的模式简化快速制作
  • 缺乏可组合性：实现多种指令范式的干净组合
  • 无证行为：明确定义预期的模型响应

无论您是为特定的推理模式制作提示，以特定格式构建输出，还是确保不同模型之间的一致响应，Prompt Decorators都提供了一种系统的方法，使提示工程更加模块化、可重用和可维护。

Prompt Decorators框架通过以下方式解决了这些挑战：

  • 标准化：跨平台和模型的通用词汇和语法
  • 效率：减少代币消耗的简洁注释
  • 可重用性：可以在不同环境中重复使用的一致行为
  • 可组合性：能够为复杂的交互模式组合装饰器
  • 显式行为：明确记录预期的模型响应
  • 减少认知负荷：简单的注释而不是冗长的说明

主要特点

  • 📚 基于注册表的装饰器管理：带有元数据的装饰器集中注册表
  • ✅ 参数验证和类型检查：装饰器参数的稳健验证
  • 🔢 装饰器版本控制：支持装饰器的语义版本控制
  • 🔄 兼容性检查：验证装饰器兼容性
  • 📝 文档生成：为装饰人员自动生成文档
  • 🧩 动态负载：从定义文件加载运行时装饰器
  • 🔍 运行时装饰器发现：动态发现和注册装饰师

💡 实施状态

Prompt Decorators项目目前正在积极开发中。

您可以通过测试来了解prompt装饰器是如何工作的 演示 或运行 MCP服务器实现 与您的Claude桌面一起使用。

或者您可以使用 .游标 在这个存储库中，作为Cursor（或chatGPT/Claude）中的系统指令来指导它。试试看，分享你的经验！

已实现的功能

  • ✅ 核心装饰器注册表：从标准化JSON定义加载装饰器
  • ✅ 装饰应用：将装饰器应用于具有参数验证的提示
  • ✅ 复杂的转型：将装饰器参数转换为即时调整
  • ✅ 多种输入格式：支持Python函数、字符串和JSON
  • ✅ 参数验证和类型检查：装饰器参数的稳健验证
  • ✅ 标准装饰品：规范中定义的标准装饰器的实现
  • ✅ 扩展框架：支持特定于域的装饰器扩展
  • ✅ 文档生成：从装饰器定义自动生成文档

有关实施状态的详细细分，请参阅我们的 实施状态 文件。

路线图

该项目的路线图概述于 路线图 文件。

🚀 入门指南

安装

您可以从PyPI安装该软件包 https://pypi.org/project/prompt-decorators/:

pip install prompt-decorators

要获得其他功能，您可以安装可选依赖项：

# For Model Context Protocol (MCP) integration
pip install "prompt-decorators[mcp]"

# For development and testing
pip install "prompt-decorators[dev,test]"

# For documentation
pip install "prompt-decorators[docs]"

# For all optional dependencies
pip install "prompt-decorators[all]"

基本用法

import prompt_decorators as pd

# Load available decorators
pd.load_decorator_definitions()

# Create a decorator instance
reasoning = pd.create_decorator_instance("Reasoning", depth="comprehensive")

# Apply the decorator to a prompt
prompt = "Explain the concept of prompt engineering."
decorated_prompt = reasoning.apply(prompt)

print(decorated_prompt)

验证安装

安装后，验证一切是否正常工作：

# Verify the package is installed
python -c "import prompt_decorators; print(prompt_decorators.__version__)"

# Verify registry loading
python -m prompt_decorators verify

如果你看到“注册表验证成功”，并显示加载的装饰器数量，那么你就可以开始了！

有关更详细的示例和使用说明，请参阅 官方文件.

📝 许可证

此项目根据Apache许可证2.0版获得许可。请参阅 许可证 文件以获取更多信息。

🤝 贡献

欢迎投稿！请阅读 贡献 关于如何为这个项目做出贡献的指导方针。

🤖 致谢

如果没有以下个人和组织的贡献，这个项目是不可能的：

相关 MCP