Skip to content

A WordPress plugin for automatically generating alt text for images with Microsoft's Cognitive Services Computer Vision API.

Notifications You must be signed in to change notification settings

JakePT/automatic-alternative-text

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 

Repository files navigation

=== Automatic Alternative Text ===
Contributors: JakePT, bwagdrive
Tags: image,images,media,gallery,accessibility,a11y,alt,attribute,alt attribute,alt tag,alt text
Requires at least: 4.4
Tested up to: 5.2.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Stable tag: 1.1.4

Automatically generate alt text for images with Microsoft's Cognitive Services Computer Vision API.

== Description ==
Automatic Alternative Text makes accessible images easy and fast by automatically generating alt text for images with <a href="https://azure.microsoft.com/en-au/services/cognitive-services/computer-vision/">Microsoft's Cognitive Services Computer Vision API</a>.

The Computer Vision API’s algorithms analyze the content found in an image and generates complete sentences of human readable language describing what is found in the image. The Automatic Alternative Text plugin gets this description and adds it as the alt text for each image uploaded while the plugin is active.

== Installation ==
The two methods of installing the plugin are:

1. Search for "Automatic Alternative Text" in Plugins > Add New and click the Install button.
2. Unzip the archive and put the `automatic-alt-text` folder into your site's `/wp-content/plugins/` folder.

Then activate Automatic Alt Text from the Plugins menu.

= Usage =
Before the plugin will work you need to supply an API key and endpoint for Microsoft's Cognitive Services Computer Vision API. You can learn how to sign up for a free key <a href="https://docs.microsoft.com/en-au/azure/cognitive-services/computer-vision/vision-api-how-to-topics/howtosubscribe">here</a>. Go to the Settings > Media page to enter the key and endpoint from Microsoft.

Once your key and endpoint are entered any image you upload from that point forward will automatically have its alt text set to a caption supplied by Microsoft's Cognitive Services where possible.

== Frequently Asked Questions ==

= Why aren't my images receiving alt text? =
There's several reasons an image might not get alt text:
1. Your API key is missing or incorrect. Make sure that your key is saved and accurate in Settings > Media. Also make sure that the key is for the Computer Vision API.
2. The service is not confident enough in the caption. By default the plugin will only use the received caption as alt text if the service is at least 15% confident in the result. You can adjust this confidence threshold in Settings > Media.
3. The service cannot connect to your server or is prevented from accessing the image for any reason. Try entering your image URL on <a href="https://azure.microsoft.com/en-au/services/cognitive-services/computer-vision/">this page</a> to see if the service can connect outside the context of this plugin.
4. You've exceeded your key's request quota. You can view your usage and upgrade your quota <a href="https://azure.microsoft.com/en-au/try/cognitive-services/my-apis/">here</a>.

= Can I automatically add alt text to images I've already uploaded? =
Not yet. I might add this functionality in a future version.

== Screenshots ==
1. Dismissable admin notice on installation.
2. Plugin settings.
3. An uploaded image with automatic alt text added.

== Changelog ==

= 1.1.4 =
* Fix an error that would occur if the API returned a 200 response but no captions.

= 1.1.3 =
* Support newer endpoint URLs that are missing the API endpoint, since Azure does not include this in the resource overview anymore.

= 1.1.2 =
* Fix admin notice appearing even when dismissed.

= 1.1.1 =
* Fix broken link in admin notice.

= 1.1 =
* Added setting for Endpoint URL, to support API changes.
* Changed help links to up-to-date URLs.

= 1.0.1 =
* Fixed typo in settings.

= 1.0 =
* First release.

== Privacy ==
The image, voice, video or text understanding capabilities of Automatic Alternative Text uses Microsoft Cognitive Services. Microsoft will receive the images, audio, video, and other data that you upload (via this app) for service improvement purposes. To report abuse of the Microsoft Cognitive Services to Microsoft, please visit the Microsoft Cognitive Services website at https://www.microsoft.com/cognitive-services, and use the “Report Abuse” link at the bottom of the page to contact Microsoft. For more information about Microsoft privacy policies please see their privacy statement here: https://go.microsoft.com/fwlink/?LinkId=521839.

About

A WordPress plugin for automatically generating alt text for images with Microsoft's Cognitive Services Computer Vision API.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages