Labeled Value

Can be one of the following types:

The 'Label Extractor' property determines how header labels are detected in the document.
Configure this property to match one or more variants of the field label, such as Admission Date, Date of Admission, or Intake Date.

If Label Sets are in use, this property may be left blank, allowing label definitions to be managed per document type.
When blank and no header label is defined in the Label Set, the extractor will not attempt to match header labels.

Configuration Guidance

• Use a Label Match or List Match extractor to capture all possible label variants present in your documents.
• For fields with multiple possible labels, include all expected variants in the extractor configuration.
• If your documents use different terminology for the same field, ensure all terms are covered.

Impact

• A well-configured label extractor increases extraction accuracy and reduces false positives.
• If the label extractor is too restrictive, some valid fields may not be detected.
• If too broad, unrelated text may be matched as labels, leading to incorrect value pairing.

Example

To extract an "Admit Date" field, configure the label extractor to match Admission Date, Date of Admission, and Intake Date.

For best results, test your configuration with representative document samples and review diagnostic logs for matched labels.

Can be one of the following types:

Configure the 'Value Extractor' to match the expected data value, such as a date, currency amount, or part number.
This extractor should be tailored to the format and type of value you wish to capture.

Configuration Guidance

• Use regular expressions, value lists, or other extractors as appropriate for your data type.
• For currency values, configure a pattern that matches currency formats (e.g., \$\d{1,3}(,\d{3})*(\.\d{2})?).
• For dates, use a pattern that matches all expected date formats in your documents.
• If the value may appear in multiple formats, include all variants in the extractor configuration.

Label Set Integration

When Label Sets are in use, this property may be left blank. If blank, the following rules apply:

• If a static label is defined, the static value will be output if present.
• If both header and footer labels are defined, the content between them will be output.
• If only a header is defined, the text segment to the right (or below, if none to the right) of the header will be output.

Impact

• A precise value extractor improves extraction accuracy and reduces noise.
• If the extractor is too broad, unrelated values may be captured.
• If too narrow, some valid values may be missed.

Example

To extract a currency value, configure the extractor to match $1,234.56, 1234.56, and USD 1234.56.

Review diagnostic logs to verify which values are matched and adjust the extractor as needed for optimal results.

Can be one of the following types:

The 'Footer Extractor' property is used as an alternative to the 'Value Extractor'.
Configure this property to match a label or artifact that marks the end of the field's data.

Configuration Guidance

• Use a Label Match or List Match extractor to identify footer labels, such as End Date, Total, or Signature.
• Footer extractors are especially useful for fields where the value is not easily matched by a regular expression, such as names or descriptions.
• If both header and footer labels are present, the extractor will capture the value between them.
• If only a footer is present, extraction may not occur unless a header or value extractor is also configured.

Impact

• Footer extractors help delimit the end of a value, preventing capture of unrelated text.
• If the footer extractor is too broad, it may match unintended labels, truncating the value prematurely.
• If too narrow, some valid footers may be missed, resulting in incomplete extraction.

Example

For a field capturing a description that ends with a "Signature" label, configure the footer extractor to match Signature and any common variants.

Test with sample documents to ensure the footer extractor reliably marks the end of the field value.

The 'Match Limit' property controls how many label-value pairs are evaluated.
Use this to improve performance on large documents with many repeated values.

Configuration Guidance

• Set to 1 to stop after the first successful match, useful for fields that only need a single value.
• Set to a higher value (such as 5 or 10) to allow for alternate candidates, but avoid unnecessary evaluation.
• For fields that may appear multiple times (such as line items), set the limit according to the expected number of occurrences.
• If left blank, all possible pairs will be evaluated, which may impact performance on very large documents.

Impact

• A lower match limit speeds up extraction and reduces resource usage.
• If set too low, some valid values may be missed, especially in documents with multiple occurrences.
• If set too high, performance may be affected, but all possible matches will be considered.

Example

On a 500-page invoice where the same invoice number appears on every page, set the match limit to 1 to extract only the first occurrence.

Review extraction results and adjust the match limit as needed to balance accuracy and performance.

The 'Maximum Distance' property defines the spatial limits for associating a value with its label.
Specify the maximum allowed distance (in logical units such as inches or millimeters) for each side: left, top, right, and bottom.

Configuration Guidance

• Use supported units (e.g., 2in, 10mm) for precise control.
• Adjust the left, top, right, and bottom values to match the expected layout of your documents.
• For tightly grouped label-value pairs, use smaller distances to prevent unrelated values from being paired.
• For layouts where values may appear further from labels, increase the distance as needed.

Impact

• A smaller maximum distance restricts pairing to closely grouped labels and values, improving accuracy.
• A larger distance allows for more flexible layouts but may increase the risk of incorrect pairings.
• If set too small, some valid pairs may be missed; if too large, unrelated values may be paired.

Example

For a field where the value always appears to the right of the label within 2 inches, set the right distance to 2in and others to 0in.

Test with sample documents and adjust the distances to optimize extraction for your specific layout.

The 'Maximum Noise' property controls tolerance for extraneous content in the bounding region enclosing both label and value.
Noise characters are letters or digits present in the region but not part of the label or value.
Punctuation, whitespace, and control characters are not counted as noise.

Configuration Guidance

• Set to 0 to require a clean region with no noise characters.
• Set to a higher value (such as 5) to allow for some extraneous content, useful in cluttered layouts.
• Adjust based on the typical amount of unrelated text present near your label-value pairs.

Impact

• A lower noise limit increases extraction precision but may exclude valid pairs in noisy documents.
• A higher limit allows for more flexible extraction but may increase the risk of incorrect pairings.
• If set too high, unrelated content may be included; if too low, valid pairs may be missed.

Example

In a document where fields are surrounded by other text, set the noise limit to 5 to allow up to five unrelated characters in the region.

Review diagnostic logs to see the noise level for each pair and adjust the limit for optimal results.

Can be one of the following types:

The Text Wrap Options class enables extraction of values that span multiple lines when using the Labeled Value extractor.

This is useful for documents where a value may be split across several lines, such as addresses, descriptions, or other fields that naturally wrap due to layout or formatting.

How It Works

• If the value is located east (to the right) of the label, successive text segments below the value that meet alignment and distance requirements will be captured. These segments must be aligned with the value and to the right of the label. Text that wraps below the label itself cannot be captured using this technique.
• If the value is located south (below) the label, successive text segments below the value that meet alignment and distance requirements will be captured.
• If the value is not located east or south of the label, wrapping is not supported.
• Capture of successive lines continues until another label is encountered or the criteria for line spacing or alignment is violated.

Usage Guidance

• Use Text Wrap Options to extract multi-line values from forms, invoices, or any document where values may wrap due to limited space.
• Adjust the properties below to fine-tune how lines are grouped, including alignment, spacing, and line count requirements.
• This option is especially useful for extracting addresses, item descriptions, or other fields that may not fit on a single line.

The Result Filter allows you to configure a set of criteria that each Data Instance must meet to be included in the final result set. Results that do not match the specified conditions are excluded, enabling precise control over which values are retained for downstream processing or export.

Configuration and Usage

• Configure filter properties to target results by page, confidence, length, character composition, geometric region, font size, alignment, and more.
• Multiple filter criteria can be combined; a result must satisfy all enabled filters to be included.
• Use the 'Allowed Pages' property to restrict results to specific pages.
• Set 'Minimum Confidence' to exclude low-confidence results.
• Use 'Length Range' and 'Character Classes' to filter by value length and character makeup.
• The 'Exclusions' property allows you to specify a Value Extractor whose results will be used to exclude overlapping matches.
• Geometric filters (such as 'Region', 'Width Range', 'Height Range', and 'Font Size Range') allow you to target results by their position and size on the page.
• Emphasis filters (such as 'Character Casing', 'Case Similarity', 'Minimum Font Scale', and 'Require Underline') help isolate results with specific visual or typographic emphasis.

Typical Scenarios

• Restricting to a Region:
  Only include results that fall within a specific area of the page, such as a header or footer.
• Filtering by Confidence:
  Exclude results below a certain confidence threshold to improve data quality.
• Targeting Emphasized Text:
  Isolate headings, titles, or other elements with distinctive font size, casing, or underlining.
• Excluding Unwanted Results:
  Use the 'Exclusions' property to remove results that overlap with known false positives or irrelevant content.

Related Types

• Data Instance: The objects being filtered.
• Value Extractor: Used for exclusion filtering.
• Character Class Filter, Logical Rectangle, Logical Range, Horizontal Alignment Settings: Used for specific filter criteria.

For more information, see the documentation for Data Instance, Value Extractor, and Result Filter properties.

The Result Set Options class provides a flexible set of controls for shaping the output of data extraction and classification activities in Grooper. It allows you to define how individual results are adjusted, how the overall result set is filtered or ordered, and how output values are normalized for downstream use.

Overview

Use this class to:

• Normalize extracted values (e.g., unify variations, apply case or word transformations).
• Adjust or override confidence scores for results.
• Remove unwanted content from output values.
• Sort, filter, or deduplicate the result set.
• Enforce minimum/maximum hit counts or truncate the number of results.

These options are commonly configured on Data Fields, Data Types, or other extraction elements to ensure that the output meets business requirements and is ready for validation, export, or further processing.

Key Scenarios

• Value Normalization:
  Use 'Value Override', 'Case Normalization', or 'Word Normalization' to standardize output values, making them consistent for classification or export. For example, you can map multiple document title variations to a single normalized feature, or apply stemming to treat inflected word forms as equivalent.

• Confidence Adjustment:
  The 'Confidence Override' and 'Confidence Multiplier' properties allow you to boost or reduce the confidence of results, influencing their precedence in classification or extraction. You can also factor in character-level OCR confidence for more granular control.

• Result Set Shaping:
  Use 'Hit Count Range' to require a specific number of results, 'Distinct' to remove duplicates, 'Sort Order' to control result ordering, and 'Truncate At' to limit the number of returned results.

• Content Removal:
  The 'Subtractor' property lets you specify a Value Extractor to remove unwanted content (such as extraneous text or formatting) from each output value.

Processing Flow

When applied, the options in this class are processed in a defined sequence:

1. Individual Value Adjustments:
   Each result is normalized, cleaned, or transformed according to the configured options.
2. Result Set Operations:
   The set of results is filtered, sorted, deduplicated, or truncated as specified.
3. Type Enforcement:
   If a specific value type is required, results are converted and validated accordingly.

This ensures that the final output is both clean and conforms to the requirements of downstream consumers.

Usage Guidance

• Configure only the options relevant to your scenario; defaults are designed to minimize unnecessary processing.
• For best results, test your configuration with representative data to ensure that normalization, filtering, and confidence adjustments behave as expected.
• For more details on individual options, see the documentation for each property.