You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: solutions/search/full-text/search-with-synonyms.md
+98-46Lines changed: 98 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,13 @@ products:
8
8
- id: elasticsearch
9
9
---
10
10
11
-
# Search with synonyms
11
+
# Search with synonyms[search-with-synonyms]
12
12
13
13
$$$ece-add-custom-bundle-example-synonyms$$$
14
14
::::{note}
15
-
Learn about [adding custom synonym bundles](/solutions/search/full-text/search-with-synonyms.md#ece-add-custom-bundle-example-synonyms) to your {{ece}} deployment.
15
+
Learn about [adding custom synonym bundles](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md) to your {{ece}} deployment.
Synonyms are words or phrases that share the same or similar meaning. Searching using synonyms allows you to:
29
+
30
+
* Improve search relevance by finding relevant documents that use different terms to express the same concept.
31
+
* Make domain-specific vocabulary more user-friendly.
32
+
* Define misspellings and typos to transparently handle common mistakes.
33
+
34
+
## How synonyms work in Elasticsearch
35
+
36
+
To use synonyms in {{es}}, follow this workflow:
37
+
38
+
1.**Create synonym sets and rules**: Define which terms are equivalent and where to store your synonym sets.
39
+
2.**Configure analyzers**: Configure your token filters and analyzers to use them.
40
+
3.**Test and apply**: Verify your configuration works correctly.
30
41
31
-
Synonyms are words or phrases that have the same or similar meaning. They are an important aspect of search, as they can improve the search experience and increase the scope of search results.
42
+
## Synonym rule formats
43
+
44
+
Synonym rules define which terms should be treated as equivalent during search and indexing.
45
+
46
+
There are two main formats for synonym rules: explicit mappings and equivalent mappings.
47
+
48
+
#### Explicit mappings
49
+
50
+
Explicit mappings use `=>` to specify exact replacements:
51
+
52
+
```
53
+
i-pod, i pod => ipod
54
+
sea biscuit, sea biscit => seabiscuit
55
+
```
56
+
57
+
With explicit mappings, the relationship is one-way. In the previous examples:
58
+
-`i-pod` and `i pod` will be replaced with `ipod`, but `ipod` will not be replaced with `i-pod` or `i pod`
59
+
-`sea biscuit` and `sea biscit` will be replaced with `seabiscuit`, but `seabiscuit` will not be replaced with `sea biscuit` or `sea biscit`
60
+
61
+
This is different from equivalent synonyms, which can create bidirectional relationships when `expand=true`.
62
+
63
+
#### Equivalent mappings
64
+
65
+
Equivalent synonyms use commas to group interchangeable terms:
66
+
67
+
```
68
+
ipod, i-pod, i pod
69
+
foozball, foosball
70
+
universe, cosmos
71
+
lol, laughing out loud
72
+
```
32
73
33
-
Synonyms allow you to:
74
+
The behavior of equivalent synonyms depends on the `expand` parameter in your token filter configuration:
75
+
- If `expand=true`: `ipod, i-pod, i pod` creates bidirectional mappings:
76
+
-`ipod` ↔ `i-pod`
77
+
-`ipod` ↔ `i pod`
78
+
-`i-pod` ↔ `i pod`
79
+
- If `expand=false`: `ipod, i-pod, i pod` maps all terms to the first term as canonical:
80
+
-`ipod` → `ipod`
81
+
-`i-pod` → `ipod`
82
+
-`i pod` → `ipod`
34
83
35
-
***Improve search relevance** by finding relevant documents that use different terms to express the same concept.
36
-
* Make **domain-specific vocabulary** more user-friendly, allowing users to use search terms they are more familiar with.
37
-
***Define common misspellings and typos** to transparently handle common mistakes.
84
+
## Step 1: Create synonym sets and rules [synonyms-store-synonyms]
38
85
39
-
Synonyms are grouped together using **synonyms sets**. You can have as many synonyms sets as you need.
86
+
You have multiple options for creating synonym sets and rules.
40
87
41
-
In order to use synonyms sets in {{es}}, you need to:
88
+
### Method 1: {{kib}} UI
42
89
43
-
*[Store your synonyms set](#synonyms-store-synonyms)
44
-
*[Configure synonyms token filters and analyzers](#synonyms-synonym-token-filters)
90
+
```yaml {applies_to}
91
+
serverless:
92
+
elasticsearch:
93
+
```
45
94
95
+
You can create and manage synonym sets and synonym rules using the {{kib}} user interface.
46
96
47
-
## Store your synonyms set [synonyms-store-synonyms]
97
+
To create a synonym set using the UI:
48
98
49
-
Your synonyms sets need to be stored in {{es}} so your analyzers can refer to them. There are three ways to store your synonyms sets:
99
+
1. Navigate to **Elasticsearch** > **Synonyms** or use the [global search field](/explore-analyze/query-filter/filtering.md#_finding_your_apps_and_objects).
100
+
2. Click **Get started**.
101
+
3. Enter a name for your synonym set.
102
+
4. Add your synonym rules in the editor by adding terms to match against:
103
+
- Add **Equivalent rules** by adding multiple equivalent terms. For example: `ipod, i-pod, i pod`
104
+
- Add **Explicit rules** by adding multiple terms that map to a single term. For example: `i-pod, i pod => ipod`
105
+
5. Click **Save** to save your rules.
50
106
107
+
The UI supports the same synonym rule formats as the file-based approach. Changes made through the UI will automatically reload the associated analyzers.
51
108
52
-
### Synonyms API [synonyms-store-synonyms-api]
109
+
### Method 2: REST API [synonyms-store-synonyms-api]
53
110
54
111
You can use the [synonyms APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-synonyms) to manage synonyms sets. This is the most flexible approach, as it allows to dynamically define and modify synonyms sets. For examples of how to
55
-
create or update a synonym set with APIs, refer to the [Create or update synonyms set API examples](/solutions/search/full-text/search-with-synonyms.md) page.
112
+
create or update a synonym set with APIs, refer to the [Create or update synonyms set API examples](/solutions/search/full-text/create-update-synonyms-api-example.md) page.
56
113
57
114
Changes in your synonyms sets will automatically reload the associated analyzers.
A synonyms set file needs to be uploaded to all your cluster nodes, and be located in the configuration directory for your {{es}} distribution. If you’re using {{ech}}, you can upload synonyms files using [custom bundles](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md).
124
+
Make sure you upload a synonyms set file for all your cluster nodes, to the configuration directory for your {{es}} distribution. If you're using {{ech}}, you can upload synonyms files using [custom bundles](../../../deploy-manage/deploy/elastic-cloud/upload-custom-plugins-bundles.md).
# This allows the same synonym file to be used in different synonym handling strategies.
81
142
# Examples:
82
143
ipod, i-pod, i pod
83
-
foozball, foosball
84
-
universe, cosmos
144
+
foozball, foosball
145
+
universe, cosmos
85
146
lol, laughing out loud
86
147
87
148
# If expand==true in the synonym token filter configuration,
@@ -104,27 +165,28 @@ When a synonyms set is updated, search analyzers that use it need to be refreshe
104
165
105
166
This manual syncing and reloading makes this approach less flexible than using the [synonyms API](../../../solutions/search/full-text/search-with-synonyms.md#synonyms-store-synonyms-api).
You can test your synonyms by adding them directly inline in your token filter definition.
111
171
112
172
::::{warning}
113
173
Inline synonyms are not recommended for production usage. A large number of inline synonyms increases cluster size unnecessarily and can lead to performance issues.
114
-
115
174
::::
116
175
117
-
118
-
119
-
### Configure synonyms token filters and analyzers [synonyms-synonym-token-filters]
176
+
## Step 2: Configure synonyms token filters and analyzers [synonyms-synonym-token-filters]
120
177
121
178
Once your synonyms sets are created, you can start configuring your token filters and analyzers to use them.
122
179
123
180
::::{warning}
124
181
Synonyms sets must exist before they can be added to indices. If an index is created referencing a nonexistent synonyms set, the index will remain in a partially created and inoperable state. The only way to recover from this scenario is to ensure the synonyms set exists then either delete and re-create the index, or close and re-open the index.
125
-
126
182
::::
127
183
184
+
{{es}} uses synonyms as part of the [analysis process](../../../manage-data/data-store/text-analysis.md). You can use two types of [token filter](elasticsearch://reference/text-analysis/token-filter-reference.md) to include synonyms:
185
+
186
+
* [Synonym graph](elasticsearch://reference/text-analysis/analysis-synonym-graph-tokenfilter.md): Recommended as it can correctly handle multi-word synonyms.
187
+
* [Synonym](elasticsearch://reference/text-analysis/analysis-synonym-tokenfilter.md): Not recommended if you need to use multi-word synonyms.
188
+
189
+
Check each synonym token filter documentation for configuration details and instructions on adding it to an analyzer.
128
190
129
191
::::{warning}
130
192
Invalid synonym rules can cause errors when applying analyzer changes. For reloadable analyzers, this prevents reloading and applying changes. You must correct errors in the synonym rules and reload the analyzer.
@@ -134,19 +196,9 @@ An index with invalid synonym rules cannot be reopened, making it inoperable whe
134
196
* A node containing the index starts
135
197
* The index is opened from a closed state
136
198
* A node restart occurs (which reopens the node assigned shards)
137
-
138
199
::::
139
200
140
-
141
-
{{es}} uses synonyms as part of the [analysis process](../../../manage-data/data-store/text-analysis.md). You can use two types of [token filter](elasticsearch://reference/text-analysis/token-filter-reference.md) to include synonyms:
142
-
143
-
*[Synonym graph](elasticsearch://reference/text-analysis/analysis-synonym-graph-tokenfilter.md): It is recommended to use it, as it can correctly handle multi-word synonyms ("hurriedly", "in a hurry").
144
-
*[Synonym](elasticsearch://reference/text-analysis/analysis-synonym-tokenfilter.md): Not recommended if you need to use multi-word synonyms.
145
-
146
-
Check each synonym token filter documentation for configuration details and instructions on adding it to an analyzer.
147
-
148
-
149
-
### Test your analyzer [synonyms-test-analyzer]
201
+
## Step 3: Test your analyzer [synonyms-test-analyzer]
150
202
151
203
You can test an analyzer configuration without modifying your index settings. Use the [analyze API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze) to test your analyzer chain:
152
204
@@ -165,17 +217,17 @@ GET /_analyze
165
217
}
166
218
```
167
219
168
-
169
-
### Apply synonyms at index or search time [synonyms-apply-synonyms]
220
+
## Step 4: Apply synonyms at index or search time [synonyms-apply-synonyms]
170
221
171
222
Analyzers can be applied at [index time or search time](../../../manage-data/data-store/text-analysis/index-search-analysis.md).
172
223
173
224
You need to decide when to apply your synonyms:
174
225
175
-
* Index time: Synonyms are applied when the documents are indexed into {{es}}. This is a less flexible alternative, as changes to your synonyms require [reindexing](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex).
176
-
* Search time: Synonyms are applied when a search is executed. This is a more flexible approach, which doesn’t require reindexing. If token filters are configured with `"updateable": true`, search analyzers can be [reloaded](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers) when you make changes to your synonyms.
177
-
178
-
Synonyms sets created using the [synonyms API](../../../solutions/search/full-text/search-with-synonyms.md#synonyms-store-synonyms-api) can only be used at search time.
226
+
* **Index time**: Synonyms are applied when the documents are indexed into {{es}}. This is a less flexible alternative, as changes to your synonyms require [reindexing](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-reindex).
227
+
* **Search time**: Synonyms are applied when a search is executed. This is a more flexible approach, which doesn't require reindexing. If token filters are configured with `"updateable": true`, search analyzers can be [reloaded](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-reload-search-analyzers) when you make changes to your synonyms.
228
+
:::{note}
229
+
Synonyms sets created using the synonyms API or the UI can only be used at search time.
230
+
:::
179
231
180
232
You can specify the analyzer that contains your synonyms set as a [search time analyzer](../../../manage-data/data-store/text-analysis/specify-an-analyzer.md#specify-search-analyzer) or as an [index time analyzer](../../../manage-data/data-store/text-analysis/specify-an-analyzer.md#specify-index-time-analyzer).
181
233
@@ -211,4 +263,4 @@ The following example adds `my_analyzer` as a search analyzer to the `title` fie
0 commit comments