Table of Contents

Configuring text analyzers


Only available versions of this content are shown in the dropdown

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
  • Auto
  • <Language>
  • Publisher
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:
  • 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.

TopicGranularity Available values:
  • Sentence
  • Document
TopicSelection Available values:
  • TopN
  • FScore
TopicThreshold Available values:
  • <The number of topics>
  • <The confidence score threshold>
FallbackToRule Available 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.

ClassificationPreference Available values:
  • ML
  • Rules

For more information about text analyzer settings, see Building text analyzers.

Related Content

Have a question? Get answers now.

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