PHPackages                             mage-os/module-catalog-data-ai - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. mage-os/module-catalog-data-ai

ActiveMagento2-module[Utility & Helpers](/categories/utility)

mage-os/module-catalog-data-ai
==============================

Generate product descriptions and similar content with the help of AI.

1.0.0(1y ago)36261↓50%7[5 issues](https://github.com/mage-os-lab/module-catalog-data-ai/issues)[7 PRs](https://github.com/mage-os-lab/module-catalog-data-ai/pulls)MITPHPPHP ^8.1

Since Mar 25Pushed 2mo ago5 watchersCompare

[ Source](https://github.com/mage-os-lab/module-catalog-data-ai)[ Packagist](https://packagist.org/packages/mage-os/module-catalog-data-ai)[ RSS](/packages/mage-os-module-catalog-data-ai/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (8)Dependencies (2)Versions (22)Used By (0)

MageOS AI Catalog Data Generation
=================================

[](#mageos-ai-catalog-data-generation)

[![Latest Stable Version](https://camo.githubusercontent.com/c066cfaa1f7f094e7934dfe2e542cbe9144387f84a8fdc16e466e6722bd5d93d/68747470733a2f2f706f7365722e707567782e6f72672f6d6167652d6f732f6d6f64756c652d636174616c6f672d646174612d61692f762f737461626c65)](https://packagist.org/packages/mage-os/module-catalog-data-ai)[![License](https://camo.githubusercontent.com/e47259f8a06d32a7f6f96c9253926af9cfb7ede7eb7bc839a02daf1fdbd8f15f/68747470733a2f2f706f7365722e707567782e6f72672f6d6167652d6f732f6d6f64756c652d636174616c6f672d646174612d61692f6c6963656e7365)](https://packagist.org/packages/mage-os/module-catalog-data-ai)[![Total Downloads](https://camo.githubusercontent.com/ae6a985746f31a8f8f837961eea9c2a07d989ff2e38e0d9c28cc82b03ca079fa/68747470733a2f2f706f7365722e707567782e6f72672f6d6167652d6f732f6d6f64756c652d636174616c6f672d646174612d61692f646f776e6c6f616473)](https://packagist.org/packages/mage-os/module-catalog-data-ai)

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
----------

[](#-features)

### **Automatic Content Generation**

[](#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**

[](#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**

[](#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**

[](#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
--------------

[](#-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
--------------

[](#-installation)

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

⚙️ Configuration
----------------

[](#️-configuration)

### 1. Basic Setup

[](#1-basic-setup)

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

#### Essential Settings

[](#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

[](#model-configuration)

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

### 2. Content Field Configuration

[](#2-content-field-configuration)

Configure which product fields to auto-generate:

FieldPurposeDefault 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 titleCustomizable**Meta Keywords**SEO keywordsCustomizable**Meta Description**SEO meta descriptionCustomizable### 3. Advanced Settings

[](#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

[](#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
-------

[](#-usage)

### Automatic Generation (New Products)

[](#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)

[](#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
-------------------------

[](#-supported-openai-models)

### Recommended Models

[](#recommended-models)

ModelBest ForSpeedCostQuality**gpt-4o**Production useFastMediumExcellent**gpt-4-turbo**High-quality contentMediumHighExcellent**gpt-3.5-turbo**Budget-consciousVery FastLowGood### Model Requirements

[](#model-requirements)

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

🎯 Prompt Customization
----------------------

[](#-prompt-customization)

### Using Product Variables

[](#using-product-variables)

Prompts support dynamic variables from product data:

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

```

### Available Variables

[](#available-variables)

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

### Best Practices for Prompts

[](#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
-----------------

[](#-troubleshooting)

### Common Issues

[](#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

[](#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
--------------

[](#-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
---------

[](#-license)

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

🙏 Credits
---------

[](#-credits)

- **Author**: Ryan Sun ()
- **Website**: [Sunmerce](https://www.sunmerce.com/)
- **Repository**: [mage-os-lab/module-catalog-data-ai](https://github.com/mage-os-lab/module-catalog-data-ai)

🆘 Support
---------

[](#-support)

- **Issues**: [GitHub Issues](https://github.com/mage-os-lab/module-catalog-data-ai/issues)
- **Documentation**: This README and inline code comments
- **Community**: [Mage-OS Discord](http://chat.mage-os.org)

###  Health Score

45

—

FairBetter than 93% of packages

Maintenance64

Regular maintenance activity

Popularity27

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 61.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~50 days

Recently: every ~73 days

Total

8

Last Release

433d ago

Major Versions

0.3.1 → 1.0.02025-03-12

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/100189073?v=4)[Mage-OS](/maintainers/mage-os-ci)[@mage-os-ci](https://github.com/mage-os-ci)

---

Top Contributors

[![ryansunxl](https://avatars.githubusercontent.com/u/1762391?v=4)](https://github.com/ryansunxl "ryansunxl (27 commits)")[![rhoerr](https://avatars.githubusercontent.com/u/13335952?v=4)](https://github.com/rhoerr "rhoerr (8 commits)")[![SamueleMartini](https://avatars.githubusercontent.com/u/40766441?v=4)](https://github.com/SamueleMartini "SamueleMartini (4 commits)")[![sprankhub](https://avatars.githubusercontent.com/u/930199?v=4)](https://github.com/sprankhub "sprankhub (1 commits)")[![LS-Myron](https://avatars.githubusercontent.com/u/10085633?v=4)](https://github.com/LS-Myron "LS-Myron (1 commits)")[![Vinai](https://avatars.githubusercontent.com/u/72463?v=4)](https://github.com/Vinai "Vinai (1 commits)")[![nikolalardev](https://avatars.githubusercontent.com/u/3015908?v=4)](https://github.com/nikolalardev "nikolalardev (1 commits)")[![ProxiBlue](https://avatars.githubusercontent.com/u/4994260?v=4)](https://github.com/ProxiBlue "ProxiBlue (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/mage-os-module-catalog-data-ai/health.svg)

```
[![Health](https://phpackages.com/badges/mage-os-module-catalog-data-ai/health.svg)](https://phpackages.com/packages/mage-os-module-catalog-data-ai)
```

###  Alternatives

[maestroerror/laragent

Power of AI Agents in your Laravel project

630106.4k](/packages/maestroerror-laragent)[kambo/langchain

 ⚡ Building applications with LLMs through composability in PHP ⚡

3224.4k](/packages/kambo-langchain)[mfd/ai-filemetadata

Automatically generates FAL metadata for files by means of public LLMs

1142.1k](/packages/mfd-ai-filemetadata)[eliashaeussler/typo3-solver

Extension for TYPO3 CMS to extend TYPO3's exception handling with AI generated solutions

292.1k](/packages/eliashaeussler-typo3-solver)[ercogx/filament-openai-assistant

Create chat page with OpenAI Assistant

185.6k](/packages/ercogx-filament-openai-assistant)[molbal/ai-phpdoc

Writes missing PHPDoc comments using GPT-3.

194.4k](/packages/molbal-ai-phpdoc)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)