https://github.com/asioso/public-ghostwriter-bundle
Public repository with useful informations of ghostwriter bundle.
https://github.com/asioso/public-ghostwriter-bundle
Last synced: 5 months ago
JSON representation
Public repository with useful informations of ghostwriter bundle.
- Host: GitHub
- URL: https://github.com/asioso/public-ghostwriter-bundle
- Owner: asioso
- License: gpl-3.0
- Created: 2024-06-05T08:35:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-30T12:13:59.000Z (almost 2 years ago)
- Last Synced: 2024-07-30T15:23:58.003Z (almost 2 years ago)
- Size: 646 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
__Ghostwriter: Configurable AI Text Generator for Data Objects and Bricks__
"Ghostwriter" seamlessly integrates AI into Pimcore’s PIM and CMS UIs. Prompts can be easily configured and tuned on a per-filed basis for both data objects and bricks. Prompts can contain placeholders that dynamically reference text or data already available in the data object, brick or page. Writing e.g. an SEO text or product description now is just a click: Ghostwriter will use the page's meta data or the product's technical information to create the required copy.
**Features**
- Add AI text generation to text and rich text fields in data objects
- Add AI text generation to text and rich text fields in bricks
- Configure the prompts sent to ChatGPT on a per-field basis
- Add placeholders to your prompts that will pull actual data from the data object at hand, from the brick or the page (document) at hand and add the data to your prompt dynamically before it is being sent to ChatGPT
- Configure multiple shortcut commands in addition to the main prompt, e.g. for shortening, extending or translating the field’s content.
- Multi language support
**Prerequisites**
You will need a paid ChatGPT account to use the ChatGPT API. See for details. Your individual API key will be assigned after you sign up with OpenAI. It needs to be added to the Ghostwriter configuration before you will be able to send requests to ChatGPT. Costs for OpenAI will depend on the volume of requests you send. As of writing this manual, there was a free request volume you can use for testing without being charged.
**Configuration**
Configuration is done in data objects. There is a **global configuration** object that takes the ChatGPT API key and a few other settings as follows:
This is also where you add so called shortcuts. Shortcuts are prompts that will be shown with all fields you configure. You should use them to globally add prompts for things like shortening or extending text length, change tonality or translate text. A shortcut can not reference data from other fields, it uses the chat history as an input only.
In order to add the Ghostwriter features to your PIM and CMS UI, you will also have to **add field configuration** objects. This is where all the prompt engineering is done on a per field level.
Find more documentation on how to use placeholders like e.g. {seo.title} directly in the configuration UI.
**Further reading**
The quality of the prompts you configure will have a huge impact on how useful Ghostwriter will be for your end users. You may even want to give end users access to the prompt configuration if they are savvy in prompt writing. This is OpenAI’s official prompt engineering guide:
If you want to understand why the text lengths you configure in the field configuration is never 100% precise, please read about ChatGPT’s “token” concept here:
**How to get plugin**
Write an email to [goran.stefanovic@asioso.de](goran.stefanovic@asioso.de) or [christoph.ramm@yukon.de](mailto:christoph.ramm@yukon.de).
**Installation**
There are two options to install plugin.
First one (recommended) is to get access token that you need to use if you want to install plugin from our Private Package Repository. Next, execute the following commands:
```bash
composer config --global --auth http-basic.asioso-ghostwriter.repo.repman.io token YOUR-TOKEN
```
```bash
composer config repositories.asioso composer https://asioso-ghostwriter.repo.repman.io/
```
Second option is to get package as zip file, upload the zip file to your project (create a folder `bundles` in the Pimcore root folder) and add the following to your `composer.json`:
```json
"repositories": [
{
"type": "artifact",
"url": "./bundles/"
}
]
```
Whatever approach you used, when you finish these steps you should be able to execute the following commands.
Pimcore 11:
```bash
composer require asioso/ghostwriter-bundle
```
or if Pimcore 10:
```bash
composer require asioso/ghostwriter-bundle:"^1.0"
```
Enable it:
```bash
// config/bundles.php
return [
// ...
Asioso\GhostwriterBundle\GhostwriterBundle::class => ['all' => true],
];
```
Install:
```bash
php bin/console pimcore:bundle:install GhostwriterBundle
```
**Uninstall**
```bash
php bin/console pimcore:bundle:uninstall GhostwriterBundle
```
```bash
composer remove asioso/ghostwriter-bundle
```
**Authors and contact**
The Ghostwriter plugin is a joint development of:
**asioso GmbH**, Wilhelmine-Reichard-Str. 26, 80935 München, Germany
[www.asioso.de](http://www.asioso.de)
**yukon consulting GmbH**, Waldpromenade 40b, 82131 Gauting, Germany
[www.yukon.de](http://www.yukon.de)