API Reference

Table of Contents

• Overview
• API Structure
• Modules
  • Core Modules
  • Schema Modules
  • Utility Modules
  • Integration Modules
  • Other Modules
• Decorators
  • Minimal
  • Reasoning Process Decorators
  • Output Structure Decorators
  • Tone
  • Verification
• Usage Example

Overview

This section contains the API reference for the Prompt Decorators package. It provides detailed documentation for all modules, classes, functions, and properties in the package.

API Structure

The API is organized into the following sections:

Modules

• Modules: Documentation for all Python modules in the package
• Core Modules: Core functionality of prompt decorators
• Schema Modules: Data models and schemas
• Utility Modules: Helper functions and utilities
• Integration Modules: Integrations with other systems

Decorators

• Decorators: Documentation for all available prompt decorators
• Minimal Decorators: Essential decorators for basic functionality
• Reasoning Process Decorators: Decorators for controlling reasoning processes
• Output Structure Decorators: Decorators for controlling output structure
• And more...

Usage Example

from prompt_decorators import transform_prompt

# Transform a prompt using decorators
transformed_prompt = transform_prompt(
    "What are the environmental impacts of electric vehicles?",
    ["+++StepByStep(numbered=true)", "+++Reasoning(depth=comprehensive)"]
)

For more examples, see the Quick Start guide.