Overview
Label Properties allow you to configure and customize individual label instances in documents. When you apply a label to text in a document, you can set properties that define how that specific label behaves, what data it captures, and how it integrates with models and assistants.
What are Label Properties?
Label Properties are configurable attributes attached to label instances:
Instance-specific - Each label instance can have different property values
Defined in Data Definition - Available properties come from the label's data element configuration
Editable in Workspace - Set properties while labeling documents
Model integration - Additional properties from models and assistants
Dynamic behavior - Properties control how labels are processed
Example use case: You label an "invoice_number" field in a document. The label's properties might include confidence threshold, extraction method, validation rules, or custom metadata specific to this invoice.
Accessing Label Properties
In the Workspace
Open a document in the Workspace
Apply or select a label in the document
The Label Properties panel opens on the right
View and edit properties for the selected label
The Label Properties Panel
The panel displays:
No labels selected state - Message prompting you to select a label
Selected label dropdown - Choose which label instance to view when multiple labels are selected
Label properties - Configured options for the selected label
Model/Assistant properties - Additional properties from integrated models and assistants
Types of Properties
Base Properties
Properties defined in the label's data element configuration:
Data capture - How to extract value from labeled text
Validation rules - What constitutes valid data
Transformation - How to format or process the value
Confidence settings - Thresholds for AI extraction
Custom metadata - Application-specific properties
Model and Assistant Properties
Additional properties provided by models and assistants:
Model-specific parameters - Configuration for AI models
Extraction hints - Guidance for AI extraction
Processing options - How assistants handle this label
Integration settings - External system connections
Working with Label Properties
Viewing Properties
Select a label in the document
Label Properties panel shows available properties
Properties display with current values
Each property shows its name, type, and current setting
Editing Properties
Click on a property field
Enter or select the new value
Changes save automatically
Updated values apply to this label instance only
Multiple Label Instances
When you select multiple labeled regions:
Use the dropdown to choose which label instance to view
Each instance maintains its own property values
Switch between instances to edit their properties individually
Common Property Types
Configuration Option Component
Properties use the ConfigurationOption component which supports:
Text inputs - Free-form text entry
Numeric inputs - Number values with validation
Dropdowns - Select from predefined options
Checkboxes - Boolean true/false values
Text areas - Multi-line text input
Custom controls - Specialized input types
Property Data Storage
Property values are stored in the label's tagData:
tagData.data - Stores property values
Per-instance - Each label instance has its own tagData
Persistent - Saved with the document
Accessible - Available to models and assistants
Defining Properties in Data Definitions
Taxon Options
Properties are defined in the data element's configuration:
Navigate to Data Definition editor
Select the data element (taxon)
Configure options that will appear as label properties
Each option defines a property users can set
Property Configuration
When defining a property option:
Name - Internal identifier for the property
Label - Display name shown to users
Type - Data type (text, number, boolean, etc.)
Default value - Initial value for new labels
Validation - Rules the value must satisfy
Help text - Guidance for users
Model and Assistant Integration
Additional Taxon Options
Models and Assistants can provide additional properties:
Properties appear in a separate section
Organized by model/assistant name
Use tabs or buttons to switch between sources
Each source can define its own set of properties
When to Use Model Properties
AI model requires specific parameters
Assistant needs configuration per label
External integration requires metadata
Processing logic depends on label-specific settings
Workflow Integration
During Labeling
User applies label to document text
Label Properties panel opens automatically
User sets relevant properties for this instance
Properties guide AI extraction and processing
During Review
Reviewer selects label to examine
Reviews property values
Adjusts properties if needed
Changes affect how label is processed
During Processing
Models and Assistants read label properties
Properties influence extraction algorithms
Validation uses property-defined rules
Output formatting follows property settings
Best Practices
Meaningful defaults - Set sensible default values for properties
Clear labels - Use descriptive property names and help text
Minimal properties - Only expose properties users need to change
Validation - Prevent invalid property values
Consistent naming - Use similar property names across related labels
Document purpose - Explain what each property does
Test with users - Verify properties make sense to labelers
Organize logically - Group related properties together
Common Scenarios
Confidence Threshold Property
Scenario: Allow users to set minimum confidence for AI extraction
Property configuration:
Name: "confidenceThreshold"
Label: "Minimum Confidence"
Type: Number (0-1)
Default: 0.8
Help: "AI must be at least this confident to extract value"
Extraction Method Property
Scenario: Let users choose how to extract value from labeled text
Property configuration:
Name: "extractionMethod"
Label: "Extraction Method"
Type: Dropdown
Options: ["Text Only", "Include Formatting", "Normalized"]
Default: "Text Only"
Custom Metadata Property
Scenario: Store application-specific information with label
Property configuration:
Name: "category"
Label: "Document Category"
Type: Dropdown
Options: ["Standard", "Priority", "Archive"]
Used by: Custom processing logic
Empty State
No Labels Selected
When no labels are selected in the document:
Panel shows empty state message
Icon and text: "No labels selected"
Instructions: "Select a label in the document to see properties"
Link to documentation about label properties
User Action Required
To view properties:
Click on an existing label in the document, OR
Apply a new label to text in the document
Properties panel updates automatically
Advanced Features
Dynamic Property Visibility
Properties can show/hide based on conditions:
Only display when relevant to current context
Hide based on other property values
Show different properties for different label types
Property Dependencies
Properties can depend on each other:
One property's options determined by another's value
Validation rules that reference multiple properties
Calculated properties based on other values
Bulk Property Updates
While the UI shows one label at a time:
Backend can support bulk updates via API
Useful for applying same properties to multiple labels
Maintains data consistency across similar labels
Troubleshooting
Properties Not Showing
Verify label is selected in document
Check data element has options configured
Ensure Label Properties panel is open
Refresh workspace if properties recently added
Cannot Edit Property
Check user permissions for editing labels
Verify property is not read-only
Ensure document is not locked
Check if workflow restricts editing
Changes Not Saving
Check network connection
Verify validation rules are passing
Ensure value is in correct format
Check browser console for errors
Model Properties Missing
Verify model/assistant is connected to project
Check model provides additional taxon options
Ensure model is active and not in error state
Refresh workspace to reload model properties
Tips
Select label in document to view its properties
Each label instance can have different property values
Properties are defined in the Data Definition
Models and Assistants can add additional properties
Use dropdown to switch between multiple selected labels
Changes save automatically as you edit
Properties guide AI extraction and processing
Keep property lists focused on what users actually need to change
Use clear names and help text for better user experience
Test property configurations with real labeling workflows