Breaks a text block into sentences, using OpenNLP Sentence Detector

Operates On:  Lexical Items with TEXT_BLOCK and possibly other flags as specified below.

Library: saga-sentence-breaker-stage

Generic Configuration Parameters

  • boundaryFlags ( type=string array | optional ) - List of vertex flags that indicate the beginning and end of a text block.
    Tokens to process must be inside two vertices marked with this flag (e.g ["TEXT_BLOCK_SPLIT"])
  • skipFlags ( type=string array | optional ) - Flags to be skipped by this stage.
    Tokens marked with this flag will be ignored by this stage, and no processing will be performed.
  • requiredFlags ( type=string array | optional ) - Lex items flags required by every token to be processed.
    Tokens need to have all of the specified flags in order to be processed.
  • atLeastOneFlag ( type=string array | optional ) - Lex items flags needed by every token to be processed.
    Tokens will need at least one of the flags specified in this array.
  • confidenceAdjustment ( type=double | default=1 | required ) - Adjustment factor to apply to the confidence value of 0.0 to 2.0 from (Applies for every pattern match).
    • 0.0 to < 1.0  decreases confidence value
    • 1.0 confidence value remains the same
    • > 1.0 to  2.0 increases confidence value
  • debug ( type=boolean | default=false | optional ) - Enable all debug log functionality for the stage, if any.
  • enable ( type=boolean | default=true | optional ) - Indicates if the current stage should be consider for the Pipeline Manager
    • Only applies for automatic pipeline building

Configuration Parameters

  • language (string, required) - Indicates the language of the text to process. default "en" (i.e. English)
    • Languages available include:
      • English - "en"
      • German - "de"
      • Portuguese - "pt"
      • Dutch - "nl"
Example Configuration
{
 "type":"SentenceBreakerStage",
 "language":"en",
 "skipFlags": ["SKIP"],
 "debug": true,
}



Example Output

The sentence detector will remove any spaces and dots at the beginning and end of a sentence.

V-----------[Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed eget luctus lorem. Nam cursus eleifend efficitur. Cras nec ultricies nulla. Maecenas porta cursus massa non consectetur.]------------V
^--[Lorem ipsum dolor sit amet, consectetur adipiscing elit]--V--[Sed eget luctus lorem]--V--[Nam cursus eleifend efficitur]--V--[Cras nec ultricies nulla]--V--[Maecenas porta cursus massa non consectetur]--^

Output Flags

Lex-Item Flags

  • TEXT_BLOCK - Flags all of the text blocks produced by the SimpleReader
  • SENTENCE - Every text block processed by this breaker will be marked as SENTENCE

Vertex Flags

  • SENTENCE_SPLIT - Indicates the split (start/end) between sentences.
  • TEXT_BLOCK_SPLIT - Indicates the split of the textblock.
  • No labels