AIDmi - AI, describe my image!
AIDmi leverages AI to generate comprehensive image accessibility text. From the toolbar, the "AI, describe my image!" button will evaluate all images within the content, including Media images, and provide appropriate alt text descriptions. You can make changes to the suggested text prior to selecting and inserting the test into the image alt tag.
For individual image uploads (not Media), a button is placed next to the CKEditor 5 Alternative Text box. Clicking this button sends the selected image to the AI for description generation.
Currently, only the Gemini AI is available due to its ability to provide detailed descriptions through its API.
How much does Gemini AI cost?
Please review the cost information provided by Google [here](https://ai.google.dev/pricing). There is a free tier suitable for smaller implementations, but it will be used to train the AI. The pay-as-you-go plan does not contribute to AI training.
**Protect your API Key!** It is recommended to limit usage to specific IPs through Google API configuration.
Installation and Configuration
Select API:
Currently, only Google Gemini is supported. Additional AI services may be integrated in the future based on their output quality and integration feasibility.
Select Model:
Currently, only Gemini 1.5 Flash is supported. Others had some issues providing the same image detail. Still making this part of configuration for future changes and new models.
Gemini API Key
Set the API Key under Configuration > Web services > AIDmi Settings. More information can be found [here](https://ai.google.dev/gemini-api/docs/api-key).
API Key Input Method
- **API Key in Settings (Testing Only)**: Directly add the API key in Drupal settings. This method is not recommended for production environments.
- **File Path (Recommended)**: Specify the path to a text file containing your API key. It's recommended to place this file outside of your root directory. For example, if your web root is `web/`, you should use `/../` to indicate a path outside of this directory.
API Instructions:
This setting allows you to customize the instructions provided to the AI for generating alt text. The current default works well for most cases.
How Does It Work?
In CKEditor, you will see a link labeled "AI, describe my image!" next to the Alternative Text box. Clicking this link will generate a description and display a preview. If you accept the description, it will be inserted into the Alternative Text box.
Add "AI, describe my image!" button to the CKEditor 5 Toolbar
Go to: Configuration > Content authoring > Text formats and editors
From there, you can select Configure on each CKEditor5 toolbar and add the "AI, describe my image!" button. This is the button that will review your entire piece of content and evaluate all images.
Future Plans
Long form detailed description ability optionally attached to an image.
Additional AI services may be incorporated based on their ability to provide comprehensive descriptions beyond simple OCR capabilities.
Project information
- Project categories: Accessibility, Content editing experience
2 sites report using this module- Created by mferanda on , updated
Stable releases for this project are covered by the security advisory policy.
Look for the shield icon below.
