The Automatic Tagging module of the Cumulus Server Console or Web Server Console is available if either a Cumulus Automatic Tagging OEM license, or an Automatic Tagging license, is activated via the Remote Admin module of the Cumulus (Web) Server Console.
The Automatic Tagging module looks different depending on whether a Cumulus Automatic Tagging OEM license is activated, or an Automatic Tagging license.
In both cases, the set up includes the configuration of the fields into which the tags will be written, the fill mode, the log level, the user’s credentials, and the specification of the probability threshold. The Automatic Tagging set up additionally requires the selection of a default tagging provider.
Automatic Tagging only works with fields of type string, multi-select string list, multi-select vocabulary, and with the Categories field (under $Keywords master category).
NOTE: For multi-select string list fields, multi-select vocabulary fields, and the Categories field only such tags are accepted that correspond to values that already exist in the catalog. For example, if the tagging service returns the tag “urban” for an image, this asset would be assigned to an already existing category “urban” (under $Keywords master category). However, if such a category does not exist, this tag would be ignored.
Configuration Settings for the Cumulus Automatic Tagging OEM
The Automatic Tagging module of the Cumulus Server Console or Web Server Console provides two panes, General and Automatic Tagging Providers.
Modifications to the configuration settings must be explicitly saved in order to take effect.
General
The General pane provides the following items:
• Fields – table that lists the fields into which the tags found by Cumulus Automatic Tagging OEM are written, and the fill mode for each field. You can add more fields from your catalog(s), you can remove fields from the list, and you can edit the fill mode for each field.
For string fields, the following fill modes are available:
• Replace
• Set if Empty
• Insert After
• Insert Before
For multi-select string list fields, multi-select vocabulary fields, and the Categories field, the following fill modes are available:
• Replace
• Set if Empty
• Add
• Logging Level – list to select the level of messages that shall be logged. Possible levels are
• Error
• Warning
• Information
Cumulus
The Cumulus pane provides fields for the login credentials that must be entered. Additionally, a probability threshold value can be set.
• ClientID – account credential)
• Client Secret – account credential
• Probability Threshold [%] –Cumulus Automatic Tagging calculates the probability of the tags they find. The less this value is set to, the more tags are found, but the less is their potential accuracy. The default value of 80% is a good starting point to find the most suitable value.
NOTE: After adding a the Cumulus Automatic Tagging to your Cumulus system, the Cumulus Scheduler must be restarted in order to make the Automatic Tagging Scheduler action available.
Configuration Settings for Automatic Tagging
The Automatic Tagging module of the Cumulus Server Console or Web Server Console provides two panes, General and Automatic Tagging Providers.
Modifications to the configuration settings must be explicitly saved in order to take effect.
General
The General pane provides the following items:
• Fields – table that lists the fields into which the tags found by the tagging provider are written, and the fill mode for each field. You can add more fields from your catalog(s), you can remove fields from the list, and you can edit the fill mode for each field.
For string fields, the following fill modes are available:
• Replace
• Set if Empty
• Insert After
• Insert Before
For multi-select string list fields, multi-select vocabulary fields, and the Categories field, the following fill modes are available:
• Replace
• Set if Empty
• Add
• Logging Level – list to select the level of messages that shall be logged. Possible levels are
• Error
• Warning
• Information
• Provider for Automatic Tagging – your Automatic Tagging provider of choice, selected from the drop-down list of available providers.
Automatic Tagging Providers
The Automatic Tagging Providers pane provides several tabs, one for each provider supported by Cumulus. The login credentials required by a provider – ClientID and Client Secret, or API Key – must be entered. Additionally, a probability threshold value can be set. For details about the required credentials and other provider-specific information, refer to the documentation of the respective Automatic Tagging provider.
• API Key – account credential (depending on the selected provider)
• ClientID – account credential (depending on the selected provider)
• Client Secret – account credential (depending on the selected provider)
• Probability Threshold [%] – Automatic Tagging services calculate the probability of the tags they find. The less this value is set to, the more tags are found, but the less is their potential accuracy. The default value of 80% is a good starting point to find the most suitable value.
• Model – Select a (custom) model to be used for tagging (depending on the selected provider). Note that the language selection below only works with the standard model (“General”), and is deactivated if any other model is selected.
• Languages – languages for Automatic Tagging (depending on the selected provider). The Automatic Tagging is performed in the configured language. If multiple languages are configured, all selected languages are processed in parallel. If no language is configured, English is used as the fall back language
For Automatic Tagging working properly with multiple languages, the target metadata field must be set to multi-lingual. Otherwise, only the first of the configured languages would be taken into account.
NOTE: After adding a new Automatic Tagging provider to your Cumulus system, the Cumulus Scheduler must be restarted in order to make the Automatic Tagging Scheduler action available to the newly added service.