Configuring text analyzers
Use the pxConfigureTextAnalyzer API to configure such text analyzer settings as the language, analysis granularity, and others.
This API has the following input properties:
pxConfigureTextAnalyzer API input properties
| Parameter | Description |
| Purpose | The purpose of the text analyzer. |
| AppliesTo | The applicable class of the text analyzer. |
| ConfigPage | A clipboard page of type Code-Pega-List that contains a pxResults pagelist of the Embed-NameValuePair type. |
To deliver the expected results, the ConfigPage parameter has the following requirements:
- It must contain a pxResults pagelist of type Embed-NameValuePair.
- The pyName property must contain the name of the key to update.
- The pyValue property must contain the value of the key to update.
The following list contains the pxResults keys together with acceptable values:
Values of pxResults keys
| Key | Value |
| Language |
|
| DefaultLanguage | Any of the supported languages in the sentence case, for example, French. |
| InputTextProperty | The property name for the input text. |
| OutcomeProperty | The property name for the NLP outcome. |
| DetectTags | Available values:
|
| CompressionRatio | The value of the compression ratio. This option enables summarization by default. When you enter 0 or a negative number, this option disables summarization. |
| TopicGranularity | Available values:
|
| TopicSelection | Available values:
|
| TopicThreshold | Available values:
|
| FallbackToRule | Available values:
|
| SpellChecker | <The name of the SpellChecker rule> When set, this parameter enables spelling checks. |
| MinimumScore | <Minimum score value for sentiment> |
| MaximumScore | <Maximum score value for sentiment> |
| Lexicon | <The name of the lexicon rule to use> |
| DefaultTopic | <The name of the default topic model> When set, this option replaces the existing topic model if the topic is included in a new model. Otherwise, this option sets the default topic within a model. |
| ClassificationPreference | Available values:
|
For more information about text analyzer settings, see Building text analyzers.
Previous topic Adding and removing models from text analyzers Next topic Performing the Save As operation in text analyzer