MS Azure Custom Tags

For the most up-to-date documentation, please visit docs.brix.ch

Advanced-UI No UI

With the MS Azure Custom Tags extension you can train a custom end point using the Azure GUI specifically developed for this task. This end point is then used by this plugin to tag assets with the trained custom tags.

Important: If the name of a tag is changed in the training application, then the tag has to be renamed manually in CELUM too (default language only).

Properties

To be configured in {home}/appserver/conf/custom.properties

azureCustomVision.license

type: string, required: yes, default: -

The license key for the plugin (product: azureCustomVision), provided by brix.

azureCustomVision.allowedUserGroupIds

type: comma-separated list of user group ids, required: no, default: -

The user group ids which are allowed to use this extension (superadmins are always entitled).

azureCustomVision.threads

type: integer, required: no, default: 5

The number of threads in the thread pool, that are processing the asset changes and initiating the automated tagging, has to be >= 2.

azureCustomVision.debounceTimeInSeconds

type: integer, required: no, default: 10

The debounce time in seconds. E.g. 10 means that for 5s, all changes that happen on an asset are collected and then processed at once. This has the advantage that if 10 relevant changes happen one after another within an interval of 5s, cognitive services are still only asked once and not 10 times.

azureCustomVision.url

type: url, required: yes, default: -

URL to the custom end point. On the Azure Training GUI, go to Performance > Prediction URL and copy the shown URL under the title If you have an image URL.

azureCustomVision.key

type: string, required: yes, default: -

The prediction key. On the Azure Training GUI go to Performance > Prediction URL and copy the prediction key.

azureCustomVision.tagsInfoFieldId

type: integer, required: yes, default: -

The id of the node reference information field for the tags.

azureCustomVision.tagsThreshold

type: double, required: no, default: 0.5

Only apply tags with a probability (a number between 0 and 1) >= the threshold.

azureCustomVision.contextMenu

type: boolean, required: no, default: true

Whether the context menu should be available (for the allowed user groups) or not. Restart required.

azureCustomVision.automate

type: boolean, required: no, default: false

Whether images should be tagged automatically or not. Restart required.

type: string, required: no, default: -

Search expression, only tag images within the scope (for automation and initialize task).

azureCustomVision.search.userId

type: integer, required: no, default: api-user

User id of the user to perform the search with (only assets visible to this user will be found).

azureCustomVision.tags.partition.threshold

type: integer, required: no, default: 100

Nodes are partitioned if the number of children in a node (which are not intermediate nodes) becomes greater than the threshold. That way, the GUI doesn't freeze if you try to open the tag tree. A number <= 0 prevents the partitioning.

Installation

  1. Get a license from brix
  2. Register for custom vision (Custom Vision)
  3. Upload and tag images (getting started)
  4. Train and publish the images to get the URL and key (more information: test your model or improve your model)
  5. Add the information field and configuration to the custom.properties file, put the jar file into the lib folder and restart the CELUM app server

Compatibility Matrix

MS Azure Custom Tags CELUM
1.0.0 6.4 (tested with 6.8)

Release Notes

1.0.0

Released 2021-03-23

Initial version