5.3. get_thesaurus_keyphrases

array of strings get_thesaurus_keyphrases(
        string id,
        array of strings keyphrases,
        boolean include_plurals,
        string adult_filter,
        integer depth,
        integer max)

Parameters

id
The client access key supplied by Wordtracker

keyphrases
Keyphrases to search for.

include_plurals
If true, the keyphrases will include plural forms.

adult_filter

The adult filter has four levels which can be set with the following flags:

off
No filtering applied. Adult terms will be included in the results.
remove_dubious
Removes all keywords unsuitable for presentations. This is the most aggressive filter and may occasionally remove clean terms.
remove_offensive
Removes offensive keywords.
adult_only
Only displays adult terms.

The following flags have been deprecated: 'include_adult' and 'exclude_adult'.

This filter is applied to the results before they are returned to you.

depth
Search depth in the thesaurus database.

max
The maximum number of results returned. A zero means all results.

Description

Enter a seed keyphrase and Wordtracker will generate an array of related terms. In order to generate the largest choice of suggestions the search includes synonyms, antonyms, hypernyms, hyponyms and meronyms. Currently single words work best as there is only a very limited database of phrases.

If include_plurals is true, then all search terms will also generate additional plural search forms before submission to the databasees. For example, the search term foot will also include a search for feet.

There are three ways to deal with adult terms. You may exclude them completely with 'exclude_adult'; include them as well with 'include_adult'; or fetch adult terms by themselves with 'adult_only'.

If depth is set to 1, then immediate synonyms, meronyms, antonyms, hypernym, hoonym, and sister terms are returned. If set higher, then more distant word forms are returned. A reasonable value is '3'.

The returned results are in the form of an XML-RPC struct. The keys are the original keyphrases and the values are the variations (including the original) of each keyphrase as a list. E.g. If we query with 'table' and 'fish' you will get back something like...

KeyphraseVariations
tabletable, board, furniture, ...
fishfish, aquatic vertebrate, Pisces, ...