The rules of the set, using the same shape as rules in an index definition's resources.
Example
{
"equivalent": [
"car",
"automobile"
]
}
2 properties
equivalentstring[]
Interchangeable terms where each term matches every other term. Multi-word terms match words in sequence.
mappingMapping
A one-way mapping rule: values containing a term in from also match searches for any term in to, but not the reverse.
Example
{
"from": [
"ny"
],
"to": [
"new york"
]
}
2 properties
fromstring[]required
Source terms matched by the mapping rule.
tostring[]required
Target terms that the source terms map to.
fieldsstring[]
An optional list of field names the set applies to, named as a search names them. If omitted, the set applies to every field searched as text. Target fields are validated against the generation the index answers from at write time; a generation promoted later that lacks a named field causes searches to skip that field rather than fail.
boostnumber
A positive number specifying what a term added by the rules counts against the typed term. Default 0.8. Values below 1 rank a document holding the typed term above one holding only a synonym. A value of 1 weighs synonyms and typed terms equally.
Format
float
Example
0.8
Endpoints
Endpoints where the request or responses uses this type.