creatuity / magento2-openai-content-generator

creatuity/magento2-openai-content-generator

magento2-module Compatibility: Not compatible Code Quality: Fail Tests: N/A Security: Pass Proprietary

Creatuity AI Content Generator Module for Magento

Table of Contents

  1. Overview
  2. Installation
  3. User Guide
  4. Links

Overview

The Creatuity AI Content Generator module for Magento allows for the automated generation of descriptions and metadata for products based on their attributes. By interfacing with OpenAI, product attributes can be utilized to produce compelling content with ease.

This module consists of:

The core is designed with potential future integrations in mind, allowing for easy integration with other AI services.

Installation

composer require creatuity/magento2-openai-content-generator
bin/magento s:up

If you have problem with instalation, add the following repositoreis to your composer.json file

{
    "type": "vcs",
    "url": "[email protected]:creatuity/magento2-openai-content-generator.git"
},
{
    "type": "vcs",
    "url": "[email protected]:creatuity/magento2-ai-content-generator-core.git"
},
{
    "type": "vcs",
    "url": "[email protected]:creatuity/magento2-ai-content-generator-mass-actions.git"
}

User Guide

Configuration

  1. Navigate to Stores → Configuration → Creatuity → AI Content.

  2. Configure the fields as per your requirement:
    image

    Configuration Field Description Default Value
    Enabled Enable/Disable the module No
    AI Provider Choose AI Provider (Only OpenAI currently) OpenAI
    Description Attributes Default attributes for description generation Product Name, Size, Color
    Meta-tags Attributes Default attributes for meta-tag generation Product Name, Description
    OpenAI API Key Your OpenAI API Token -
    Model Name OpenAI model for requests. Model determines cost gpt-3.5-turbo

Once the module is configured and enabled, you can go to product configuration.

NOTE: You can’t generate any data using the module until product is created
image

When you create and configure product (it is strongly recommended to fully configure product attributes first before generating description and meta-tags) you can go to a proper section where you are able now to click Generate With AI button

The button opens a modal window where you can optionally configure some prompt settings which will be sent to AI model

Example:

image

Product Attributes values are by default the same as the once selected in configuration. You can change here these selected by default attributes by selecting other attributes that you want to use to generate short description and description for this particular product

Short Description

  • In the product configuration, navigate to the Content section.
  • Click on "Generate With AI" to open a modal.
  • Here, you can customize the product attributes used for generating content.
  • Generated content appears in the Short Description's textarea.
  • To regenerate content, adjust settings and click "Generate" again.
  • Once satisfied, click "Apply" to move the generated content to the product's Short Description field.

Description

This section works similarly to the Short Description section. If you have Page Builder enabled, you'll need to manually copy the generated description and paste it in the desired field as auto-fill is unsupported.

Meta Tags

  1. Once the product descriptions are finalized, navigate to the Search Engine Optimization section.
  2. Click "Generate With AI" to open a modal.
  3. You can modify the default attributes used for meta-tag generation.
  4. Click "Generate" to get three meta-tag suggestions.
  5. Choose your preferred meta-tag and click "Apply".
  6. Remember to save the product.

Mass Actions

For bulk content generation:

  1. On the product grid, select the products you want.
  2. Choose either:
    • Generate With AI → Description
    • Generate With AI → Meta-Tags
  3. On the redirected page, generate and save content for products individually using "Generate One By One".
  4. Use "Skip" to bypass a product or "Confirm and Continue" to proceed to the next product.
  5. You can halt the process anytime. Pending products will always be displayed in the admin notifications bar.

Links


For any issues or feedback, please raise a ticket in the respective repository.

No changelog yet

The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.

Versions
Version Stability QA Status Compatibility Released
0.0.3 stable Fail Not compatible Details 2024-05-20 12:18:33
0.0.2 stable Not tested Not yet tested Details 2023-09-21 09:04:45

Requires 4

Package Constraint
php ^8.1
orhanerday/open-ai ^4.8
creatuity/magento2-ai-content-generator-core ^0.0.3
creatuity/magento2-ai-content-generator-mass-actions ^0.0.2

Requires-dev 1

Package Constraint
phpunit/phpunit ^9

Compatibility

Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.

Compatibility matrix (Magento × PHP)
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Fail dependency conflict Fail dependency conflict
2.4.8 Fail dependency conflict Fail dependency conflict
2.4.9 Fail dependency conflict Fail dependency conflict

Code Quality

Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge — a phpcs finding can't make a module incompatible.

Static analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

Static analysis results
Tool Status Findings Summary
PHPCS Warning 71 71 warnings (ruleset: Magento2) — 30 auto-fixable with phpcbf
PHPMD Warning 4 4 rule violations (UnusedPrivateMethod:2, UnusedFormalParameter:1, UnusedPrivateField:1)
Cpd Warning 1 1 duplicated chunk spanning 11 total lines (min-lines=5, min-tokens=70)
Composer validate Info 2 valid; 2 advisory notes (composer validate --strict)

PHPStan

Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases. Cell → details modal.

PHPStan results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 Error Error
2.4.8 Error Error
2.4.9 Error Error

Tests

Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.

Unit tests

Unit tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Integration tests

Integration tests results by Magento and PHP version
Magento PHP 8.2 PHP 8.3 PHP 8.4 PHP 8.5
2.4.7 N/A N/A
2.4.8 N/A N/A
2.4.9 N/A N/A

Security

Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.

Security results
Tool Status Findings Summary
Composer audit Pass 0
Malware scan Pass 0
License
Proprietary

More from creatuity

View vendor
Make it pay

Turn an existing module into recurring revenue.

If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.