README

Foundation for easy AI integration in Neos CMS Extensible and ready to go with SEO Meta-Description and Image Alt-Text generation Mixins

Easy AI text generation configuration on properties in NodeType YAML files
Full control over prompts
Easily extensible with custom AI model-handlers and -connectors
Suitable for all properties with inspector editors of type TextFieldEditor and TextAreaEditor

Installation

composer require jvmtech/ai-toolkit

JvMTECH:
  AIToolkit:
    modelPresets:
      gemini:
        apiKey: 'my-gemini-api-key'

NodeType Configuration Contcept

First we have to change to an AI ready Editor to be able to use the AI functionality.

properties:
  summary:
    ui:
      inspector:
        editor: 'JvMTECH.AIToolkit/TextAreaEditor'
        editorOptions: [...]

By choosing a "Model Handler" we define what kind of job has to be done and by choosing a "Model Preset" we define with which AI model we want to process it.
```
modelHandler: 'textToText'
modelPreset: 'gemini'
```
By defining the "Prompt Variables" values we prepare the data which can be used by the AI model - in the "Prompt" but also directly in the request to the AI model.
```
promptVariables:
  type: "${Neos.Node.labelForNode(documentNode)}"
  content: "${documentBody}"
```
By writing the "Prompt Template" we give instructions to the AI model on what we want to achieve.
```
promptTemplate: 'Create a short {type} summary of: {content}'
```

This way we have full flexibility and control over the AI model and the data we want to process.

Examples

Playing with Meta-Description

# Use default configuration:
'Vendor:Page.Document':
  superTypes:
    'JvMTECH.AIToolkit:Mixin.SEO': true

# Or customize the AI model and prompt ("ADDITIONAL SPECIFICATIONS" are added to the default prompt):
'Vendor:Product.Document':
  superTypes:
    'JvMTECH.AIToolkit:Mixin.SEO': true
  properties:
    metaDescription:
      ui:
        inspector:
          editorOptions:
            promptTemplate: |
              # ROLE
              You are an expert SEO copywriter specializing in meta descriptions that drive clicks and improve search rankings.

              # TASK
              Create a compelling SEO meta description for the content provided below.

              # SPECIFICATIONS
              - Length: Maximum 160 characters (including spaces)
              - Style: Compelling, action-oriented, using active voice
              - Content: Must accurately represent the source material
              - Focus Keyphrase: Use "{node.properties.aiToolkitMetaFocusKeyphrase}" if available; otherwise use "{node.properties.title}"
              - Language: Write in {targetLanguage}

              # ADDITIONAL SPECIFICATIONS
              - Fun: Always use multiple Emojis

              # FORMAT REQUIREMENTS
              Deliver the meta description as plain text only.
              Do not include HTML tags, Markdown formatting, quotes, or explanatory notes.
              Provide only the final meta description text.

              # SOURCE CONTENT
              {content}

Image Alt-Text generation

# Enable image alt-text generation
'Vendor:Image.Content':
  superTypes:
    'JvMTECH.AIToolkit:Mixin.ImageAlternativeText': true
    # We assume the image is in a property named "asset"

# Or do your own thing:
'Vendor:SpecialImage.Content':
  properties:
    # specialImage: ...
    specialAlternativeText:
      options:
        preset: 'image.alternativeText'
      ui:
        inspector:
          editor: 'JvMTECH.AIToolkit/TextAreaEditor'
          editorOptions:
            modelHandler: 'imageToText'
            modelPreset: 'openai-advanced'
            promptVariables:
              targetLanguage: "${Configuration.setting('Neos.ContentRepository.contentDimensions.language.presets.' + node.context.targetDimensions.language + '.label')}"
              # The "imageToText" model handler requires the prompt variable "asset" to attach the image to the AI model request.
              asset: "${transientValues.specialImage ? transientValues.specialImage : q(node).property('specialImage')}"
            promptTemplate: |
              You are creating content for an accessible website.
              Describe the content of the attached image in a {targetLanguage} short sentence.

Extensibility

Model Handlers

Model Handlers are responsible for the communication with the AI model. They allow you to manipulate the input and output of the AI model.

The package comes with the following handlers:

TextToText
ImageToText

Custom Model Handlers

JvMTECH:
  AIToolkit:
    modelHandlers:

      customTextToText:
        className: 'Vendor\Name\ModelHandlers\CustomTextToTextModelHandler'
        # ... optional configuration

Model Connectors

Model Connectors are responsible for the actual requests to the AI model. They allow you to manipulate the input and output of the AI model.

The package comes with the following connectors:

OpenAI
Gemini

Custom Model Connectors

JvMTECH:
  AIToolkit:
    modelPresets:

      customAI:
        className: 'Vendor\Name\ModelConnectors\CustomAIModelConnector'
        # ... optional configuration

Background

The Neos AI-Toolkit package is completely free and can be tailored to your needs.

We also rely on this package to build our commercial product Neos AI-Toolbox by Jung von Matt TECH.

Neos AI-Toolbox: A suite of AI-powered tools for Neos websites that enhances SEO, accessibility, and content management. The toolbox includes SEO AI (creates meta descriptions and keywords), Translation AI (translates content), Corporate Language AI (ensures brand consistency), Accessibility AI (improves website accessibility) and Web Readability AI (optimizes text readability). Additionally, automated AI agents handle SEO optimization, translation, and CRM interactions. Available through flexible subscription models with credit-based usage, it significantly reduces manual work while improving website performance and user experience.

by jvmtech.ch

jvmtech / ai-toolkit

Maintainers

Details