Prompt Decorators

🚀 提示装飾器プロジェクトドキュメント

提示装飾器（Prompt Decorators）は、AIモデルが生成するプロンプト（prompt）の効果を向上させるためのフレームワークです。標準的な形式と拡張機構を使用することで、提示装飾器はユーザーが異なるAIプラットフォーム間でプロンプトの強化機能を共有および再利用することを可能にします。

🚀 クイックスタート

提示装飾器（Prompt Decorators）は、AIモデルの生成結果に重大な影響を与えるプロンプトの質を向上させるためのフレームワークです。標準化された修飾子と拡張可能なフレームワークを通じて、異なるAIプラットフォーム間でのプロンプトの共有と再利用を可能にします。

✨ 主な機能

• 標準修飾子セット：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：このプロジェクトに貢献したすべての優れた個人