Open topic with navigation

# TermGetInfo

When you index text into IDOL Server, it stores each term that the text contains with a weight that indicates the relevance that this term has to IDOL Server 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.

## Example

    http://12.3.4.56:9000/action=TermGetInfo&Text=cat

This action uses port `9000` to request statistical information about the term `cat` from IDOL Server, which is located on a machine with the IP address `12.3.4.56`.

## Parameters

Parameter | Description | Required
--- | --- | ---
Boolean | Whether the Text parameter contains a Boolean expression. |
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 Server. |
OutputEncoding | The encoding to convert results to. |
ReferenceField | Restricts the MatchReference parameter to the specified reference field. |
StateMatchID | A state token for which term information returns. |
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. |
Text | The terms whose weights return. | Yes
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.

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close We welcome your comments! To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm