Query Manipulation Server 24.3

# 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.
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 2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Query Manipulation Server 24.3

Topic Title: GetSynonyms