Key Phrase Extraction

Specifies which entity categories (e.g., Person, Organization, Location) should be included in the extraction results.

• Only available for extractors that support entity type filtering.
• Leave empty to include all supported entity types.
• Use this to focus extraction on relevant categories and reduce noise in the output.

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.