SEO optimisation with AI (ChatGPT)

Installation instructions, documentation and FAQs for the Shopware plugin

Installation instructions

Install the extension via the extension area.

OpenAI API key

  1. Go to https://platform.openai.com/.
  2. Log in.
  3. Create a new project.
  4. Go to your profile and go to the "API keys" section https://platform.openai.com/settings/organization/api-keys.
  5. Create a new API key via "Create new secret key".
  6. Top up credit so that the OpenAI API works. https://platform.openai.com/settings/organization/billing/overview
  7. Optional: We recommend that a usage limit is set so that no unnecessary costs are incurred in the event of an error https://platform.openai.com/settings/organization/limits
Create a new API key

Setting up the extension in Shopware

API credentials

  • Enter the API key, this should start with "sk-proj".
  • Select your desired AI model.

Settings "All META tags product / category (configured)"

Settings for the creation of SEO data in mass processing. These settings are only for mass processing or for the "All META tags (configured)" button in single mode.

Creating META information for images

  • Automatic generation of selected META information when creating or updating images: this setting allows the META information for images to be inserted directly when uploading or updating. This works automatically, please check your OpenAI limits.
  • Selection of languages to be generated (default language is always generated): a list of the languages in which the META information is generated.
  • Checkboxes which information is processed in mass processing and automated creation.
  • If you have an Htaccess active for your shop, you must enter this login data here so that the image META information can be created. This is necessary because the images are analysed by OpenAI and access is required.

General settings

AI processing single entity

Products SEO data

  • Go to Catalogues -> Products and select your desired product.
  • Meta title, meta description and keywords can be created in the SEO area.
  • Use the corresponding button to create your desired SEO data or all three.

Category SEO data

  • Go to Catalogues -> Categories and select your desired category.
  • Meta title, meta description and keywords can be created in the SEO area.
  • Use the corresponding button to create your desired SEO data or all three.

Bulk text editing

  • Go to Catalogues -> SEO AI - Mass update.
  • The desired area to be edited can be selected in "Area".
    • Product META information
    • Image alt and title text
  • Individual settings are available for the various areas
  • Filter specifies whether something should be taken into account when selecting the areas to be processed, such as only processing entities that have not yet been processed by the AI
  • Languages specifies which language is to be edited.
  • Categories offers a category selection. This is used to narrow down the entities to be edited. Select all categories with Shift+click to edit all entities.
  • The entities found, which are processed, are listed below.
  • In the "Currently running bulk jobs" area, it is displayed whether a job is currently running

Prompting

Überblick

Das Prompting Modul ermöglicht es, die KI-Textgenerierung anzupassen und zu verändern. Es ist möglich die vorgegebenen Prompt zu erweitern oder zu ersetzen. Es ist ein Grundsätzliches Verständnis für Prompting vorausgesetzt, daher ist dieses Modul nur für „Experten“ empfohlen.

Zugriff auf das Prompting-Modul

Das Prompting-Modul ist über zwei Wege erreichbar:

  1. Über die Einstellungen: Navigieren Sie zu Einstellungen → Plugins → SEO AI Prompts.
  2. Über das Massenupdate: Im Massenupdate-Modul finden Sie einen Link „Prompts konfigurieren“ direkt in der Konfigurationsansicht.

Verfügbare Bereiche

In dieser App stehen Ihnen folgende Bereiche zur Verfügung:

  • Produkt Meta-Titel: SEO-optimierte Produkttitel
  • Produkt Meta-Beschreibung: SEO-Beschreibungen für Produkte
  • Produkt Meta-Keywords: Relevante Keywords für Produkte
  • Kategorie Meta-Daten: SEO-Daten für Kategorien
  • Medien Meta-Daten: Alt-Texte und Titel für Bilder

Konfigurationsmöglichkeiten pro Bereich

1. Zusätzlicher Prompt (Optional)

  • Hier können spezielle Anweisungen ergänzt werden, die zusätzlich zum Standard-System-Prompt an die KI gesendet werden.

2. Verfügbare Variablen

  • Für jeden Bereich werden die verfügbaren Variablen angezeigt.
  • Variablen können direkt angeklickt werden, um sie in den zusätzlichen Prompt einzufügen.
  • Die Variablen werden automatisch an der Cursor-Position im Text eingefügt.
  • Verfügbare Variablen je nach Bereich:
  • ##targetLanguage## – Zielsprache
  • ##productName## – Produktname
  • ##productText## – Produktbeschreibung
  • ##productNumber## – Artikelnummer/MPN
  • ##productManufacturerName## – Herstellername
  • ##productManufacturerDescription## – Herstellerbeschreibung
  • ##categoryName## – Kategoriename
  • ##categoryText## – Kategoriebeschreibung
  • ##lengthFrom## / ##lengthTo## – Textlängen-Vorgaben
  • ##keywords_amount## – Anzahl der Keywords

3. KI-Modell Auswahl

  • Es kann das OpenAI-Modell für die Textgenerierung ausgewählt werden.
  • Verschiedene Modelle haben unterschiedliche Stärken und Kosten:
  • GPT-5 Mini: Schnell und kostengünstig, ideal für große Mengen
  • GPT-5: Ausgewogene Leistung und Qualität
  • GPT-5 Nano: Kompaktes Modell für einfache Aufgaben
  • GPT-4.1 Serie: Ältere Modelle, weiterhin verfügbar

4. System-Prompt Einstellungen

  • Der Standard-System-Prompt enthält die grundlegenden Anweisungen für die KI.
  • Option „Standard-System-Prompt deaktivieren“: kann verwendet werden, wenn die komplette Kontrolle übernehmen werden soll. Bitte nur aktivieren, wenn Sie mit Prompting vertraut sind.
  • Der aktuelle System-Prompt wird zur Transparenz angezeigt.

Wichtige Hinweise für Prompting

Achtung bei Prompt-Anpassungen:

  • Prompts sollten nur angepasst werden, wenn Sie sich mit Prompting auskennen.
  • Alle Anpassungen erfolgen auf eigenes Risiko.
  • Testen Sie Änderungen zuerst im Einzelmodus oder bei der Massenbearbeitung mit wenigen Elementen.
  • Der tatsächlich abgesendete Prompt kann im Logging-Modul in der Detailansicht kontrolliert werden.

Best Practices für eigene Prompts

  1. Seien Sie spezifisch: Je genauer Ihre Anweisungen, desto besser das Ergebnis.
  2. Nutzen Sie Variablen: Verwenden Sie die verfügbaren Variablen für dynamische Inhalte.
  3. Testen Sie schrittweise: Beginnen Sie mit kleinen Änderungen und testen Sie die Ergebnisse.
  4. Beispiele sind hilfreich: Geben Sie der KI Beispiele für den gewünschten Stil.
  5. Längenangaben beachten: Nutzen Sie die Längenvariablen für präzise Textlängen.

Beispiele für zusätzliche Prompts

Für Produktbeschreibungen:

Schreibe in einem enthusiastischen Ton und verwende Aufzählungspunkte für die wichtigsten Features.
Beginne mit einem packenden Einleitungssatz, der das Hauptproblem anspricht, das ##productName## löst.

Für Meta-Titel:

Integriere immer den Herstellernamen ##productManufacturerName## am Anfang des Titels.
Verwende action-orientierte Wörter wie "Kaufen", "Bestellen" oder "Entdecken".

Für Kategoriebeschreibungen:

Strukturiere die Beschreibung in 3 Absätze:
1. Einleitung zur Kategorie
2. Hauptvorteile der Produkte in dieser Kategorie
3. Call-to-Action zum Stöbern

Logging und Kontrolle

Nach der Textgenerierung können Sie im Logging-Modul überprüfen:

  • Welcher Prompt tatsächlich an die KI gesendet wurde.
  • Wie die Variablen ersetzt wurden.
  • Welches Ergebnis generiert wurde.

Dies hilft Ihnen, Ihre Prompts kontinuierlich zu optimieren.

Tipps zur Fehlerbehebung

  • Zu kurze/lange Texte: Passen Sie die Längenangaben in der Plugin-Konfiguration an.
  • Falscher Ton: Ergänzen Sie spezifische Ton-Anweisungen im zusätzlichen Prompt.
  • Fehlende Informationen: Stellen Sie sicher, dass alle benötigten Produktdaten gepflegt sind.
  • Inkonsistente Ergebnisse: Verwenden Sie spezifischere Anweisungen oder wechseln Sie das Modell.

SEO AI - Log

The SEO AI log records every job that has run for the corresponding areas. If a job does not run, the log is the first point of contact.

Go to Catalogues -> SEO AI - Log

Entity Log

The individual entities that are processed by the AI are entered here and sorted by area.

Bulk Log

The bulk log jobs are entered here.

Common errors - entries in the log:

  • error_no_credits: indicates that no credit is stored in the OpenAI account.

FAQs

AI Shop Assistant: General questions

This can have several causes:

  1. An already installed plugin has used an incorrect database type: https://forum.shopware.com/t/unknown-database-type-enum-requested/98651
  2. You could insert the following once in the Shopware configuration: https://symfony.com/doc/current/doctrine/dbal.html#registering-custom-mapping-types-in-the-schematool

Please ensure that the API key has a credit balance.

In this case, the application has not been installed correctly. Most of the time, this occurs in conjunction with other plugins that cause an error in your database configuration. If you uninstall our app, you should receive an error message from the database that gives an indication of which plugin caused the error. If you cannot interpret the error message, please let us know. (Contact form).

50 AI calls are activated for the test phase. If you are seriously interested in the APP and would like to continue using it after the test phase, you are welcome to contact us. (Contact form)

To configure the app, please follow the steps below:

1. Upload the app in the administration under "Extensions/My Extensions".

2. Install and activate the app.

3. Go to the configuration of the app and add the required OpenAPI key.

4. Choose which AI model you use

5. You can specify which metadata should be changed. This option is intended for mass updating.

The GPT4o model is currently the most favourable in terms of price/performance.

For online shops with a wide range of products, a higher temperature setting of 0.6-1 is often beneficial to generate varied and interesting descriptions. For shops with many similar products, a lower temperature setting of 0.2-0.4 should be used to ensure consistency and clarity. It can be useful to test different temperature settings to find out which best suits the specific requirements and style of the online shop.

The Open AI plugin offers the desired functions for creating product descriptions and meta information. However, it does not currently enable the generation of texts for individual free fields such as USPs. The generated texts are created in the selected language, and for translations, our translation plugin (Auto Translation Pro) can be used.

Open AI: General questions

The OpenAI account can be accessed via this link: https://platform.openai.com/ .

Here you will find the management of the credit, limitation and the API keys, which are necessary for the extension!

  1. A new project must be created first.
  2. A new API key can be created here and assigned to a project.

This key can be entered in the configuration of the extension.

Credits are required for the OpenAI API to function properly. As with other services, this is a "prepaid" method. You top up the credits and these are automatically "spent" as soon as the extension is used and a request is sent.

To top up credits with OpenAI, a payment method must be set up via your own profile.

The payment methods can be found under: Organisation -> Billing. A new payment method can be added here via "add payment details". If this is done, credits will also be topped up.

Credits are billed in dollars. OpenAI uses "tokens" - one token corresponds to approx. 4 characters.

Overview table from OpenAI https://openai.com/api/pricing/:

If, for example, only a certain budget of credits per month is available or for protection, limits can be set.

Monthly limits can be set via the profile: Organisation -> Limits, as well as an e-mail notification as soon as a certain amount is reached.

OpenAI provides usage in different "tiers". Initially, every user is in the "Free" tier, which severely restricts the use of the AI models to a few requests per minute. As soon as $5 has been paid for, these restrictions are greatly reduced and the extension can be used more efficiently.

Further information on the limitations can be obtained directly from OpenAI: https://platform.openai.com/docs/guides/rate-limits/usage-tiers?context=tier-free

Which current "tier" has been reached can be seen in the account here: https://platform.openai.com/settings/organization/limits

If there is interest in having someone else check settings and limits, members can be invited to join the organisation.

You can find the area here: https://platform.openai.com/settings/organization/members

A new person can be added here via "invite". There are two role options to choose from, here you can specify whether the new member can only view certain data or whether they can contribute to the organisation. As the first option is quite limited and certain tasks cannot be assigned, it is advisable to assign the "Owner" option.

For technical reasons, the extension only works on the domain for which it was purchased.

Staging and test environments are not supported.