Image Recognition module

Digital asset management Unbundled: Extension

Download Multiple submodules

Edition

DX Core

License

MLA

Issues

Maven site

Latest

2.0.0

The Magnolia Image Recognition module searches for untagged images, recognizes and tags them via an external image recognition solution. The module also provides the integration of the image recognition feature with content tags.

Module structure

artifactID Description

magnolia-image-recognition-parent

Parent reactor.

     magnolia-content-tags-integration

Provides functionality to integrate content tags and the image recognition service using decorations.

     magnolia-image-recognition-api

Provides the Java API for image recognition service implementations.

     magnolia-image-recognition

Provides the Magnolia integration, delegating to the chosen/provided service.

     magnolia-amazon-image-recognition

Provides functionality to recognize images via Amazon Rekognition.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.ai.image</groupId>
  <artifactId>magnolia-image-recognition</artifactId>
  <version>2.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
<dependency>
  <groupId>info.magnolia.ai.image</groupId>
  <artifactId>magnolia-content-tags-integration</artifactId>
  <version>2.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
<dependency>
  <groupId>info.magnolia.ai.image</groupId>
  <artifactId>magnolia-image-recognition-api</artifactId>
  <version>2.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.
<dependency>
  <groupId>info.magnolia.ai.image</groupId>
  <artifactId>magnolia-amazon-image-recognition</artifactId>
  <version>2.0.0</version> (1)
</dependency>
1 Should you need to specify the module version, do it using <version>.

Set the service provider

Set the service provider in /image-recognition/config.yaml.

/image-recognition/config.yaml
currentService: info.magnolia.ai.image.amazon.AmazonImageRecogniser
Property Description

currentService

required, default is `info.magnolia.ai.image.amazon.AmazonImageRecogniser`

The class name of the service to be used.

Options:

  • info.magnolia.ai.image.amazon.AmazonImageRecogniser

Amazon Rekognition service configuration

This section lists the prerequisites for using Magnolia with Amazon Rekognition Image recognition service.

To use Amazon Rekognition, you must configure the currentService property as described in Set the service provider.

AWS service permissions

First, make sure that you have acquired appropriate permissions for the service in the Amazon IAM Management Console:

AWS users summary page

Access keys

You need an AWS secret access key to access the service. Access keys consist of two parts:

  • Access Key ID

  • Secret Access Key

  1. Generate the key in the security credentials section of the Amazon IAM Management Console.

  2. Add the two parts of the key to your Magnolia instance in the Passwords app using the following names:

    aws-credentials

    aws_access_key_id

    aws_secret_access_key

For more information about the key, see Understanding and Getting Your Security Credentials.

AWS Foundation password manager

The magnolia-aws-foundation-password-manager dependency is necessary if you want to use the Password Manager module to store your AWS credentials.

To do this:

  1. Go to your webapp.

  2. Add the following to your webapp’s pom.xml file as a dependency:

    <dependency>
        <groupId>info.magnolia.aws.foundation</groupId>
        <artifactId>magnolia-aws-foundation-password-manager</artifactId>
        <version>${awsFoundationVersion}</version> (1)
    </dependency>
    1 Where this is the latest compatible version needed for your webapp. As of 2024-07-22, the latest available version is 1.0.4.

Region name

You need to know a region name to configure the Amazon Rekognition Image service in Magnolia. To reduce data latency, AWS offers several regional endpoints. Each of the endpoints can be referred to in service configurations by a region name, for example eu-west-1.

For more information, see Amazon’s AWS Regions and Endpoints page.

If you pick a region that doesn’t support this service, you may get erratic results.

Configuration options

In version 1.1 of this module, the configuration was JCR-based. Since version 1.2, we’ve completely removed the JCR-based configuration and any existing configuration won’t be taken into account.

Make sure you replace your configuration with the config.yaml file.

Under /amazon-image-recognition/config.yaml, you must configure the following properties for the recognition service:

region:
  name: your_aws_region_name
maxLabels: 10
minConfidence: 50
supportedFormats:
  png: png
  jpg: jpg
  jpeg: jpeg

Properties

Property Description

region name

required

Label designating a regional endpoint to which the image recognition service connects, such as eu-west-1.

For a list of available regions and labels, see AWS: Regional endpoints.

maxLabels

required, default is 10

The maximum number of tags you want the recognition service to return.

This is an integer and the minimum value is 0.

If 0 is used, no tag would be assigned to an image asset.

minConfidence

required, default is `50`

The confidence score of recognition.

The Amazon Rekognition service returns a confidence score for each image tag. Image tags with a recognition confidence lower than the value of the minConfidence property are dropped.

supportedFormats

required, default are png, jpg, jpeg

A list of image formats defining which image types are automatically recognized by the image recognition service.

The Amazon Rekognition service currently supports only two image formats: JPEG/JPG and PNG.

Be aware that the Amazon Rekognition service has several service limits which may influence the performance of the recognition process. For more information, see Guidelines and quotas in Amazon Rekognition.

Parallel recognition threads

Image recognition can be a very intensive process in terms of CPU resources. One of the functions of our implementation of image recognition is that the recognition process can be delegated to several parallel threads. With more threads working you can obtain the results faster.

You can specify the number of parallel image recognition threads for the image recognition service provided by the image-recognition-api submodule. Set the number in the magnolia.properties configuration file through a Magnolia property called magnolia.image.recognition.numberOfThreads.

Example
magnolia.image.recognition.numberOfThreads=3 (1)
1 Sets three recognition threads. If the property isn’t set in the file, the default number of threads used by the system is 1.

Using other image recognition solutions

You can implement another image recognition solution or integrate your app with another third-party image recognition solution using the info.magnolia.ai.image.ImageRecogniser interface provided by the image-recognition-api submodule:

    /**
     * Takes image bytes as parameter and returns a {@link Collection collection}
     * of {@link ImageLabel Image label}s as output.
     *
     * <p>
     * Returns empty collection for the cases below:
     * <li>Upon exception</li>
     * <li>Image couldn't be recognized</li>
     * </p>
     */
    Collection<ImageLabel> recognise(byte[] imageBytes);

Recognizing images

The image recognition and tagging action is executed during the startup of the author instance and every time you upload a new image asset.

You can also trigger the action manually in the Assets app by selecting one or more assets and clicking the Run recognition action.

Images that have already been tagged are marked as such using a JCR property called lastTaggingAttemptDate. Executing the manual Run recognition action forces a new tag to be set even if the image was previously tagged.

The image recognition feature is available only on author instances.

Removing tags

Once an image has been tagged, you can remove some or all of the tags by selecting the asset and clicking the Modify tags action in the Assets app.

In the dialog box that opens, you can remove individual tags or click Remove all tags.

Related topics
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules
6.3 beta
X

Magnolia 6.3 beta

Magnolia 6.3 is in beta. We are updating docs based on development and feedback. Consider the 6.3 docs currently in a state of progress and not final.

We are working on some 6.3-beta known issues during this phase.