TermGetBest

Allows you to list the conceptually most important terms that one or more specific documents or document sections contain.

IDOL Content Component lists the conceptually most important terms from SourceType fields. If there are no SourceType fields configured, the TermGetBest action lists terms from Index fields.

Example

http://12.3.4.56:9000/action=TermGetBest&ID=41263

This action uses port 9000 to request the conceptually most important terms in the document with the ID 41263 from IDOL Content Component, which is located on a machine with the IP address 12.3.4.56.

Parameters

Parameter Description Required
CustomWeight Whether to use your custom term weight file, if one exists.  
ID The document IDs of documents for which to list the most relevant terms. See Comments
MaxTerms The maximum number of terms or term phrases to return.  
MinDocOccs The minimum number of documents that a term must occur in to return.  
OutputEncoding The encoding to convert the results to.  
Reference The references of documents for which to list the most relevant terms. See Comments
ReferenceField Restricts the Reference parameter to the specified reference field.  
SecurityInfo Security details.  
StateID The state token of a group of documents for which to list the most relevant terms. See Comments
Stemming Whether to stem the terms in the result list.  
Synchronous Whether to run the action synchronously or asynchronously.  
Type The value to use to order the result terms.  
Weights Whether to return weight information for the 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.

Comments

You must set at least one of the following parameters (you can use a combination):

NOTE:

If you use a Distributed Action Handler (DAH) to distribute the TermGetBest action, you cannot use any parameters that specify the IDs of documents. Use parameters that identify documents by their reference instead.


_HP_HTML5_bannerTitle.htm