Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

FlowDirection

Grooper.Extract

Specifies the relative position of context features in the text flow with respect to a candidate value.

Remarks

Overview

The FlowDirection enumeration is used in Field Class objects to filter context features by their position in the text flow relative to a candidate value. This is only applicable when the 'Context Scope' property is set to Flow. It enables filtering of features that occur before, after, or on either side of the value in the document's reading order.

This is useful for natural language documents, such as contracts or unstructured text, where the meaning of a value is often determined by the words or phrases that appear before or after it in the text.

Multiple directions can be combined using bitwise flags. For example, to include features both before and after a value, use:

Usage Examples

  • To focus on features that precede a value (such as labels or introductory phrases), use Before.
  • To focus on features that follow a value (such as units, qualifiers, or trailing context), use After.
  • To include features on both sides, use Either.

Special Behaviors

  • When 'GeoTag Features' is enabled, features are tagged with (b) for before and (a) for after.
  • The 'Max Instances' property limits the number of features included from the selected directions.

Related Properties

  • 'Flow Filter': Specifies which directions to include when extracting context features in Flow mode.
  • 'Max Instances': Limits the maximum number of features included.
  • 'GeoTag Features': When enabled, appends a direction tag to each feature.

For more information, see the documentation for Field Class, 'Context Scope', and related extraction settings.

Can be one of the following values:

NameValueDescription

Used By

Notification