Automatically fill alt text field when user uploads a new image

[jjroelofs]

Why are we doing this work

This work aims to improve accessibility and user experience by ensuring that all images uploaded to the platform automatically have descriptive alt text. This feature leverages AI to generate accurate alt text, reducing the manual effort required by users and enhancing the accessibility of our content for visually impaired users.

Relevant links

• Drupal AI Module Documentation

Requirements

• Deliver the PR as an update to our Recipes, possibly as part of the Image media recipe: DXPR CMS Image Media Type Recipe
• Cover any place where images can be added to ensure comprehensive utility:
  1. Image fields in node forms
  2. /media/add/image
  3. Image uploads in CKEditor, etc.
• Leverage the Drupal AI module to support swappable AI backends, avoiding vendor lock-in.
• DXPR CMS should not require additional configuration after the installation wizard completes; any necessary configuration must be handled in a new profile step or inside our API Keys step if only setting up a key and service vendor is required.
• If the client does not add an API key/backend pair during installation (the field should not be required), there will be no warnings or errors in the UI, except in the Status Report page where we will print a warning that automatic alt text generation is disabled and add a link to the page where the user can set it up.
• The generated alt text should be automatically loaded as a field value inside the alt text form field in the image upload widget, with no additional UI for editing or updating the text.

Non-functional requirements

• Documentation: Update user guides and API documentation to include details about the new alt text generation feature.
• Feature flag: Implement a feature flag to enable or disable the automatic alt text generation.
• Performance and Testing: Ensure the AI service does not significantly impact the image upload speed and conduct comprehensive testing to cover various image types and ensure accurate alt text generation.

[yautjacetanu]

Notes on phase 1 for this:

• We will focus on image fields and the media field.
• We will allow both a button press and automatic filling of the alt text fields.
• Phase 1 will only support Anthropic Claude + OpenAI Chatgpt 4o easily in the wizard. (The AI module itself will allow for more in theory but these may require more work on the user's side. This isn't a problem right now as there are few models that support vision).

[ivanboring]

@jjroelofs would it be possible for me to be added so I can push a specific branch, to be able to create the pull request for you?

All the changes mentioned in the call should be done now - I have setup so your configuration is autogenerating alt texts, but that is easy to change in the recipe so buttons are shown.

[jjroelofs]

@ivanboring added!

[ivanboring]

This was recently added to the recipes api - could it maybe be interesting for adding API keys on sites that only applies the recipe?

https://www.drupal.org/node/3470507