MageOS AI Catalog Data Generation

Automatically generate compelling product descriptions, meta titles, keywords, and SEO content using OpenAI's powerful language models. This Magento 2 extension seamlessly integrates AI content generation into your product workflow, improving SEO performance and customer experience while saving time on content creation.

🚀 Features

Automatic Content Generation

• Product Descriptions: Generate both short and detailed product descriptions
• SEO Meta Data: Auto-create meta titles, descriptions, and keywords
• Smart Prompts: Customizable prompts with product variable substitution
• Bulk Processing: Mass enrich existing products with AI-generated content

Flexible Processing Options

• Real-time Generation: Generate content immediately when products are saved
• Asynchronous Processing: Queue-based background processing for better performance
• Safe Mode: Only fill empty fields, preserving existing content
• Override Mode: Replace all content with fresh AI-generated versions

Advanced Configuration

• OpenAI Model Selection: Support for all OpenAI chat completion models (GPT-3.5, GPT-4, GPT-4o, etc.)
• Customizable Prompts: Tailor generation prompts for each content type
• Rate Limiting: Built-in backoff mechanisms for API rate limits
• Fine-tuning Controls: Temperature, frequency penalty, and presence penalty settings

Also

• Mass Actions: Bulk enrich products from admin grid
• Queue Management: Scalable async processing with Magento's queue system
• Error Handling: Robust error handling with retry mechanisms
• Multi-store Support: Configure different settings per store scope

📋 Requirements

• PHP: 8.1 or higher
• Magento: 2.4.x (compatible with both Magento 2 and Mage-OS)
• OpenAI Account: Active OpenAI account with API access
• Composer: For installation

🔧 Installation

composer require mage-os/module-catalog-data-ai
php bin/magento setup:upgrade

⚙️ Configuration

1. Basic Setup

Navigate to Admin Panel → Stores → Configuration → Catalog → AI Data Enrichment

Essential Settings

• Enable Module: Turn on/off the extension
• OpenAI API Key: Your OpenAI API key (required)
• OpenAI Organization ID: Your organization ID (optional)
• OpenAI Project ID: Your project ID (optional)
• Processing Mode: Choose between real-time or asynchronous processing

Model Configuration

• OpenAI Model: Select your preferred model (recommended: gpt-4o)
• Max Tokens: Maximum tokens per request (default: 1000)

2. Content Field Configuration

Configure which product fields to auto-generate:

| Field | Purpose | Default Prompt | |-------|---------|----------------| | Short Description | Brief product highlight | "write a very short product description for {{name}} to highlight reasoning for purchase, under 100 words" | | Description | Detailed product information | "write a detailed product description for {{name}} with features in bullet list, under 1000 words" | | Meta Title | SEO page title | Customizable | | Meta Keywords | SEO keywords | Customizable | | Meta Description | SEO meta description | Customizable |

3. Advanced Settings

Fine-tune AI behavior:

• System Prompt: Instructions for AI behavior (default: "Be a content generator, just reply with the content, skip all introductions.")
• Temperature: Creativity level (0.0-1.0)
• Frequency Penalty: Reduce repetitive content (-2.0 to 2.0)
• Presence Penalty: Encourage variety (-2.0 to 2.0)

4. Asynchronous Processing Setup

For better performance with high-volume stores:

1. Enable "Asynchronous enrichment" in configuration
2. Set up Magento queue consumer catalogDataAI.enrich

📖 Usage

Automatic Generation (New Products)

Once configured, the extension automatically generates content for new products when saved, based on your settings:

• Real-time Mode: Content generated immediately during product save
• Async Mode: Content generated in background via queue system

Mass Content Generation (Existing Products)

For existing products without AI-generated content:

1. Go to Catalog → Products
2. Select products to enrich
3. Choose from Actions dropdown:
   • AI Enrich: Replace all content (overwrites existing)
   • AI Enrich (Safe): Only fill empty fields

🤖 Supported OpenAI Models

Recommended Models

| Model | Best For | Speed | Cost | Quality | |-------|----------|--------|------|---------| | gpt-4o | Production use | Fast | Medium | Excellent | | gpt-4-turbo | High-quality content | Medium | High | Excellent | | gpt-3.5-turbo | Budget-conscious | Very Fast | Low | Good |

Model Requirements

• Must support Chat Completions API
• Must support developer role messages
• Recommended: Models with function calling capability

🎯 Prompt Customization

Using Product Variables

Prompts support dynamic variables from product data:

Write a description for {{name}} priced at {{price}}. Key features: {{short_description}}

Available Variables

• {{name}} - Product name
• {{price}} - Product price
• {{sku}} - Product SKU
• {{short_description}} - Existing short description
• Any custom product attribute

Best Practices for Prompts

1. Be Specific: Include detailed instructions about tone, length, and format
2. Use Context: Reference product attributes to create relevant content
3. Set Constraints: Specify word/character limits
4. Define Format: Request bullet points, paragraphs, or specific structures

Example optimized prompt:

Create a compelling product description for {{name}}:
- Target audience: [your customer type]
- Tone: Professional yet engaging
- Length: 150-200 words
- Include key benefits and features
- End with a call-to-action
- Focus on {{category}} category specifics

🔧 Troubleshooting

Common Issues

API Key Errors

• Verify your OpenAI API key is correct and active
• Check your OpenAI account has sufficient credits
• Ensure API key has appropriate permissions

Rate Limiting

• The extension includes automatic backoff mechanisms
• Consider using async processing for bulk operations
• Monitor your OpenAI usage dashboard

Content Not Generating

• Ensure the module is enabled in configuration
• Check that product fields are empty (in safe mode)
• Verify prompts are configured for the desired attributes

Queue Processing Issues

• Ensure queue consumers are running
• Check Magento cron is functioning
• Monitor queue status in admin panel

Performance Optimization

1. Use Async Processing for bulk operations
2. Optimize Prompts or choose a faster model to reduce token usage
3. Configure Rate Limits appropriately
4. Monitor API Costs regularly

🤝 Contributing

We welcome contributions! Please:

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Credits

• Author: Ryan Sun (ryansun81@gmail.com)
• Website: Sunmerce
• Repository: mage-os-lab/module-catalog-data-ai

🆘 Support

• Issues: GitHub Issues
• Documentation: This README and inline code comments
• Community: Mage-OS Discord