📝 Description
The Multi-field Validation task allows users to configure and run validations across multiple fields. This includes evaluating both data and images from selected fields using a custom validation prompt. All results are saved into the primary field specified by the user.
🎯 When This Task Is Used
Use this task type when you need to:
- Validate relationships between multiple fields
- Validate combined text and image data
- Generate structured validation output into a specific field
🛠️ Accessing the Task
You can enter the configuration modal by:
- Editing an existing Multi-field Validation task, OR
- Creating a new Multi-field Validation task
Both actions open the same configuration modal.
🏷️ Required Fields & Inputs
Users must configure several fields before saving:
1. Task Name (required)
- Defaults to "Multi-field Validation Task"
- Users may edit this name
2. Primary Field Key (required)
- This is the field key that will store the final validation results
- The field key can be selected by clicking on "Browse"
- Use the browse function to select the field key. The field key you select must have an associated Text Extraction task created for this to run successfully.
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.
3. Additional Image Field Key (required)
- At least one additional image field key must be specified
- The field key selected must have an associated Text Extraction task created for this to run successfully
- Users can:
- Add more additional fields (each requires its own field key)
- Delete previously added additional fields
- Use browse to select the image field key
4. Validation Prompt (required)
- This prompt guides the logic used during validation
- Users enter text in a multi-line text area
💾 Saving the Task
The Save button becomes enabled only when all required fields are completed:
- Validation Name
- Primary Field Key
- At least one Additional Field Key
- Validation Prompt
Once the user clicks Save:
- The task is saved
- The modal closes
📌 Summary
The Multi-field Validation task provides a flexible and powerful way to run custom validations across multiple fields. By configuring field keys and crafting a rich validation prompt, users can efficiently evaluate complex data relationships and store results in a structured way.
Comments