Text

NOTE: This parameter description applies only to the TermExpand action.

The term to expand according to the specified Expansion.

The following table describes the value to set in the Text parameter for each type of Expansion.

Expansion Text TermExpand returns
Autocomplete Any term or partial term. Terms and phrases that start with the specified text.
Fuzzy A misspelled term. Terms with similar spelling to your term.
Phrase One or more terms. Phrases that start with the word or words in the specified text.
Synonym A synonym link from a synonym query. (See Synonym) The terms and phrases that the synonym link corresponds to.
Stem Any term. A list of terms that have the same word stem as the specified term.
Wild A Wildcard term. A list of terms that the Wildcard term expands to.

When you set Expansion to Autocomplete, Fuzzy, Phrase or Wild, you can add a field restriction. If you set a field restriction, TermExpand returns only terms that appear in this field. You can use only fields that you set in the UnstemmedTrackFields configuration parameter.

Specify field restrictions in the form Text=Text:Field, where:

  • Text is the misspelled or Wildcard term to expand.

  • Field is the field to restrict by.

Actions: TermExpand
Type: String
Default:  
Example: TermExpand&Text=ryhthm&Expansion=Fuzzy
This example returns terms whose spelling is similar to that of the term ryhthm (for example, RHYTHM, RHYTHMIC, and so on).

TermExpand&Text=Renolds:Author&Expansion=Fuzzy
This example returns terms whose spelling is similar to that of the term Renolds in the Author field (for example, RENOLDS, RENNOLDS, REYNOLDS, and so on).

TermExpand&Text=ar*&Expansion=Wild
This example returns terms that match the Wildcard term car* (for example, CARAT, CARBONOXID, CARDIGAN, and so on).

TermExpand&Text=Mauri*:Country&Expansion=Wild
This example returns terms that match the Wildcard term Mauri* in the Country field (for example, MAURITANIA, MAURITIUS).

TermExpand&Text=FKKKNNLLX&Expansion=Synonym
This example returns the term phrases that the synonym link FKKKNNLLX corresponds to (for example, if the synonym link was returned by a synonym query for dog, the synonym link might expand to MANS BEST FRIEND, HOUND, DOG, and so on).
See Also: Expansion
UnstemmedTrackFields configuration parameter
Query action Synonym parameter