Back to Top

User Guide for Akeneo AI Image Generator

Updated 13 May 2024

Akeneo AI Image Generator allows you to create product images for your product using Open AI.

Using the module, you can create different prompt templates to generate product images based on the selected prompt on the product page.

You have the option of creating an AI image based on certain image type attributes during configuration. While creating images with AI, users can select the image’s size, quality, style, and number of images.

Akeneo ChatGPT AI Connector can be used to create content for Akeneo PIM products using ChatGPT.

Basic Requirements

  • This module works with 7.0.x. Download Akeneo from here
  • Node and Yarn packages need to be installed.
  • If you want to use this extension in Akeneo EE Serenity mode, please contact us.
  • For the Akeneo installation, your Akeneo server should meet these system requirements.

Feature

  • Open AI generates images of products automatically.
  • Images of products are generated according to the prompt selected.
  • On the product page, you can modify some of the prompts.
  • Text, text area, Yes/No, number, and simple select are examples of triggered attribute types that can be used for prompt creation.
  • DALL-E-3 and DALL-E-2. Prompts work with OpenAI picture generating models.
  • Users can select image size, quality, quantity, and style.

Installation

Two different types of module installation processes are available for the module.

Searching for an experienced
Akeneo Company ?
Find out More
  1. Composer Installation
  2. Manual Installation

Installation using Composer

Read This Blog

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository as well as the installation script.

For Akeneo and 7.x

{
  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/ai-image/src/Webkul/ImageGeneratorBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-install-cmd": [
           "vendor/webkul/ai-image/src/Webkul/ImageGeneratorBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
        ],
        "post-create-project-cmd": [
          "vendor/webkul/ai-image/src/Webkul/ImageGeneratorBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
       ]
   },
  "repositories": [{
    "type": "composer",
    "url": "https://akeneorepo.webkul.com/"
  }]
}

3: Use composer to install the extension.

        composer require webkul/ai-image

4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.

Manual Installation for Version 7.x

  • After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
  • From the PIM directory, run the following command over the NO-DOCKER instance:.
./src/Webkul/ImageGeneratorBundle/install/config.sh COMPOSER=false NO_DOCKER=true
  • After that run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/ImageGeneratorBundle/install/config.sh COMPOSER=false NO_DOCKER=false

Uninstall Module: For Akeneo 7.x

  • From the PIM directory, run the command below over the NO-DOCKER Instance.
./src/Webkul/ImageGeneratorBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
  • Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/ImageGeneratorBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false

How to Get API Credentials

The user has to first create an OpenAI account and log in to the OpenAI dashboard, as shown in the screenshot.

Akeneo-Get API Credentials-2

A popup will show after the user clicks on the API keys tab. The user will select View API Keys.

Akeneo-Get API Credentials-3

Following that, a page will open with a button labeled Create New Secret Key, after that enter the name and click on restricted Allow permission of Models “Read” and Model Capabilities “Write” as shown in the screenshot.

Akeneo-Get API Credentials-4

After that, when the user clicks on the create secret key button, a pop-up box with the API key will appear. The copy button allows the user to copy the key from here.

Akeneo-Get API Credentials-5

Akeneo AI Image Generator– Workflow

After successfully installing the Akeneo AI Image Generator, the AI Images icon will appear on the left side of the dashboard, as seen below:

Akeneo AI Image Generator-1

After that, to add a credential, the user will navigate to AI Images >> Credentials >> Add Credential.

Akeneo AI Image Generator-2

Then, enter your Open AI account’s name and API key.

 Akeneo AI Image Generator-3

The user will now click the Save button to save all of their credentials.

Note: If you added multiple credentials, only one of them should be enabled, while the others should be disabled.

Akeneo AI Image Generator-4

After that, click Prompt. AI images can be created using prompt templates, which are predefined and structured instructions.

To “Add Prompt,” click on the Create Prompt.

Akeneo AI Image Generator-5

To create a prompt, you have to select the prompt models there are two different models for prompt creation:

  • DALL·E-3
  • DALL·E-2

Create a prompt by selecting model DALL·E-3:

  • Name: Enter the prompt name.
  • Model: Select model DALL-E-3 for image generation by setting this parameter accordingly.
  • Prompt: Enter the details of how you want to create a customized prompt here. To reference attributes, use ‘@’. Supported attributes are boolean, text, text area, simple-select, and number.
  • Image size: Select the image size for generating the image: 1024×1024′, ‘1792×1024’, or ‘1024×1792’.
  • Image quality: Select from “Standard’ and ‘HD’ quality.HD’ quality generates images with finer details and higher consistency across the image.
  • Image style: Users can select between ‘vivid’ and ‘natural’ styles for generated images.

The term “vivid” refers to images that are hyperreal and dramatic.
‘Natural’ produces images that appear more natural, rather than hyper-real

Akeneo AI Image Generator-6

Create a prompt by selecting model DALL·E-2:

  • Name: Enter the prompt name.
  • Model: Select model DALL-E-2 for image generation by setting this parameter accordingly.
  • Prompt: Enter the details of how you want to create a customized prompt here. To reference attributes, use ‘@’. Supported attributes are boolean, text, text area, simple-select, and number.
  • Image size: Select the image size for generating the image: ‘256×256’, ‘512×512’, or ‘1024×1024
  • Number of images: Users can define the number of images they want to create, which ranges from 1 to 5.After that, you can select any of them.
Akeneo AI Image Generator-7

The prompt can be edited, deleted, or enabled based on your needs. After that, one prompt can be made the default prompt based on your needs.

Akeneo AI Image Generator-8

After that, the user can use the OpenAI Image Generator functionality to add new products or update product images.

Akeneo AI Image Generator-9

If you want to edit the product, click on the product that you want to edit.

The Generate Using AI button will appear on each media type of attribute.

Akeneo AI Image Generator-11

Then, click on the Generate Using AI button.

If you want to remove the background of your product image, you can check Akeneo Image Background Remover.

Dall-E-3 Image Generation:

After that, select the prompt template (default or customized) that you want to use while searching for images. Then, after adding all the details, click the generate button.

Akeneo AI Image Generator-12

After that, the Open AI will generate similar images based on a search request and display them in the pop-up box.

Akeneo AI Image Generator-13

If you want to add this image to the product image, click the confirm button, or if you don’t want to, click the back button.

Akeneo AI Image Generator-14

Once you click the confirm button, an image will be assigned to the product, and then you can click the product save button.

Dall-E-2 Image Generation:

Again, click on the Generate Using AI button. After that, select the prompt template, then click on the generate button.

Akeneo AI Image Generator-15

After that, the Open AI will generate similar images based on a search request and display them in the pop-up box. Then you have to select any one of them.

Akeneo AI Image Generator-16

Once you click the confirm button, an image will be assigned to the product, and then you can click the product save button.

Akeneo AI Image Generator-17

Akeneo AI Image Generator – ACL Permission

Admin can grant authorized users access to specific users by assigning Akeneo AI Image Generator – ACL Permission) plugin permissions.

Akeneo AI Image Generator-18

Support

Thank you for reading this documentation. For any queries or doubts, reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.

Current Product Version - 1.0.0

Supported Framework Version - 7.x

. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home

Table of Content