GetSynonymKeywords

Returns a list of the keywords for one or more synonym rules (including hyponym and hypernym rules), specified by document reference. The keywords are extracted from the KEYWORDS field in the synonym rule documents that exist in the Agentstore.

Required Parameters

The following action parameters are required.

Parameter Description
References A comma-separated list of document references to specify the synonym rules to obtain keywords for. Synonym rules are documents indexed into your IDOL Agentstore component, so each rule has a reference.

Optional Parameters

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
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.

Example

The following action requests the synonym keywords for the document reference dog_synonyms.

http://qms:16000/action=GetSynonymKeywords&References=dog_synonyms

Response

<autnresponse>
  <action>GETSYNONYMKEYWORDS</action>
  <response>SUCCESS</response>
  <responsedata>
    <autn:synonyms>
      <autn:synonym>
        <autn:reference>dog_synonyms</autn:reference>
        <autn:keyword>dog</autn:keyword>
        <autn:keyword>hound</autn:keyword>
        <autn:keyword>canine</autn:keyword>
      </autn:synonym>
    </autn:synonyms>
  </responsedata>
</autnresponse>