Auto Tagging Text

With asset auto tagging enabled, you can also configure text auto tagging. Text auto tagging automatically tags text-based assets. This lets you use tags without requiring anyone to manually apply them.

Note: Currently, text auto tagging is only available for text-based documents, text-based web content, and blog entries. Tags applied automatically are English only.

Text auto tagging is disabled by default. To use it, you must enable it:

1. Ensure that asset auto tagging is enabled. Although it’s enabled by default, administrators can disable it.

2. Ensure that a text auto tagging provider is configured and enabled for the asset types you want to auto tag. You’ll learn how to do this here. Note that these providers aren’t configured or enabled by default.

Note: Prior to Liferay DXP Fix Pack 1 and Liferay Portal CE GA2, you must enable these providers separately for each content type in System/Instance Settings. For example, you must enable text auto tagging for documents and web content in Documents and Media and Web Content, respectively.

There are two text auto-tagging providers in the portal:

Google Cloud Natural Language Text Auto Tagging: Uses the Google Cloud Natural Language API to analyze and automatically tag portal content.

OpenNLP Text Auto Tagging: Uses the open source Apache OpenNLP library to analyze and automatically tag portal content. Three models are used: location name finder, organization finder, and person name finder. Use this provider with caution, as its accuracy may be limited.

Configuring Google Cloud Natural Language Text Auto Tagging

Follow these steps to configure the auto-tagging provider for the Google Cloud Natural Language API:

1. Go to Control Panel → Configuration → System Settings → Assets.

2. Under VIRTUAL INSTANCE SCOPE, select Google Cloud Natural Language Text Auto Tagging. The following settings are available:

   API Key: The API key to use for the Google Cloud Natural Language API. For more information, see Google’s documentation on API keys.

   Classification Endpoint Enabled: Whether to enable auto tagging of text using the Google Cloud Natural Language API Classification endpoint.

   Confidence: Set the classifier’s confidence of the category. This number represents how certain the classifier is that this category represents the given text.

   Entity Endpoint Enabled: Whether to enable auto tagging of text using the Google Cloud Natural Language API Entity endpoint.

   Salience: The salience score for an entity provides information about the importance or centrality of that entity to the entire text.

   Enable Google Cloud Natural Language Text Auto Tagging For: The asset types to enable text auto tagging for. Use the menu to select Document, Blogs Entry, or Web Content Article. To add multiple asset types, click the Add icon () and select the asset type from the menu. You can delete any additional asset types by clicking the Trash icon ().

3. Click Save to save your changes.

You can override these settings for each instance from Control Panel → Configuration → Instance Settings → Assets.

Figure 1: Configure Google Cloud Natural Language text auto tagging for your portal instances.

Configuring OpenNLP Text Auto Tagging

Follow these steps to configure the OpenNLP Text Auto Tagging provider:

1. Go to Control Panel → Configuration → System Settings → Assets.

2. Under VIRTUAL INSTANCE SCOPE, select OpenNLP Text Auto Tagging. The following settings are available:

   Confidence Threshold: Set the minimum confidence threshold (from 0 to 1, where 1 is the highest confidence) above which tags will be applied. Higher values yield fewer tags because the provider needs more confidence before it applies a tag. Likewise, lower values yield more tags.

   Enable OpenNLP Text Auto Tagging For: The asset types to enable text auto tagging for. Use the menu to select Document, Blogs Entry, or Web Content Article. To add multiple asset types, click the Add icon () and select the asset type from the menu. You can delete any additional asset types by clicking the Trash icon ().

3. Click Save to save your changes.

You can override these settings for each instance from Control Panel → Configuration → Instance Settings → Assets.

Figure 2: Configure OpenNLP text auto tagging for your portal instances.