neosidekick/ai-assistant

Use the power of GPT-4 to assist you in writing content

v2.2.1 2024-04-11 22:28 UTC

Requires

• neos/media: ~7.0 || ~8.0 || dev-master
• neos/neos: ~7.0 || ~8.0 || dev-master
• neos/neos-ui: ~7.0 || ~8.0 || dev-master
• neos/seo: *
• sitegeist/fusionlinkprototypes: v1.0.1

GPL-3.0-or-later

• Roland Schütz

• flow
• Neos
• writing
• ai
• openai
• ChatGpt
• gpt
• gpt-4

README

Create content drafts faster, brainstorm new ideas, and turn thoughts into brilliant text. Based on the latest findings in artificial intelligence.

Installation

NEOSidekick.AiAssistant is available via Packagist. Add "neosidekick/ai-assistant" : "^2.2" to the require section of the composer.json or run:

composer require neosidekick/ai-assistant

We use semantic versioning, so every breaking change will increase the major version number.

Configuration

API Key

You can use the free version, or get more features with a license. To configure your license key, add the following to your Settings.yaml:

NEOSidekick:
  AiAssistant:
    apikey: 'your-api-key-here'

Content Language

If you're using content dimensions in your Neos setup, we will retrieve the content language from the currently active content dimension. However, if you are not using this feature of Neos, you need to define the default content language in the configuration, like this:

NEOSidekick:
  AiAssistant:
    defaultLanguage: 'en'

English (en) is configured out of the box. Supported languages are:

• English en
• English (US) en_US
• English (Australia) en_AU
• English (UK) en_UK
• French fr
• French (Belgium) fr_BE
• French (Switzerland) fr_CH
• French (France) fr_FR
• French (Canada) fr_CA
• German de
• German (Austria) de_AT
• German (Germany) de_DE
• German (Switzerland) de_CH
• Italian it
• Italian (Italy) it_IT
• Italian (Switzerland) it_CH
• Spanish es
• Spanish (Spain) es_ES
• Spanish (Mexico) es_MX
• Spanish (Argentina) es_AR

Permissions

By default, every editor can use the assistant. However, if you want to restrict the access to certain roles, you can copy this configuration into your site package. It will give you an additional role AiAssistantEditor.

roles:
  'Neos.Neos:AbstractEditor':
    privileges:
      - privilegeTarget: NEOSidekick.AiAssistant:CanUse
        permission: ABSTAIN

  'NEOSidekick.AiAssistant:AiAssistantEditor':
    description: Grants access to the NEOSidekick AiAssistant sidebar
    privileges:
      - privilegeTarget: NEOSidekick.AiAssistant:CanUse
        permission: GRANT

Of course, you can also define the privilege for any other role that you are using for example Neos.Neos:Administrator.

Page-specific AI briefings

You can add the mixin NEOSidekick.AiAssistant:Mixin.AiPageBriefing to any Document NodeType to allow editors to fine-tune the NEOSidekick AI Assistant behavior, or you can build your own based on the NEOSidekick YAML API.

Asset Alt-Text Generator

Image alternative texts are essential for SEO and accessibility. With good image descriptions, you can help Google and screen readers to understand your images.

Read the tutorial on how create dozens of image descriptions in no time.

License

You can use it for free with our free and paid plans. You are not allowed to modify, reuse or resell this code. For additional feature wishes, write us an email to [e-mail].