Breaks a text block into sentences using the BreakIterator of java. This is used to break sentences using punctuation delimiters.  Delimiters can be configured as "breakers".

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

Stage can only be used as part of a manual pipeline or a base pipeline


A better alternative could be the 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 ( type=string | optional ) - Select the language for processing the text
  • breakers ( type=string | optional ) - String containing the characters where the sentences will be split.
    • The character split is done after the sentence split is applied to the text.

"language":"en",
"breakers":";"

Example Output

V------------[Lorem ipsum sit amet, consectetur adipisci. Sed luctus lorem. Cras nec ultricies nulla. Maecenas porta cursus; massa non consectetur.]-------------V  
^--[Lorem ipsum sit amet, consectetur adipiscing]--V--[Sed luctus lorem]--V--[Cras nec ultricies nulla]--V--[Maecenas porta cursus]--V--[massa non consectetur]--^

Output Flags

Lex-Item Flags:

  • TEXT_BLOCK - Flags all text blocks produced by the TextBreakerStage.
  • 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.

Supported Languages

LangLanguageCountry
arArabic-
ar-AEArabicUnited Arab Emirates
ar-BHArabicBahrain
ar-DZArabicAlgeria
ar-EGArabicEgypt
ar-IQArabicIraq
ar-JOArabicJordan
ar-KWArabicKuwait
ar-LBArabicLebanon
ar-LYArabicLibya
ar-MAArabicMorocco
ar-OMArabicOman
ar-QAArabicQatar
ar-SAArabicSaudi Arabia
ar-SDArabicSudan
ar-SYArabicSyria
ar-TNArabicTunisia
ar-YEArabicYemen
be-BYBelarusianBelarus
bg-BGBulgarianBulgaria
ca-ESCatalanSpain
cs-CZCzechCzech Republic
da-DKDanishDenmark
deGerman-
de-ATGermanAustria
de-CHGermanSwitzerland
de-DEGermanGermany
de-GRGermanGreece
de-LUGermanLuxembourg
elGreek-
el-CYGreekCyprus
el-GRGreekGreece
enEnglish-
en-AUEnglishAustralia
en-CAEnglishCanada
en-GBEnglishUnited Kingdom
en-IEEnglishIreland
en-INEnglishIndia
en-MTEnglishMalta
en-NZEnglishNew Zealand
en-PHEnglishPhilippines
en-SGEnglishSingapore
en-USEnglishUnited States
en-ZAEnglishSouth Africa
esSpanish-
es-ARSpanishArgentina
es-BOSpanishBolivia
es-CLSpanishChile
es-COSpanishColombia
es-CRSpanishCosta Rica
es-CUSpanishCuba
es-DOSpanishDominican Republic
es-ECSpanishEcuador
es-ESSpanishSpain
es-GTSpanishGuatemala
es-HNSpanishHonduras
es-MXSpanishMexico
es-NISpanishNicaragua
es-PASpanishPanama
es-PESpanishPeru
es-PRSpanishPuerto Rico
es-PYSpanishParaguay
es-SVSpanishEl Salvador
es-USSpanishUnited States
es-UYSpanishUruguay
es-UYSpanishVenezuela
et-EEEstonianEstonia
fi-FIFinnishFinland
frFrench-
fr-BEFrenchBelgium
fr-CAFrenchCanada
fr-CHFrenchSwitzerland
fr-FRFrenchFrance
fr-LUFrenchLuxembourg
ga-IEIrishIreland
he-ILHebrewIsrael
hi-INHindiIndia
hr-HRCroatianCroatia
hu-HUHungarianHungary
id-IDIndonesianIndonesia
is-ISIcelandicIceland
itItalian-
it-CHItalianSwitzerland
it-ITItalianItaly
jaJapanese-
ja-JPJapaneseJapan
a-JP-u-ca-japanese-x-lvariant-JPJapaneseJapan
ko-KRKoreanSouth Korea
lt-LTLithuanianLithuania
lv-LVLatvianLatvia
mk-MKMacedonianMacedonia
ms-MYMalayMalaysia
mt-MTMalteseMalta
nlDutch-
nl-BEDutchBelgium
nl-NLDutchNetherlands
nn-NONorwegianNorway
no-NONorwegianNorway
pl-PLPolishPoland
ptPortuguese-
pt-BRPortugueseBrazil
pt-PTPortuguesePortugal
ro-RORomanianRomania
ru-RURussianRussia
sk-SKSlovakSlovakia
sl-SISlovenianSlovenia
sq-ALAlbanianAlbania
srSerbian-
sr-BASerbianBosnia and Herzegovina
sr-CSSerbianSerbia and Montenegro
sr-LatnSerbian-
sr-Latn-BASerbianBosnia and Herzegovina
sr-Latn-MESerbianMontenegro
sr-Latn-RSSerbianSerbia
sr-MESerbiaMontenegro
sr-RSSerbiaSerbia
sv-SESwedishSweden
thThai-
th-THThaiThailand
th-TH-u-nu-thai-x-lvariant-THThaiThailand
tr-TRTurkishTurkey
uk-UAUkrainianUkraine
vi-VNVietnameseVietnam
zhChinese-
zh-CNChineseChina
zh-HKChineseHong Kong
zh-SGChineseSingapore
zh-TWChineseTaiwan
  • No labels