Add Search Synonym

Adds a new synonym for the Search items.

When the term is used in the search query, the synonym is also used for the full-text search. Unless oneWay=true, it works also in the opposite way (synonym -> term).

An example of a synonym can be science fiction for the term sci-fi.

post/{databaseId}/synonyms/items/

Request

Base URL
http://Based on the region of your database (see https://docs.recombee.com/regions).
URL
http://Based on the region of your database (see https://docs.recombee.com/regions)./{databaseId}/synonyms/items/
Auth
none declared

Path parameters

databaseIdstring required

ID of your database.

Request body

termstring required

A word to which the synonym is specified.

synonymstring required

A word that should be considered equal to the term by the full-text search engine.

oneWayboolean

If set to true, only term -> synonym is considered. If set to false, also synonym -> term works.

Default: false.

Response

Successful operation. Returns data about the added synonym (including id).

idstring required

Id of the synonym record

termstring required

A word to which the synonym is specified.

synonymstring required

A word that should be considered equal to term by the full-text search engine.

oneWayboolean required

If set to true, only term -> synonym is considered. I set to false, also synonym -> term works.

Changes

No recorded changes to this operation across all 3 revisions of this API.