Base URL Support for Image Indexing

Overview

This feature introduces a configurable Base URL system parameter, enabling proper indexing and referencing of image URLs hosted on domains different from the website domain. It ensures accurate image loading and successful Visual/Image Search embedding generation.

Purpose

  1. Allow clients to specify an alternative domain (Base URL) for image assets.
  2. Ensure relative image URLs are automatically converted to fully qualified URLs during indexing.
  3. Enable accurate embedding creation for Visual/Image Search, which requires complete and accessible image URLs.

Field Configuration

Workbench

  1. New Toggle: Prepend Base URL
  2. Purpose: Determines if the Base URL (stored in system parameter) should be prepended to image values stored in this field.
  3. Location: Workbench > Data Configuration > Fields > Add/Edit Field
  4. Options:
    1. ON (Relative URL): System will prepend the Base URL during indexing.
    2. OFF (Absolute URL): System will index the URL as-is.
  5. Default: OFF (Assumes absolute URL)

Dashboard API

To configure this setting via Dashboard API, include the following in the filed object:

"IsPrependBaseUrl": true

Impact of Base URL to Visual/Image Search

Visual Search embeddings are created during indexing. These embeddings require a valid, full image URL:

Indexed Image URLPrepend Base URL Setting
(Workbench/API)
Base URL Value Configured
(system parameter)
Resulting URL StatusImpact on Visual Search
Complete URLONYES*Invalid URL.

Base URL is prepended incorrectly
Image URL may cause Visual Search embedding failures
Complete URLONNOValid URL.

Image URL remain unchanged.
Ensures the image URL does not cause Visual Search embedding failures
Complete URLOFFYES*Valid URL.

Image URL remain unchanged.
Ensures the image URL does not cause Visual Search embedding failures
Complete URLOFFNOValid URL.

Image URL remain unchanged.
Ensures the image URL does not cause Visual Search embedding failures
Relative URLONYES*Valid URL.

Base URL is prepended correctly.
Ensures the image URL does not cause Visual Search embedding failures
Relative URLONNOInvalid URL.

Base URL is not prepended
Image URL may cause Visual Search embedding failures
Relative URLOFFYES*Invalid URL.

Base URL is not prepended
Image URL may cause Visual Search embedding failures
Relative URLOFFNOInvalid URL.

Base URL is not prepended
Image URL may cause Visual Search embedding failures

*YES: (assuming the value entered for Base URL is correct)

Key Notes for Visual Search

  1. Embeddings will not be created if the URL is invalid or incomplete.
  2. Always ensure:
    1. The Base URL is set (if using relative URLs)
    2. The Prepend Base URL toggle is ON for image fields with relative URLs
  3. No change is needed if you already use absolute image URLs.