-
No documentation for this element.
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
matchOnSeparators |
boolean |
True |
If you want to skip separators, set this boolean to false |
matchOnSeparatorsBut |
string |
- |
If you want to skip only a set of separators, specify them here
ex: matchOnSeparatorsBut="-_" will match on separators but skip '-' and '_' |
XML representation
<Ontology
modifiedAt=""
matchOnSeparators="true"
matchOnSeparatorsBut=""
></Ontology>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
fileName |
string |
- |
Path to external ontology to include |
XML representation
<OInclude
fileName=""
></OInclude>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
path |
string |
- |
Package name, used as annotation tag |
disabled |
boolean |
False |
|
XML representation
<Pkg
modifiedAt=""
path=""
disabled="false"
></Pkg>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
display |
string |
- |
Display form of the annotation |
lang |
iso code |
- |
Language of forms in this entry when not specified |
kind |
int |
- |
Kind of the annotation |
disabled |
boolean |
False |
|
Type |
Wrapper |
Description |
Form* |
- |
|
XML representation
<Entry
modifiedAt=""
display=""
lang=""
kind=""
disabled="false"
></Entry>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
- |
Matching expression |
level |
string |
- |
Matching level |
lang |
iso code |
- |
Can be used to restrict a match to a specific language |
distance |
int |
0 |
Specify the distance to apply to the default annotation trustLevel (ie: 100-distance) |
disabled |
boolean |
False |
|
XML representation
<Form
modifiedAt=""
value=""
level=""
lang=""
distance="0"
disabled="false"
></Form>
-
A set of categories together with their associated rules
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
catName |
string |
- |
The category name |
XML representation
<FastRulesDefinition
modifiedAt=""
catName=""
></FastRulesDefinition>
-
A set of rules and a category value for matching documents
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
- |
The category value |
Type |
Wrapper |
Description |
Rule* |
- |
|
XML representation
<Category
modifiedAt=""
value=""
></Category>
-
A rule expressing constraints on a document content
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
- |
A query defined with a subset of Exalead User Query Language |
exceptionRule |
boolean |
False |
Makes the rule an exception rule instead of a normal rule. When any of the exception rules of a category matches, the category is not assigned to the document, even if some of its normal rules match. |
lang |
iso code |
xx |
Restrict this query to a specific language |
XML representation
<Rule
modifiedAt=""
value=""
exceptionRule="false"
lang="xx"
></Rule>
-
A date format definition conforming to C function strptime
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
- |
The date format value |
XML representation
<DateFormat
modifiedAt=""
value=""
></DateFormat>
-
No documentation for this element.
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
lang |
iso code |
- |
|
Type |
Wrapper |
Description |
Lemma* |
- |
|
XML representation
<LemmaDictionary
modifiedAt=""
lang=""
></LemmaDictionary>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
value |
string |
- |
|
pos |
string |
- |
|
trustLevel |
int |
100 |
|
Type |
Wrapper |
Description |
Inflected* |
inflecteds |
Inflected forms of the word |
XML representation
<Lemma
value=""
pos=""
trustLevel="100"
></Lemma>
-
No documentation for this element.
Parent objects
Attributes
- value
string
- number
enum(singular, plural, unnumbered)
- gender
enum(masculine, feminine, neutral)
Name |
Type |
Default value |
Description |
value |
string |
- |
Inflected form of the word. |
number |
enum(singular, plural, unnumbered) |
unnumbered |
Number of the inflected form |
gender |
enum(masculine, feminine, neutral) |
neutral |
Gender of the inflected form |
XML representation
<Inflected
value=""
number="unnumbered"
gender="neutral"
></Inflected>
-
No documentation for this element.
XML representation
<NormalizationOverwrites
></NormalizationOverwrites>
-
overwrite normalization for a specific letter
for example umlaut exceptions : ä -> ae, ü -> ue, ö -> oe ...
Parent objects
Attributes
Name |
Type |
Default value |
Description |
lang |
string |
- |
|
origChr |
string |
- |
|
replaceString |
string |
- |
|
XML representation
<NormalizationOverwrite
lang=""
origChr=""
replaceString=""
></NormalizationOverwrite>
-
No documentation for this element.
XML representation
<NormalizationAlternatives
></NormalizationAlternatives>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
lang |
string |
- |
|
origChr |
string |
- |
|
replaceString |
string |
- |
|
XML representation
<NormalizationAlternative
lang=""
origChr=""
replaceString=""
></NormalizationAlternative>
-
No documentation for this element.
XML representation
<NormalizationExceptions
></NormalizationExceptions>
-
set normalization exception, for this word, the annotation will
be added with a trust level of 0 instead of 100
This is usefull to index thé, maïs, ... as lowercase word and as normalized words
Parent objects
Attributes
Name |
Type |
Default value |
Description |
lang |
string |
- |
|
word |
string |
- |
|
XML representation
<NormalizationException
lang=""
word=""
></NormalizationException>
-
No documentation for this element.
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
Type |
Wrapper |
Description |
RegexpMatch* |
- |
Regular expressions to recognize. |
XML representation
<RegexpMatches
modifiedAt=""
></RegexpMatches>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
regexp |
string |
- |
Regular expression to recognize. |
annotation |
string |
- |
Tag of the annotations to add on matched tokens. |
level |
enum(exact, lowercase, normalized) |
normalized |
Level of the regular expression.
For example, a regexp with level=lowercase will match case-insensitively. |
lang |
iso code |
xx |
Lang of the regular expression.
The regexp will not match token in other languages. If lang=xx, token may be matched whatever language they are in. |
displayForm |
string |
- |
Value of the annotations to add on matched tokens.
By default, the display form is that of the matched tokens, but it can be overriden by the user.
Captures may be used. Eg. if the regexp is "(foo)bar", and the displayForm may is "\1baz", then annoations will be added on "foobar" with value "foobaz". |
XML representation
<RegexpMatch
regexp=""
annotation=""
level="normalized"
lang="xx"
displayForm=""
></RegexpMatch>
-
The Synonyms feature allows you to define synonym resources
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
equivalenceClass |
boolean |
True |
A synonym set is defined with a master expression and a set of
associated expressions (an expression is defined by many words with a space as separator)
originalExpr = {alternativeExpr1, ...., alternativeExprN} When query is parsed we expand originalExpr with {alternativeExpr1, ..., alternativeExprN}. When equivalenceClass boolean is set to true, we also expand :
- alternativeExpr1 by originalExpr, alternativeExpr2, ..., alternativeExprN
- alternativeExpr2 by originalExpr, alternativeExpr1, alternativeExpr3, ..., alternativeExprN
- ...
- alternativeExprN by originalExpr, alternativeExpr1, ..., alternativeExprN-1 |
matchOnSeparators |
boolean |
True |
If false, synonym matching is punctuation-insensitive. |
stopwordsResource |
string |
resource:///stopwords/ontology.bin |
Path to the compiled ontology containing stopwords used at buildtime when generating permutations. |
permutations |
boolean |
False |
If true, adds for each synonym some extra forms made of words permutations after removing stopwords. |
addStopwordFreeForms |
boolean |
False |
If true, adds for each synonym an extra form from which stopwords have been removed. |
XML representation
<Synonyms
modifiedAt=""
equivalenceClass="true"
matchOnSeparators="true"
stopwordsResource="resource:///stopwords/ontology.bin"
permutations="false"
addStopwordFreeForms="false"
></Synonyms>
-
A set of synonym terms.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
originalExpr |
string |
- |
String to match in user query |
level |
enum(exact, lowercase, normalized) |
normalized |
Term level of these expressions. |
lang |
iso code |
- |
Only match the original expression in this language. |
equivalenceClass |
enum(true, false, SynonymSetToSynonym, SynonymToSynonymSet) |
|
override equivalenceClass boolean
if null or different from true/false, keep Synonyms.equivalenceClass value |
Type |
Wrapper |
Description |
Synonym* |
- |
The list of synonyms of the original expression. |
XML representation
<SynonymSet
modifiedAt=""
originalExpr=""
level="normalized"
lang=""
equivalenceClass=""
></SynonymSet>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
alternativeExpr |
string |
- |
Synonym string: can be a multi word expression (separated by space only) |
level |
enum(exact, lowercase, normalized, custom, sameasset) |
sameasset |
display level |
customLevel |
byte |
- |
(only when level == "custom")
when level = "custom", this customLevel is used |
distance |
int |
- |
distance applied to this synonym |
lang |
string |
|
if not null, override language of SynonymSet |
XML representation
<Synonym
modifiedAt=""
alternativeExpr=""
level="sameasset"
customLevel=""
distance=""
lang=""
></Synonym>
-
A set of transducer rules
Name |
Type |
Default value |
Description |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<TRules
modifiedAt=""
></TRules>
-
Abstract class common to all patterns whose children have to be interpred as a sequence.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Seq
priority="0"
name=""
modifiedAt=""
></Seq>
-
@b iter pattern ...
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
min |
int |
0 |
|
max |
int |
128 |
|
greedy |
boolean |
True |
|
XML representation
<Iter
priority="0"
name=""
modifiedAt=""
min="0"
max="128"
greedy="true"
></Iter>
-
@b star pattern == iter(min=0, max=this.max, greedy=true)
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
max |
int |
2147483647 |
|
XML representation
<Star
priority="0"
name=""
modifiedAt=""
max="2147483647"
></Star>
-
@b plus pattern == iter(min=1, max=this.max, greedy=true)
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
max |
int |
2147483647 |
|
XML representation
<Plus
priority="0"
name=""
modifiedAt=""
max="2147483647"
></Plus>
-
@b opt pattern == iter(min=0, max=1, greedy=true)
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Opt
priority="0"
name=""
modifiedAt=""
></Opt>
-
@b sub pattern denotes submatches that will be retrieved
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
no |
int |
0 |
|
kind |
string |
sub |
|
value |
string |
|
|
trustLevel |
int |
100 |
|
XML representation
<Sub
priority="0"
name=""
modifiedAt=""
no="0"
kind="sub"
value=""
trustLevel="100"
></Sub>
-
@b or pattern matches ...
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Or
priority="0"
name=""
modifiedAt=""
></Or>
-
A BINARY near matching subexpressions in any order
at a max distance defined by slop in terms of non-blank tokens
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
slop |
int |
0 |
|
ordered |
boolean |
False |
|
XML representation
<Near
priority="0"
name=""
modifiedAt=""
slop="0"
ordered="false"
></Near>
-
Assert that there is no space between two tokens
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Noblank
priority="0"
name=""
modifiedAt=""
></Noblank>
-
Abstract class common to pattern that matches a word and/or an annotation.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<PatternRef
anchor="false"
priority="0"
name=""
modifiedAt=""
></PatternRef>
-
Abstract class common to pattern that matches a word and/or an annotation.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<And
anchor="false"
priority="0"
name=""
modifiedAt=""
></And>
-
Abstract class common to pattern that matches a word and/or an annotation.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Not
anchor="false"
priority="0"
name=""
modifiedAt=""
></Not>
-
Abstract class common to pattern that matches a word and/or an annotation.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Nor
anchor="false"
priority="0"
name=""
modifiedAt=""
></Nor>
-
Matches a specific token kind as set by the tokenizer
Allowed values are:
SEP_PARAGRAPH SEP_SENTENCE
SEP_PUNCT SEP_QUOTE
SEP_DASH NUMBER
ALPHANUM (** Warning **, this means alpha AND num, not alpha OR num)
ALPHA
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
|
|
XML representation
<TokenKind
anchor="false"
priority="0"
name=""
modifiedAt=""
value=""
></TokenKind>
-
Matches a token with kind SEP_PARAGRAPH
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Paragraph
anchor="false"
priority="0"
name=""
modifiedAt=""
></Paragraph>
-
Matches a token with kind SEP_SENTENCE
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Sentence
anchor="false"
priority="0"
name=""
modifiedAt=""
></Sentence>
-
Matches a token with kind SEP_DASH
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Dash
anchor="false"
priority="0"
name=""
modifiedAt=""
></Dash>
-
Matches a token with kind SEP_PUNCT
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Punct
anchor="false"
priority="0"
name=""
modifiedAt=""
></Punct>
-
Matches a token with kind NUMBER
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Digits
anchor="false"
priority="0"
name=""
modifiedAt=""
></Digits>
-
Matches a token made only of letters or digits (case-insensitive)
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Alnum
anchor="false"
priority="0"
name=""
modifiedAt=""
></Alnum>
-
Matches a token made only of letters (case-insensitive)
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Alpha
anchor="false"
priority="0"
name=""
modifiedAt=""
></Alpha>
-
Matches a token with specified language
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
- |
|
XML representation
<TokenLanguage
anchor="false"
priority="0"
name=""
modifiedAt=""
value=""
></TokenLanguage>
-
Matches any word.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<AnyToken
anchor="false"
priority="0"
name=""
modifiedAt=""
></AnyToken>
-
Matches a regexp.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
- |
Regular expression to recognize. |
level |
enum(exact, lowercase, normalized) |
exact |
Level of the regular expression.
For example, a regexp with level=lowercase will match case-insensitively. |
XML representation
<TokenRegexp
anchor="false"
priority="0"
name=""
modifiedAt=""
value=""
level="exact"
></TokenRegexp>
-
Matches a word.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
value |
string |
- |
Word to recognize. |
level |
enum(exact, lowercase, normalized) |
normalized |
Level of the word.
For example, a word with level=lowercase will match case-insensitively. |
XML representation
<Word
anchor="false"
priority="0"
name=""
modifiedAt=""
value=""
level="normalized"
></Word>
-
Matches an annotation kind and possibly its display form if specified.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
kind |
string |
- |
|
value |
string |
|
|
useDisplayForm |
boolean |
True |
|
required |
boolean |
False |
|
error |
enum(ignore, warn, error) |
warn |
|
XML representation
<Annotation
anchor="false"
priority="0"
name=""
modifiedAt=""
kind=""
value=""
useDisplayForm="true"
required="false"
></Annotation>
-
backward compatibility classes
Parent objects
Attributes
Name |
Type |
Default value |
Description |
kind |
string |
- |
|
value |
string |
|
|
useDisplayForm |
boolean |
True |
|
required |
boolean |
False |
|
error |
enum(ignore, warn, error) |
warn |
|
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
XML representation
<Ctx
kind=""
value=""
useDisplayForm="true"
required="false"
anchor="false"
priority="0"
name=""
modifiedAt=""
></Ctx>
-
Matches an annotation with specified kind
and whose display form matches the specified regular expression.
If defined, "capture" contains an output format a la sed used for generating
the final match annotation
Parent objects
Attributes
Name |
Type |
Default value |
Description |
anchor |
boolean |
False |
|
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
kind |
string |
- |
Annotation kind that the annotation regular expression will be tested against.
|
value |
string |
- |
Regular expression of the annotation.
|
level |
enum(exact, lowercase, normalized) |
exact |
Matching level, can be normalized, lowercase or exact.
|
useDisplayForm |
boolean |
True |
Activate this option to use the display form of this annotation to build the final output annotation.
|
required |
boolean |
False |
|
error |
enum(ignore, warn, error) |
warn |
|
capture |
string |
- |
Output format in sed format used to generate the final match annotation
|
XML representation
<AnnotationRegexp
anchor="false"
priority="0"
name=""
modifiedAt=""
kind=""
value=""
level="exact"
useDisplayForm="true"
required="false"
capture=""
></AnnotationRegexp>
-
A transducer rule
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
kind |
string |
|
|
value |
string |
|
|
trustLevel |
int |
100 |
|
XML representation
<TRule
priority="0"
name=""
modifiedAt=""
kind=""
value=""
trustLevel="100"
></TRule>
-
Match generation
An annotation kind and a format
Parent objects
Attributes
Name |
Type |
Default value |
Description |
kind |
string |
- |
|
value |
string |
%0 |
|
trustLevel |
int |
-1 |
|
XML representation
<MatchAnnotation
kind=""
value="%0"
trustLevel="-1"
></MatchAnnotation>
-
Include an XML rules file
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
filename |
string |
- |
|
XML representation
<TInclude
priority="0"
name=""
modifiedAt=""
filename=""
></TInclude>
-
Import an XML rules file so that rules and patterns defined in it can referenced by a PatternRef
This is not quite equivalent to a TInclude which contains at least a TRule. Here, the TRule is not
created.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
priority |
int |
0 |
|
name |
string |
- |
Optionnal name of the pattern (used for pattern references). |
modifiedBy |
string |
- |
|
modifiedAt |
nullablelong |
- |
|
filename |
string |
- |
|
XML representation
<TImport
priority="0"
name=""
modifiedAt=""
filename=""
></TImport>
-
Removes the specified annotations, possibly when some condition is met
Name |
Type |
Default value |
Description |
annotation |
string |
- |
Tag of the annotations to be removed
|
ifMatchWith |
string |
- |
Removes the annotation if the annotated text span matches that of this one
|
ifOverlapWith |
string |
- |
Removes the annotation if it overlaps with this one
|
displayFormsMustMatch |
boolean |
False |
If ifMatchWith is TRUE, removes the annotation only if both display forms match
|
XML representation
<Remove
annotation=""
displayFormsMustMatch="false"
></Remove>
-
Copies a source annotation along with its display form and display kind to a target annotation
Name |
Type |
Default value |
Description |
annotation |
string |
- |
The source annotation to be copied
|
target |
string |
- |
The target annotation
|
unless |
string |
- |
Copies the source annotation unless this annotation is present
|
XML representation
<Copy
annotation=""
target=""
></Copy>
-
When several annotations overlap, keeps the longest (removes all others); if there are several longest annotations, then keep the leftmost ones.
For example, for 5 tokens "tow truck driver license requirements" and 3 annotations on "tow truck driver", "truck driver license requirements" and "license requirements"
with the same tag, keeps the annotation on "truck driver license requirements" and removes the other two.
Name |
Type |
Default value |
Description |
annotations |
string |
- |
List of comma-separated annotations to process
|
interTags |
boolean |
False |
Keep the longest-leftmost among all the tags. If FALSE, one annotation per tag will be kept
|
Type |
Wrapper |
Description |
AnnotationProcessed* |
- |
Alternative way to specify the list of annotations to process
|
XML representation
<KeepLongestLeftMost
interTags="false"
></KeepLongestLeftMost>
-
Alternative way to specify the list of annotations to be processed by the operation KeepLongestLeftMost
Parent objects
Attributes
Name |
Type |
Default value |
Description |
name |
string |
- |
|
XML representation
<AnnotationProcessed
name=""
></AnnotationProcessed>
-
When several annotations overlap, keeps the leftmost (removes all others); if there are several leftmost annotations, then keep the longest ones.
For example, for 5 tokens "tow truck driver license requirements" and 3 annotations on "tow truck driver", "truck driver license requirements" and "license requirements"
with the same tag, keeps the annotations on "tow truck driver" and "license requirements".
Name |
Type |
Default value |
Description |
annotations |
string |
- |
List of comma-separated annotations to process
|
interTags |
boolean |
False |
Keep the leftmost-longest among all the tags. If FALSE, one annotation per tag will be kept
|
Type |
Wrapper |
Description |
AnnotationProcessed* |
- |
Alternative way to specify the list of annotations to process
|
XML representation
<KeepLeftMostLongest
interTags="false"
></KeepLeftMostLongest>
-
Selects the first N occurrences or values of an annotation and remove all others
Name |
Type |
Default value |
Description |
annotation |
string |
- |
The annotation to find
|
contexts |
string |
- |
Keeps the first N annotation occurrences/values in each of these contexts
|
howMany |
int |
1 |
How many annotation occurrences/values will be kept
|
what |
enum(occurrences, values) |
occurrences |
Defines what shall be kept: first N annotation 'occurrences' or 'values'
|
XML representation
<KeepFirst
annotation=""
howMany="1"
what="occurrences"
></KeepFirst>
-
Selects the N most frequent values of a given annotation and annotates the document with them
Name |
Type |
Default value |
Description |
annotation |
string |
- |
The annotation to find
|
documentAnnotation |
string |
- |
Annotates the document with this annotation instead of the selected annotation
|
truncate |
boolean |
False |
Keeps only one value when there are multiple candidates
|
howMany |
int |
1 |
How many values should be kept
|
XML representation
<SelectMostFrequentValue
annotation=""
truncate="false"
howMany="1"
></SelectMostFrequentValue>
-
Selects the most frequent annotation and annotates the document with it
Name |
Type |
Default value |
Description |
annotations |
string |
- |
Selects among these annotations
|
documentAnnotation |
string |
- |
Annotates the document with this annotation
|
XML representation
<SelectMostFrequentAnnotation
annotations=""
documentAnnotation=""
></SelectMostFrequentAnnotation>
-
Selects annotations appearing in the first context of a list sorted by decreasing priority.
For example, selecting an annotation from (title, text) will lookup title context and then, if the annotation is not found, text context.
Name |
Type |
Default value |
Description |
annotation |
string |
- |
The annotation to find
|
contexts |
string |
- |
The contexts to select the annotation from, sorted by decreasing priority
|
documentAnnotation |
string |
- |
Annotates the document with this annotation
|
firstOnly |
boolean |
False |
Selects only the first occurrence of the annotation
|
XML representation
<SelectByContexts
annotation=""
contexts=""
documentAnnotation=""
firstOnly="false"
></SelectByContexts>
-
No documentation for this element.
Parent objects
Attributes
Name |
Type |
Default value |
Description |
value |
string |
- |
- |
XML representation
<StringValue
value=""
></StringValue>