forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathanalyzer.html
463 lines (440 loc) · 21.1 KB
/
analyzer.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>analyzer | Elasticsearch Guide [5.3] | Elastic</title>
<meta class="elastic" name="content" content="analyzer | Elasticsearch Guide [5.3]">
<link rel="home" href="index.html" title="Elasticsearch Guide [5.3]"/>
<link rel="up" href="mapping-params.html" title="Mapping parameters"/>
<link rel="prev" href="mapping-params.html" title="Mapping parameters"/>
<link rel="next" href="normalizer.html" title="normalizer"/>
<meta class="elastic" name="product_version" content="5.3"/>
<meta class="elastic" name="product_name" content="Elasticsearch"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/5.3"/>
<meta name="DC.subject" content="Elasticsearch"/>
<meta name="DC.identifier" content="5.3"/>
<meta name="robots" content="noindex,nofollow"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles.css" />
</head>
<!--© 2015-2022 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [5.3]</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="mapping.html">Mapping</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="mapping-params.html">Mapping parameters</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="mapping-params.html">« Mapping parameters</a>
</span>
<span class="next">
<a href="normalizer.html"><code class="literal">normalizer</code> »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="analyzer"></a><code class="literal">analyzer</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/5.3/docs/reference/mapping/params/analyzer.asciidoc">edit</a></h2>
</div></div></div>
<p>The values of <a class="xref" href="mapping-index.html" title="index"><code class="literal">analyzed</code></a> string fields are passed through an
<a class="xref" href="analysis.html" title="Analysis">analyzer</a> to convert the string into a stream of <em>tokens</em> or
<em>terms</em>. For instance, the string <code class="literal">"The quick Brown Foxes."</code> may, depending
on which analyzer is used, be analyzed to the tokens: <code class="literal">quick</code>, <code class="literal">brown</code>,
<code class="literal">fox</code>. These are the actual terms that are indexed for the field, which makes
it possible to search efficiently for individual words <em>within</em> big blobs of
text.</p>
<p>This analysis process needs to happen not just at index time, but also at
query time: the query string needs to be passed through the same (or a
similar) analyzer so that the terms that it tries to find are in the same
format as those that exist in the index.</p>
<p>Elasticsearch ships with a number of <a class="xref" href="analysis-analyzers.html" title="Analyzers">pre-defined analyzers</a>,
which can be used without further configuration. It also ships with many
<a class="xref" href="analysis-charfilters.html" title="Character Filters">character filters</a>, <a class="xref" href="analysis-tokenizers.html" title="Tokenizers">tokenizers</a>,
and <a class="xref" href="analysis-tokenfilters.html" title="Token Filters"><em>Token Filters</em></a> which can be combined to configure
custom analyzers per index.</p>
<p>Analyzers can be specified per-query, per-field or per-index. At index time,
Elasticsearch will look for an analyzer in this order:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
The <code class="literal">analyzer</code> defined in the field mapping.
</li>
<li class="listitem">
An analyzer named <code class="literal">default</code> in the index settings.
</li>
<li class="listitem">
The <a class="xref" href="analysis-standard-analyzer.html" title="Standard Analyzer"><code class="literal">standard</code></a> analyzer.
</li>
</ul>
</div>
<p>At query time, there are a few more layers:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
The <code class="literal">analyzer</code> defined in a <a class="xref" href="full-text-queries.html" title="Full text queries">full-text query</a>.
</li>
<li class="listitem">
The <code class="literal">search_analyzer</code> defined in the field mapping.
</li>
<li class="listitem">
The <code class="literal">analyzer</code> defined in the field mapping.
</li>
<li class="listitem">
An analyzer named <code class="literal">default_search</code> in the index settings.
</li>
<li class="listitem">
An analyzer named <code class="literal">default</code> in the index settings.
</li>
<li class="listitem">
The <a class="xref" href="analysis-standard-analyzer.html" title="Standard Analyzer"><code class="literal">standard</code></a> analyzer.
</li>
</ul>
</div>
<p>The easiest way to specify an analyzer for a particular field is to define it
in the field mapping, as follows:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT /my_index
{
"mappings": {
"my_type": {
"properties": {
"text": { <a id="CO204-1"></a><i class="conum" data-value="1"></i>
"type": "text",
"fields": {
"english": { <a id="CO204-2"></a><i class="conum" data-value="2"></i>
"type": "text",
"analyzer": "english"
}
}
}
}
}
}
}
GET my_index/_analyze <a id="CO204-3"></a><i class="conum" data-value="3"></i>
{
"field": "text",
"text": "The quick Brown Foxes."
}
GET my_index/_analyze <a id="CO204-4"></a><i class="conum" data-value="4"></i>
{
"field": "text.english",
"text": "The quick Brown Foxes."
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/769.console"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO204-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>The <code class="literal">text</code> field uses the default <code class="literal">standard</code> analyzer`.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO204-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>The <code class="literal">text.english</code> <a class="xref" href="multi-fields.html" title="fields">multi-field</a> uses the <code class="literal">english</code> analyzer, which removes stop words and applies stemming.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO204-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>This returns the tokens: [ <code class="literal">the</code>, <code class="literal">quick</code>, <code class="literal">brown</code>, <code class="literal">foxes</code> ].</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO204-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p>This returns the tokens: [ <code class="literal">quick</code>, <code class="literal">brown</code>, <code class="literal">fox</code> ].</p>
</td>
</tr>
</table>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="search-quote-analyzer"></a><code class="literal">search_quote_analyzer</code><a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/5.3/docs/reference/mapping/params/analyzer.asciidoc">edit</a></h3>
</div></div></div>
<p>The <code class="literal">search_quote_analyzer</code> setting allows you to specify an analyzer for phrases, this is particularly useful when dealing with disabling
stop words for phrase queries.</p>
<p>To disable stop words for phrases a field utilising three analyzer settings will be required:</p>
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
An <code class="literal">analyzer</code> setting for indexing all terms including stop words
</li>
<li class="listitem">
A <code class="literal">search_analyzer</code> setting for non-phrase queries that will remove stop words
</li>
<li class="listitem">
A <code class="literal">search_quote_analyzer</code> setting for phrase queries that will not remove stop words
</li>
</ol>
</div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT my_index
{
"settings":{
"analysis":{
"analyzer":{
"my_analyzer":{ <a id="CO205-1"></a><i class="conum" data-value="1"></i>
"type":"custom",
"tokenizer":"standard",
"filter":[
"lowercase"
]
},
"my_stop_analyzer":{ <a id="CO205-2"></a><i class="conum" data-value="2"></i>
"type":"custom",
"tokenizer":"standard",
"filter":[
"lowercase",
"english_stop"
]
}
},
"filter":{
"english_stop":{
"type":"stop",
"stopwords":"_english_"
}
}
}
},
"mappings":{
"my_type":{
"properties":{
"title": {
"type":"text",
"analyzer":"my_analyzer", <a id="CO205-3"></a><i class="conum" data-value="3"></i>
"search_analyzer":"my_stop_analyzer", <a id="CO205-4"></a><i class="conum" data-value="4"></i>
"search_quote_analyzer":"my_analyzer" <a id="CO205-5"></a><i class="conum" data-value="5"></i>
}
}
}
}
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/770.console"></div>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">PUT my_index/my_type/1
{
"title":"The Quick Brown Fox"
}
PUT my_index/my_type/2
{
"title":"A Quick Brown Fox"
}
GET my_index/my_type/_search
{
"query":{
"query_string":{
"query":"\"the quick brown fox\"" <a id="CO205-6"></a><i class="conum" data-value="6"></i>
}
}
}</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO205-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p><code class="literal">my_analyzer</code> analyzer which tokens all terms including stop words</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO205-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p><code class="literal">my_stop_analyzer</code> analyzer which removes stop words</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO205-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p><code class="literal">analyzer</code> setting that points to the <code class="literal">my_analyzer</code> analyzer which will be used at index time</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO205-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p><code class="literal">search_analyzer</code> setting that points to the <code class="literal">my_stop_analyzer</code> and removes stop words for non-phrase queries</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO205-5"><i class="conum" data-value="5"></i></a></p>
</td>
<td align="left" valign="top">
<p><code class="literal">search_quote_analyzer</code> setting that points to the <code class="literal">my_analyzer</code> analyzer and ensures that stop words are not removed from phrase queries</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO205-6"><i class="conum" data-value="6"></i></a></p>
</td>
<td align="left" valign="top">
<p>Since the query is wrapped in quotes it is detected as a phrase query therefore the <code class="literal">search_quote_analyzer</code> kicks in and ensures the stop words
are not removed from the query. The <code class="literal">my_analyzer</code> analyzer will then return the following tokens [<code class="literal">the</code>, <code class="literal">quick</code>, <code class="literal">brown</code>, <code class="literal">fox</code>] which will match one
of the documents. Meanwhile term queries will be analyzed with the <code class="literal">my_stop_analyzer</code> analyzer which will filter out stop words. So a search for either
<code class="literal">The quick brown fox</code> or <code class="literal">A quick brown fox</code> will return both documents since both documents contain the following tokens [<code class="literal">quick</code>, <code class="literal">brown</code>, <code class="literal">fox</code>].
Without the <code class="literal">search_quote_analyzer</code> it would not be possible to do exact matches for phrase queries as the stop words from phrase queries would be
removed resulting in both documents matching.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="mapping-params.html">« Mapping parameters</a>
</span>
<span class="next">
<a href="normalizer.html"><code class="literal">normalizer</code> »</a>
</span>
</div>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>