TermExpand
Allows you to specify misspelled or Wildcard terms and return all matching terms in IDOL Content Component. You can also use TermExpand to return the term phrases that internal synonym links (returned by a query with the Synonym parameter) correspond to.
You can also restrict the term expansion for Wildcard or misspelled terms to terms in UnstemmedTrackFields by adding a field restriction.
NOTE: By default, TermExpand does not apply document security to the results. You can enable security by setting the SecureTermExpansion configuration parameter. In this case you must provide the SecurityInfo with the security information for the user, and TermExpand returns terms from only documents that the user has permission to access.
TermExpand returns the tag <autn:secure_expansion>, which has the value True when you have turned on SecureTermExpansion, or when you do not have security configured.
Example
http://12.3.4.56:9100/action=TermExpand&Text=sound&Expansion=Fuzzy
This action requests fuzzy matches for the term sound.
http://12.3.4.56:9100/action=TermExpand&Text=Mauri*:Country&Expansion=Wild
This action requests terms that start with Mauri in the Country field. In this example, the Country field must be configured in UnstemmedTrackFields.
Required Parameters
The following action parameters are required.
| Parameter | Description |
|---|---|
| Expansion | The expansion type to use. |
| Text | The text or synonym link to expand. |
Optional Parameters
This action accepts the following optional parameters.
| Parameter | Description |
|---|---|
| FieldText | Restrict term expansion results to terms that appear in documents that match the specified field text. |
| LanguageType | The language type of the Text. |
| MaxTerms | The maximum number of terms or term phrases to return. |
| MinDocOccs | The minimum number of times that a term must occur to return as an expansion. |
| OutputEncoding | The encoding to convert the results to. |
| SecurityInfo | The security information string for the user. |
| Stemming | Whether to stem the terms in the results list. |
| Synchronous | Whether to run the action synchronously or asynchronously. |
| TermDetails | Whether to return details of the number of documents that each term occurs in. |
| Type | The value to use to sort the result terms. |
This action accepts the following standard ACI action parameters.
| Parameter | Description |
|---|---|
| ActionID | A string to use to identify an ACI action. |
| EncryptResponse | Encrypt the output. |
| FileName | The file to write output to. |
| ForceTemplateRefresh | Forces the server to load the template from disk. |
| Output | Writes output to a file. |
| ResponseFormat | The format of the action output. |
| Template | The template to use for the action output. |
| TemplateParamCSVs | A list of variables to use for the specified template. |