Operation Templates

Operation templates in Raikoo provide a structured way to standardize AI-based operations across your workflows. This guide explains how operation templates work, how they interact with operations and workflow operations, and how to use them effectively.

Understanding Operation Templates

At their core, operation templates are predefined configurations that provide structured guidance for constructing both system and user prompts during interactions with AI models. They serve as blueprints that ensure consistency and reusability across similar operations.

Key Components in the Template Hierarchy

The template system in Raikoo involves three main components that work together:

1. Operation Templates

Operation templates define the foundation for both system and user prompts. They act as reusable patterns that can be applied across multiple operations, ensuring consistency in how AI models are instructed.

Key characteristics:

• Provide standardized structure for system and user prompts
• Include placeholders for operation-specific content
• Establish a baseline for AI interactions

2. Operations

Operations build upon templates by adding specific details relevant to their particular task. They can customize or enhance the template's structure while maintaining its core framework.

Key characteristics:

• Reference an operation template
• Add task-specific instructions or context
• Can override parts of the template as needed
• Define standard configurations for repeated use

3. Workflow Operations

Workflow operations are individual instances of operations placed within a workflow. They introduce specific context and replacements for the current execution.

Key characteristics: - Reference a specific operation - Provide the final layer of customization - Supply contextual values for placeholders - Tailor the operation for a specific use case within the workflow

How Prompts Are Constructed

Understanding how Raikoo constructs prompts is essential for effective template design. Both system and user prompts follow a similar construction pattern:

System Prompt Construction

The system prompt is constructed in this order:

1. Operation Template's System Prompt Template:

   • Provides the general framework
   • Includes placeholders for specific instructions
   • Sets the tone and approach

2. Operation's System Prompt:

   • Adds operation-specific guidelines
   • May override template sections
   • Incorporates specialized knowledge

3. Workflow Operation's Replacements:

   • Supplies contextual values for placeholders
   • Provides specific references to workspace data
   • Customizes the prompt for the current workflow context

User Prompt Construction

The user prompt follows a similar pattern:

1. Operation Template's User Prompt Template:

   • Establishes the structure for user inputs
   • Defines how requests will be framed
   • Includes placeholders for specific content

2. Operation's User Prompt:

   • Adds specific instructions relevant to the operation
   • Refines how the model should process inputs
   • May include additional guidelines

3. Workflow Operation's Replacements:

   • Provides the actual content for processing
   • Inserts specific data references
   • Makes the prompt relevant to the current task

Benefits of Using Operation Templates

Implementing operation templates in your Raikoo workflows offers several advantages:

• Consistency: Ensure a uniform approach across similar operations
• Reusability: Define patterns once and reuse them across multiple operations
• Maintainability: Update templates centrally to affect all dependent operations
• Quality Control: Establish best practices for prompt engineering
• Efficiency: Reduce redundancy in prompt design

Creating Effective Operation Templates

When designing operation templates, consider these best practices:

System Prompt Templates

For system prompts, focus on:

• Persona Definition: Clearly define the AI's role and expertise
• Task Framing: Establish the general purpose of operations using this template
• Methodology Guidance: Include instructions on how to approach problems
• Constraint Definition: Set boundaries for AI responses
• Placeholder Strategy: Include clear placeholders for operation-specific details

Example structure:

{{Persona.Alignment}}

{{Operation.SystemPrompt}}

{{OperationProcessor.OutputFormat}}

User Prompt Templates

For user prompts, focus on:

• Input Structure: Define how inputs should be formatted
• Context Integration: Establish patterns for including relevant context
• Output Expectations: Set clear guidelines for response format
• Placeholder Planning: Include placeholders for dynamic content

Example structure:

{{Operation.Request}}

Examples

1. Example 1

Existing Parameters:

TODO

Final System Prompt (After Processing)

TODO

Final User Prompt (After Processing)

TODO

Best Practices for Template Management

To effectively manage operation templates in your Raikoo projects:

Organization

• Create Template Categories: Group templates by purpose or domain
• Use Clear Naming Conventions: Name templates descriptively
• Document Template Purpose: Include clear descriptions of when to use each template

Development

• Start Simple: Begin with basic templates and refine over time
• Test Templates Thoroughly: Validate templates with various inputs
• Iterate Based on Results: Refine templates based on AI output quality

Maintenance

• Regularly Review Templates: Assess template effectiveness
• Version Control: Track template changes
• Share Best Practices: Document successful pattern

Conclusion

Operation templates provide a powerful way to standardize AI interactions across your Raikoo workflows. By understanding the relationship between templates, operations, and workflow operations, you can create more consistent, maintainable, and effective AI workflows.

The layered approach of templates, operations, and workflow operations offers flexibility while ensuring consistency, allowing you to create sophisticated AI interactions that can be reused and refined over time.