# GetSynonyms

Returns the keywords of all the synonym rules (including hyponym and hypernym rules) that match some input text. The keywords are extracted from the `KEYWORDS` field in synonym rule documents that exist in the Agentstore.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Text | The input text to return synonyms for.

## Optional Parameters

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.

## Example

The following action requests the synonyms for the text `dog`.

    http://qms:16000/action=GetSynonyms&Text=dog

## Response

The response contains one `<autn:synonym>` element for each matching synonym rule. The `<autn:reference>` element contains the reference of the synonym rule.

    <autnresponse>
      <action>GETSYNONYMS</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>

© Copyright 2019 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a mail client, and then send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm