Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

These endpoints are the ones which is used in the automation config further down.

Info

Please be aware that 5.8+ have a different URL so go find the right base URL here: Digizuite™ AI Services or ask R&D. But client id and code will be the same.

Type

Endpoint

Input

Functionality

Output

Ximilar AI

https://dgz-integration-broker{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=ximilaraiservice&assetId=<assetid>&code={SECRET_CODE}

Info

Since this is custom categories it requires a workshop to define categories and get images which corresponds to those categories for training the AI model.

  • clientId: provided by Digizuite

  • integrationType: ximilaraiservice

  • code: provided by digizuite

Sends image for tagging at ai service and returns tags.

Returns

Code Block
interface DigizuiteTagResponse {
   status: string; // from ai service
   errorMessage: string; // from ai service
   tags: DetectTagObject[];
}

interface DetectTagObject {
   prop: number;
   name: number;
   id: number;
}

Ximiar Fashion Tagging AI

https://dgz-integration-broker{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=ximilargenericaiservice&assetId=<assetid>&code={SECRET_CODE}

  • clientId: provided by Digizuite

  • integrationType: ximilargenericaiservice

  • code: provided by digizuite

Sends image for tagging at ai service and returns tags.

Returns

Code Block
interface DigizuiteTagResponse {
   status: string; // from ai service
   errorMessage: string; // from ai service
   tags: DetectTagObject[];
}

interface DetectTagObject {
   prop: number;
   name: number;
   id: number;
}

Ximiar Fashion Tagging AI

https://dgz-integration-broker{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=ximilarfashionaiservice&assetId=<assetid>&code={SECRET_CODE}

  • clientId: provided by Digizuite

  • integrationType: ximilarfashionaiservice

  • code: provided by digizuite

Sends image for tagging at ai service and returns tags.

Returns

Code Block
interface DigizuiteTagResponse {
   status: string; // from ai service
   errorMessage: string; // from ai service
   tags: DetectTagObject[];
}

interface DetectTagObject {
   prop: number;
   name: number;
   id: number;
}

Inscene AI

https://dgz-integration-broker{URL-DEPENDING-ON-DAM-VERSION-AND-LOCALE}-us.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=insceneaiservice&assetId=<assetid>&code={SECRET_CODE}

** Be aware here that Inscene AI is only supported in the US. So therefore it has its own URL (dgz-integration-broker{URL-DEPENDING-ON-DAM-VERSION}-us).

  • clientId: provided by Digizuite

  • integrationType: insceneaiservice

  • code: provided by digizuite

Code Block
interface DigizuiteTagResponse {
   status: string; // from ai service
   errorMessage: string; // from ai service
   tags: DetectTagObject[];
   subTags: DetectTagObject[]; // only for Inscene AI
   objects: DetectSubObject[]; // only for Inscene AI
}

interface DetectTagObject {
   prop: number;
   name: number;
   id: number;
}

interface DetectSubObject {
   prop: number;
   name: number;
   id: number;
   subObjects: DetectTagObject[];
}

Imagga Tagging AI

https://dgz-integration-broker.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=ImaggaTaggingService&assetId=<assetid>&code={SECRET_CODE
}
  • clientId: provided by Digizuite

  • integrationType: ImaggaTaggingService
  • code: provided by digizuite

  • Sends image for tagging at ai service and returns tags.

    Returns

    Code Block
    interface DigizuiteTagResponse {
       status: string; // from ai service
       errorMessage: string; // from ai service
       tags: DetectTagObject[];
    }
    
    interface DetectTagObject {
       prop: number;
       name: number;
       id: number;
    }

    Configuration

    The following shows a starting point for your integration.

    ...

    Code Block
    trigger "Metadata trigger" {
        type = "Specific Metadata Value"
        resolves = "Set String Metafield"
        value = "#54a0ff;creative"
        ignore_casing = "true"
        meta_field = "guid:6fe35f10-c810-497b-af9c-e52c3d583593"
        listen_to_metadata_changes = "all"
    }
    
    action "Invoke Endpoint" {
        type = "Invoke Endpoint"
        endpoint = "https://dgz-integration-broker{URL-DEPENDING-ON-DAM-VERSION}.azurewebsites.net/api/integrations/asset/invoke?clientId={SECRET_CLIENT_ID}&integrationType=ximilaraiservice&assetId=<assetid>&code={SECRET_CODE}"
        method = "post"
        response = "@response"
    }
    
    action "Get Value At Index" {
        type = "Get Value At Index"
        needs = "Invoke Endpoint"
        values = "@response"
        index = "0"
        result =
    "@firstInArray"
    }
    
    action "Query JSON" {
        	type = "Query JSON"
        	needs = "Get Value At Index"
        Invoke Endpoint"
    	json = "@firstInArray@response"
        	json_path = "$.result.tags[*].name"
        	error_on_not_found_items = "true"
        	result = "@queryResult"
    }
    
    action "Set String Metafield" {
        type = "Set String Metafield"
        needs = "Query JSON"
        meta_field = "guid:7441267e-4f7c-4dcd-9c42-20273a4ab6af"
        new_value = "@queryResult"
        asset_item_ids = "@sourceAssetItemId"
    }

    ...