Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring text analyzers

Updated on July 5, 2022

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

PurposeThe purpose of the text analyzer.
AppliesToThe applicable class of the text analyzer.
ConfigPageA 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

  • Auto
  • <Language>
  • Publisher
DefaultLanguageAny of the supported languages in the sentence case, for example, French.
InputTextPropertyThe property name for the input text.
OutcomePropertyThe property name for the NLP outcome.
DetectTagsAvailable values:
  • All
  • <Number of tags>
This option enables autotags by default. If you enter 0 or a negative number, this option disables autotags.

The value of the compression ratio.

This option enables summarization by default. When you enter 0 or a negative number, this option disables summarization.

TopicGranularityAvailable values:
  • Sentence
  • Document
TopicSelectionAvailable values:
  • TopN
  • FScore
TopicThresholdAvailable values:
  • <The number of topics>
  • <The confidence score threshold>
FallbackToRuleAvailable values:
  • true
  • false

<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>

<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.

ClassificationPreferenceAvailable values:
  • ML
  • Rules

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

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us