Skip to main content
Documentation & User Guides | Fotoware

Configuring auto-tagging

Learn how to configure auto-tagging.

Auto-tagging can be configured as an action with an Execute webhook source or as an asset ingested webhook. Both use the same URL format to call auto-tagging, and configuration settings are provided as part of the URL in both cases. The webhook URL requires an autotag ID and secret, which Fotoware will provide. 

The system administrator can set the minimum confidence level for returned tags, the field in which auto-tagging results are stored, and the integration details on the webhook URL to make it fast and easy to maintain. You can experiment with the confidence setting to potentially return more accurate results.

 

Example URL:

https://fw-shared-mgt-api-apim.azure-api.net/integration/api/assets/analysis?confidence=0.6&showConfidence=true&languages=en,de,nb&features=Tags:en=820,nb=25|Brands:all=829|Faces:all=816|Text:all=850|
Description:en=817&autoTagId=clkjh2c8-b2e1-45c3-3159-08db9f189b36&autoTagSecret=ZZV0nC55XXMBMv51ij9o2MwToi0ZVgQKIx1UWi2ldduZMSWLP4I28ely7g2hgkj5gCiYcw23Gj2qov5M55hSNA~~

Note: Auto-tagging overwrites any content in the metadata fields, so make sure to choose fields that are only used for auto-tagging.  

URL parameter Description
autoTagId

A unique customer identifier for authentication. This is generated by Fotoware and is always the same for each customer integration. 

Mandatory field.

ExampleautoTagId=93b459c8-3803-48d0-fe50-08db77022734

autoTagSecret

This parameter pairs with autoTagId for authentication. 

ExampleautoTagSecret=BKWseamUlCyInNbTzDIXENOdCpTVVlelnFxo72CeTfIpuDGTeQFnei5Eg06yB4l2-43ZVyy3L-DbSIINHiUayA~~

confidence

The level of accuracy for the returned results. The processing will only return tags with a confidence higher than or equal to the value set.

Exampleconfidence=0.6

showConfidence

Include or do not include the confidence value in the tag texts.
Boolean (true/false)

ExampleshowConfidence=true

genderNeutralCaption

OPTIONAL

Captions do not contain gender terms ("man", "woman", "boy", and "girl") by default; these terms are replaced with “person” to obtain gender-neutral captions. Without this parameter, the default value is true, but you can change it to false to return results with gender when relevant.

Example: genderNeutralCaption=false

languages A comma-separated list of languages. Tags and other features will be returned in all selected languages. 

Examplelanguages=en,de,nb
features Lists the auto-tagging features that the customer wants to use and maps the results to a metadata field in Fotoware. 

Use the all assigner (as in the example below) to add data for all languages defined in languages into the same field.

Example:features=Tags:all=820|Description:all=200|Brands:all=829|Faces:all=880|Text:all=850

You can define each field separately to separate different languages into different fields in the metadata. In the following example, tags and description are separated into different metadata fields for English and Norwegian. Brands and text are not translated, so you use the all keyword for these.

Example:
features=Tags:en=820,nb=26|Description:en=200,nb=121|Brands:all=829|Faces:all=880|Text:all=850
version By default, the webhook targets version 3 unless otherwise specified. This means it is backward compatible. If you would like to use version 4, replace 3 with 4

Example:version=4

 

  • Was this article helpful?