README

Ghostwriter：数据对象和砖块的可配置AI文本生成器

"Ghostwriter"无缝集成AI到Pimcore的PIM和CMS UI中。提示可以轻松配置和调整，针对数据对象和砖块进行逐字段调整。提示可以包含占位符，动态引用数据对象、砖块或页面中已存在的文本或数据。现在写SEO文本或产品描述只需点击一下：Ghostwriter将使用页面的元数据或产品的技术信息来创建所需的副本。

特性

将AI文本生成添加到数据对象中的文本和富文本字段
将AI文本生成添加到砖块中的文本和富文本字段
按字段配置发送给ChatGPT的提示
向您的提示中添加占位符，它将动态地从当前数据对象、砖块或页面（文档）中提取实际数据，并在将其发送到ChatGPT之前将其添加到提示中
除了主要提示外，还可以配置多个快捷命令，例如缩短、扩展或翻译字段的内容。
多语言支持

先决条件

您需要付费的ChatGPT账户才能使用ChatGPT API。有关详细信息，请参阅https://help.openai.com/en/articles/7039783-how-can-i-access-the-ChatGPT-api。在您使用OpenAI注册后，将为您分配个人API密钥。在您能够向ChatGPT发送请求之前，需要将其添加到Ghostwriter配置中。OpenAI的费用取决于您发送的请求数量。在撰写此手册时，您可以免费使用一定量的请求进行测试，而无需收费。

配置

配置在数据对象中进行。存在一个包含ChatGPT API密钥和一些其他设置的全局配置对象，如下所示

这也是您添加所谓的快捷键的地方。快捷键是在您配置的所有字段中显示的提示。您应该使用它们来全局添加关于缩短或扩展文本长度、改变语调或翻译文本的提示。快捷键不能引用其他字段的数据，它仅使用聊天历史作为输入。

为了将Ghostwriter功能添加到您的PIM和CMS UI中，您还必须添加字段配置对象。这是在逐字段级别进行所有提示工程的地方。

有关如何在配置UI中直接使用如{seo.title}等占位符的更多文档。

进一步阅读

您配置的提示质量将对Ghostwriter对您的最终用户的有用性产生巨大影响。您甚至可能希望给予熟练编写提示的最终用户对提示配置的访问权限。这是OpenAI的官方提示工程指南：https://platform.openai.com/docs/guides/prompt-engineering

如果您想了解为什么在字段配置中配置的文本长度永远不会达到100%精确，请在此处了解ChatGPT的“token”概念：https://help.openai.com/en/articles/4936856-what-are-tokens-and-how-to-count-them

如何获取插件

请发送电子邮件至 goran.stefanovic@asioso.de 或 christoph.ramm@yukon.de。

安装

安装插件有两种选择。第一种（推荐）是获取访问令牌，如果您想从我们的私有包仓库安装插件，则需要使用此令牌。然后，执行以下命令

composer config --global --auth http-basic.asioso-ghostwriter.repo.repman.io token YOUR-TOKEN

composer config repositories.asioso composer https://asioso-ghostwriter.repo.repman.io/

第二种选择是将包作为zip文件获取，将zip文件上传到您的项目（在Pimcore根目录中创建一个名为bundles的文件夹）并将以下内容添加到您的composer.json

"repositories": [
{
"type": "artifact",
"url": "./bundles/"
}
]

无论您使用哪种方法，完成这些步骤后，您应该能够执行以下命令。

Pimcore 11

composer require asioso/ghostwriter-bundle

如果是Pimcore 10

composer require asioso/ghostwriter-bundle:"^1.0"

启用它

// config/bundles.php
return [
    // ...
    Asioso\GhostwriterBundle\GhostwriterBundle::class => ['all' => true],
];

安装

php bin/console pimcore:bundle:install GhostwriterBundle

卸载

php bin/console pimcore:bundle:uninstall GhostwriterBundle

composer remove asioso/ghostwriter-bundle

作者和联系方式

Ghostwriter插件是由以下公司共同开发的

asioso GmbH，Wilhelmine-Reichard-Str. 26，80935 慕尼黑，德国

www.asioso.de

yukon consulting GmbH，Waldpromenade 40b，82131 高丁，德国

asioso / public-ghostwriter-bundle

维护者

详细信息

README