Sign in

v1

latestOpenAPI 3.0.3GPL-3.02026-07-177978150.2 KB
synonyms

Create or update a synonym set item

Create or update a synonym set item with the given id

put/synonym_sets/{synonymSetName}/items/{itemId}

Path parameters

synonymSetNamestring required

The name of the synonym set

itemIdstring required

The id of the synonym item to upsert

Request body

synonymsstring[] required

Array of words that should be considered as synonyms

rootstring

For 1-way synonyms, indicates the root word that words in the synonyms parameter map to

localestring

Locale for the synonym, leave blank to use the standard tokenizer

symbols_to_indexstring[]

By default, special characters are dropped from synonyms. Use this attribute to specify which special characters should be indexed as is

Response

Synonym item successfully created/updated

idstring required

Unique identifier for the synonym item

synonymsstring[] required

Array of words that should be considered as synonyms

rootstring

For 1-way synonyms, indicates the root word that words in the synonyms parameter map to

localestring

Locale for the synonym, leave blank to use the standard tokenizer

symbols_to_indexstring[]

By default, special characters are dropped from synonyms. Use this attribute to specify which special characters should be indexed as is