TermGetInfo
When you index text into IDOL Content Component, it stores each term that the text contains with a weight that indicates the relevance that this term has to IDOL Content Component content.
The TermGetInfo action allows you to return the weight of specified terms, the number of documents that the terms occur in, and the total number of times that the terms occur.
NOTE: If you have a custom stemming library that can return multiple stems, by default TermGetInfo returns only the first (primary) stem that the library returns. You can set Boolean to True to return additional stems. In this case, Micro Focus also recommends that you set Type to None to allow you to easily identify different stems, which all have the same value for the startpos attribute. See CustomStemming.
Example
http://12.3.4.56:9100/action=TermGetInfo&Text=cat
This action requests statistical information about the term cat from IDOL Content Component.
Required Parameters
The following action parameters are required.
| Parameter | Description |
|---|---|
| Text | The terms whose weights return. |
Optional Parameters
This action accepts the following optional parameters.
| Parameter | Description |
|---|---|
| Boolean | Whether the Text parameter contains a Boolean expression. |
| CustomWeight | Whether to use your custom term weight file, if one exists. |
| DetectLanguageType | Whether to detect the language type of the Text. |
| LanguageType | The language type of the terms. |
| MatchID | A list of documents to return term occurrence information for. |
| MatchReference | A list of document references to return term occurrence information for. |
| MaxTerms | The maximum number of terms to return statistical information for. |
| MinDocOccs | The minimum number of documents that a term must occur in for term information to return. |
| MinTermLength | The minimum length, after stemming, that a term can have. |
| OnlyExisting | Whether to return only terms that already exist in IDOL Content Component. |
| OutputEncoding | The encoding to convert results to. |
| ReferenceField | Restricts the MatchReference parameter to the specified reference field. |
| ShowQueryWeights | Whether to show unmodified query weights, or suggestions weights. |
| StateMatchID | A state token for which term information returns. |
| StateMatchOriginalSection | Whether to use only sections from a state token that were matched in the original query. |
| Stemming | Whether to stem the terms in the result list. |
| Synchronous | Whether to run the action synchronously or asynchronously. |
| TermPositions | Whether to return the field codes and positions of the occurrences of a term in a single document. |
| TextParse | Whether the Text parameter contains plain text, or as an IDX or XML document. |
| Type | The value that determines the term weighting. |
| Weights | Whether to return weight information for the term. |
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. |
Comments
NOTE: If you use a Distributed Action Handler (DAH) to distribute the TermGetInfo action, you cannot use any parameters that specify the IDs of documents. Use parameters that identify documents by their reference instead.