๐ Description
The Image Validation task is designed to validate whether an image meets the criteria defined in a custom Validation Prompt. The validation applies to images contained in the field identified by the field key.
The Field Key is a unique identifier for each field within a template. The field key can be found within the template configuration (see: Adding & Editing Fields: Field Key), or by hovering over the field name in the project page (see: Field Information: Field Key and Last Updated). Field keys are case sensitive and must match exactly in any use case.
๐ฏ When to Use This Task
Use this task when you need to:
- Ensure images follow specific quality, content, or contextual rules
- Enforce project-wide image requirements
- Validate based on instructions defined in a custom prompt
๐ ๏ธ Accessing the Task
Users can either edit an existing Image Validation task or create a new one.
- Select an existing Image Validation task to edit, OR
- Create a new Image Validation task
In both scenarios, the same modal will open.
๐งฉ Required Fields & Inputs
1. Task Name (required)
- User specifies the name of the image validation task
2. Fields (required)
An Image Validation task can run on one field or on many fields at once. The validation is executed on images within each selected field.
- Click Browse Fields in the task modal
- Check the box next to each field you want to validate. Check a group header to select every field in that section, or use Select All to select every field in the list
- Use the search box to filter the list. Selecting all while a search is active selects only the fields currently shown โ fields you selected earlier stay selected
- The number of fields selected is shown as you go
- Click Select to save your selection
[SCREENSHOT 4.1] Browse Fields selector: checkboxes, a checked group header, the Select All row, and the "N fields selected" counter. Place after step 5.
The fields you chose are listed in the task modal. To add or remove fields, open Browse Fields again and adjust your selection.
[SCREENSHOT 4.2] Edit Image Validation modal showing the list of currently selected fields beneath the Browse Fields button. Place after the paragraph above.
How multi-field validation runs: the Validation Prompt and options (field description, example photo, evaluate as collection) are applied to each selected field individually, using that fieldโs own description, example photo, and images.
3. Validation Prompt (required)
- A text area where the user specifies validation rules
- The prompt determines the logic executed during validation
๐พ Saving the Task
The Save button is only enabled when all required fields are filled out:
- Validation Name
- Field Key
- Validation Prompt
After clicking Save:
- The task is stored
- The modal closes
๐ Summary
The Image Validation task provides a simple and effective way to validate images based on custom prompts. By specifying a field key and defining validation rules, users gain fine-grained control over which images are validated and how the criteria are applied.
Comments