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
- Allow clients to specify an alternative domain (Base URL) for image assets.
- Ensure relative image URLs are automatically converted to fully qualified URLs during indexing.
- Enable accurate embedding creation for Visual/Image Search, which requires complete and accessible image URLs.
Field Configuration
Workbench
- New Toggle: Prepend Base URL
- Purpose: Determines if the Base URL (stored in system parameter) should be prepended to image values stored in this field.
- Location: Workbench > Data Configuration > Fields > Add/Edit Field
- Options:
- ON (Relative URL): System will prepend the Base URL during indexing.
- OFF (Absolute URL): System will index the URL as-is.
- 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 URL | Prepend Base URL Setting (Workbench/API) | Base URL Value Configured (system parameter) | Resulting URL Status | Impact on Visual Search |
---|---|---|---|---|
Complete URL | ON | YES* | Invalid URL. Base URL is prepended incorrectly | Image URL may cause Visual Search embedding failures |
Complete URL | ON | NO | Valid URL. Image URL remain unchanged. | Ensures the image URL does not cause Visual Search embedding failures |
Complete URL | OFF | YES* | Valid URL. Image URL remain unchanged. | Ensures the image URL does not cause Visual Search embedding failures |
Complete URL | OFF | NO | Valid URL. Image URL remain unchanged. | Ensures the image URL does not cause Visual Search embedding failures |
Relative URL | ON | YES* | Valid URL. Base URL is prepended correctly. | Ensures the image URL does not cause Visual Search embedding failures |
Relative URL | ON | NO | Invalid URL. Base URL is not prepended | Image URL may cause Visual Search embedding failures |
Relative URL | OFF | YES* | Invalid URL. Base URL is not prepended | Image URL may cause Visual Search embedding failures |
Relative URL | OFF | NO | Invalid 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
- Embeddings will not be created if the URL is invalid or incomplete.
- Always ensure:
- The Base URL is set (if using relative URLs)
- The Prepend Base URL toggle is ON for image fields with relative URLs
- No change is needed if you already use absolute image URLs.
Updated 14 days ago