User Guide for Akeneo AI Image Generator

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

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

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.

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

Following that, a page will open with a button labeled Create New Secret Key, after that enter the name.

Then click on restricted Allow permission of Models “Read” and Model Capabilities “Write” as shown in the screenshot.

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.

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

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

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

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.

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.

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

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.

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.

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

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.

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.

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

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.

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.

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.

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

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

Thank you for reading this documentation. For any queries or doubts, reach out to us at support@webkul.com. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.