Custom |
The CustomEntityDefinition type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Classification | The named classification of this sequence type (ex: "LegalContract"). |
| ExtractType | Determines what type, if any, of text immediately following the KeywordSequences is extracted. |
| KeywordSequences | A list of keword sequences. A keyword sequence is 1 to a maximum of 14 keyword terms (terms are words or symbols) that define a custom item. |
| Name | The named of this sequence (ex: "ContractTerm") |
| RegExOptions | Regular expression options. Option flag Compiled will be ignored. |
| RegExSearchLength | Determines the maximum number of characters after (RegularExpressionAfter), before (RegularExpressionBefore) or before and after (RegularExpressionBeforeAndAfter) to use for RegularExpression search. See property RegularExpression for more information. The default value is 50 characters and this includes any whitespace characters. |
| RegularExpression | This property value should only be set with a regular expression data pattern if ExtractType is RegularExpressionAfter or RegularExpressionBefore (value will be ignored otherwise). Property RegExSearchLength determines the maximum number of characters after (if RegularExpressionAfter) or before (if RegularExpressionBefore) to apply the regular expression pattern match. If the regular expression finds no matches then no custom Entity will be added to the entity item results. For regular expressions, the keyword sequence and the regular expression both must be matched in order to be added to the Items result list. Regular expressions are computationally expensive and their use should be limited to special cases. RegExSearchLength should not be set larger than needed in order to match a pattern before, after, or before and after the keyword sequence. The keyword sequence should be unique enough (and not a very common word) in order that the regular expression is not excessively invoked to match its pattern. |
| RequireKeywordSequenceAtStartOfLine | If true, a keyword sequence must have its first token as the first token on a line, else it is not considered a valid sequence and is ignored. Default value is false. |
See Also