README

composer require valantic-spryker-eco/open-ai

Description

• OpenAI Client for spryker
• BO UI to manage prompts
• BO UI to generate prompts for:
  • product descriptions
  • seo title
  • seo keywords
  • seo description

Screenshots

Example usage

• use this snipped to upgrade backoffice inputs to openai inputs (also see Zed/OpenAi/assets/Zed/js/modules/openai.js:4)

attachOpenAiCompletionApiToToForm('textarea[name*="description"]', function(event, languageContext) {
 let nameInput = $('input[name*="'+languageContext+'][name"]');
 let skuInput = $('input[name*="'+languageContext+'][sku"]');
 return {title: nameInput.value, sku: skuInput.value};
});

• https://gitlab.nxs360.com/packages/php/spryker/open-ai/-/blob/main/src/ValanticSpryker/Zed/OpenAi/Communication/Console/OpenAiConsole.php#L39
• https://github.com/openai-php/client

Install

• composer require the package composer req valantic-spryker/open-ai:^1.0.4 (see https://gitlab.nxs360.com/groups/packages/php/spryker/-/packages)
• add 'ValanticSpryker' as first element to your $config[KernelConstants::CORE_NAMESPACES]
• configure your openai key in your config $config[OpenAiConstants::OPENAI_API_KEY] = 'xxxxxx'; (https://platform.openai.com/account/api-keys)
• console propel:install
• console transfer:generate
• load open-ai js in your backoffice twig (see Zed/Gui/Presentation/Layout/layout.twig:5)
• console twig:cache:warmer
• add to your projects backoffice navigation.xml (see src/config/Zed/navigation.xml:370)
• console navigation:build-cache
• console router:cache:warm-up:backoffice
• add path.resolve('./vendor/valantic-spryker/') to your JS webpack build dirs frontend/zed/build.js:11
• build frontend (npm run zed)

HowTos Cli

PHP Container: docker run -it --rm --name my-running-script -v "$PWD":/data spryker/php:latest bash

Run Tests: codecept run --env standalone

Fixer: vendor/bin/phpcbf --standard=phpcs.xml --report=full src/ValanticSpryker/

Disable opcache: mv /usr/local/etc/php/conf.d/docker-php-ext-opcache.ini /usr/local/etc/php/conf.d/docker-php-ext-opcache.iniold

XDEBUG:

• ip addr | grep '192.'

• $docker-php-ext-enable xdebug

• configure phpstorm (add 127.0.0.1 phpstorm server with name valantic)

• $PHP_IDE_CONFIG=serverName=valantic php -dxdebug.mode=debug -dxdebug.client_host=192.168.87.39 -dxdebug.start_with_request=yes ./vendor/bin/codecept run --env standalone

• Run Tests with coverage: XDEBUG_MODE=coverage vendor/bin/codecept run --env standalone --coverage --coverage-xml --coverage-html

use nodejs

• docker run -it --rm --name my-running-script -v "$PWD":/data node:18 bash

ToDo:

• add list with useful prompts
• refactor UI to native web components
• add importer for demo prompts
• add twig example
• add generate product button
• add generate customer button
• add generate cms page button
• add generate cms seo texts buttons
• add more context to generate button (i.e. price, category, attributes)