🚀 提示装饰器项目文档

提示装饰器（Prompt Decorators）是一个用于优化AI模型提示语效果的框架。它借助标准格式与扩展机制，让用户能够在不同AI平台间共享和复用提示语增强功能，提升提示语设计效率与可复用性。

🚀 快速开始

提示装饰器（Prompt Decorators）是一个用于改进AI模型生成的提示语（prompts）效果的框架。你可以按照以下步骤快速使用：

安装

pip install prompt-decorators

基本使用示例

import prompt_decorators as pd

# 加载可用修饰符
pd.load_decorator_definitions()

# 创建一个修饰符实例
reasoning = pd.create_decorator_instance("Reasoning", depth="comprehensive")

# 应用修饰符到提示语上
prompt = "解释提示工程的概念。"
decorated_prompt = reasoning.apply(prompt)

print(decorated_prompt)

✨ 主要特性

• 标准修饰符集合：一组预定义的修饰符，包括Reasoning, Tone, Example, 等。
• 可扩展框架：支持用户自定义修饰符
• 多平台兼容性：支持Claude、ChatGPT等多种AI服务
• 参数验证：自动检查修饰符参数的有效性
• 动态加载机制：允许在运行时加载新的修饰符定义
• 文档生成工具：自动生成修饰符的使用说明

📦 安装指南

基本安装

pip install prompt-decorators

可选依赖项

# 用于模型上下文协议（MCP）集成
pip install "prompt-decorators[mcp]"

# 用于开发和测试
pip install "prompt-decorators[dev,test]"

# 用于文档
pip install "prompt-decorators[docs]"

# 安装所有可选依赖项
pip install "prompt-decorators[all]"

💻 使用示例

基础用法

import prompt_decorators as pd

# 加载可用修饰符
pd.load_decorator_definitions()

# 创建一个修饰符实例
reasoning = pd.create_decorator_instance("Reasoning", depth="comprehensive")

# 应用修饰符到提示语上
prompt = "解释提示工程的概念。"
decorated_prompt = reasoning.apply(prompt)

print(decorated_prompt)

高级用法

from prompt_decorators import DecoratorRegistry, ParameterValidator

# 定义一个新的修饰符类
class ExampleDecorator:
    def __init__(self, examples):
        self.examples = examples
        
    def apply(self, prompt):
        return f"根据以下示例，{prompt}: {self.examples}"

# 注册新的修饰符
DecoratorRegistry.register("Example", ExampleDecorator)

# 使用新修饰符
example_decorator = DecoratorRegistry.get("Example")("这是一个示例。")
prompt = "如何解释这个概念?"
decorated_prompt = example_decorator.apply(prompt)
print(decorated_prompt)

📚 详细文档

详细的技术文档和使用指南请参考 官方文档。

📄 许可证

本项目遵守 Apache License 2.0 协议。具体内容请参阅 LICENSE 文件。

👏 贡献指南

欢迎任何贡献！请阅读 CONTRIBUTING.md 了解如何为这个项目做出贡献。

🙏 致谢

感谢以下个人和组织对本项目的贡献和支持：

• Mostapha Kalami Heris：他的文章《提示装饰器：提高AI响应的简单方法》启发了我们制定这一规范和创建此仓库。
• Synaptiai：该框架和规范的创作者和维护者
• Contributors：所有为本项目做出贡献的杰出个人