[DOCS] Rewrite analysis intro#51184
[DOCS] Rewrite analysis intro#51184jrodewig merged 5 commits intoelastic:masterfrom jrodewig:docs__analysis_intro
Conversation
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-search (:Search/Analysis) |
* Rewrites 'Text analysis' page intro as high-level definition. Adds guidance on when users should configure text analysis * Rewrites and splits index/search analysis content: * Conceptual content -> 'Index and search analysis' under 'Concepts' * Task-based content -> 'Specify an analyzer' under 'Configure...' * Adds detailed examples for when to use the same index/search analyzer and when not. * Adds new example snippets for specifying search analyzers
|
@debadair Any feedback on this one? Thanks! |
docs/reference/analysis.asciidoc
Outdated
|
|
||
| For instance, at index time the built-in <<english-analyzer,`english`>> _analyzer_ | ||
| will first convert the sentence: | ||
| {es} comes with smart defaults for text analysis. These defaults work well for |
There was a problem hiding this comment.
smart defaults? ES just uses a default (standard) analyzer for text fields, which many not be the best option for many use cases.
docs/reference/analysis.asciidoc
Outdated
| stopwords ("the") and reduce the terms to their word stems (foxes -> fox, | ||
| jumped -> jump, lazy -> lazi). In the end, the following terms will be added | ||
| to the inverted index: | ||
| However, there are less common cases where configuring text analysis is |
There was a problem hiding this comment.
I don't think that configuring an analyzer is an uncommon use case, I would think it should be quite common for text fields.
May be to rephrase something like, if your index doesn't use text fields, you may skip chapters in this section.
There was a problem hiding this comment.
Good point! It's clearer if we just directly state that that if you use text fields, take a look. If not, go ahead and skip this section.
Made those changes with a2f08d2.
|
|
||
| In most cases, a simple approach works best: Specify an analyzer for each | ||
| `text` field, as outlined in <<specify-index-field-analyzer>>. No other | ||
| analyzers need to be specified. |
There was a problem hiding this comment.
No other analyzers need to be specified.
This is not very clear for me. Sorry, if I misinterpreted this paragraph.
Analyzers are only specified for text fields, so it is impossible to specify analyzers for any other field types.
There was a problem hiding this comment.
That sentence was referring to specifying an index analyzer or field-level search analyzer. However, I agree with you: this paragraph is clearer without that sentence. Thanks!
| |`appli` | | X | ||
| |=== | ||
|
|
||
| This means the search would erroneously match `apple`. Not only that, it would |
There was a problem hiding this comment.
This is a very good example.
Another example could be a use case with synonyms, where we specify synonym filter only during search, as it is redundant to use synonyms both at indexing and querying.
mayya-sharipova
left a comment
There was a problem hiding this comment.
@jrodewig Thanks, great PR.
I can't comment and review the organization of files, but the content LGTM.
|
Thanks so much for your review @mayya-sharipova! |
* [DOCS] Rewrite analysis intro. Move index/search analysis content. * Rewrites 'Text analysis' page intro as high-level definition. Adds guidance on when users should configure text analysis * Rewrites and splits index/search analysis content: * Conceptual content -> 'Index and search analysis' under 'Concepts' * Task-based content -> 'Specify an analyzer' under 'Configure...' * Adds detailed examples for when to use the same index/search analyzer and when not. * Adds new example snippets for specifying search analyzers * clarifications * Add toc. Decrement headings. * Reword 'When to configure' section * Remove sentence from tip
* [DOCS] Rewrite analysis intro. Move index/search analysis content. * Rewrites 'Text analysis' page intro as high-level definition. Adds guidance on when users should configure text analysis * Rewrites and splits index/search analysis content: * Conceptual content -> 'Index and search analysis' under 'Concepts' * Task-based content -> 'Specify an analyzer' under 'Configure...' * Adds detailed examples for when to use the same index/search analyzer and when not. * Adds new example snippets for specifying search analyzers * clarifications * Add toc. Decrement headings. * Reword 'When to configure' section * Remove sentence from tip
* [DOCS] Rewrite analysis intro. Move index/search analysis content. * Rewrites 'Text analysis' page intro as high-level definition. Adds guidance on when users should configure text analysis * Rewrites and splits index/search analysis content: * Conceptual content -> 'Index and search analysis' under 'Concepts' * Task-based content -> 'Specify an analyzer' under 'Configure...' * Adds detailed examples for when to use the same index/search analyzer and when not. * Adds new example snippets for specifying search analyzers * clarifications * Add toc. Decrement headings. * Reword 'When to configure' section * Remove sentence from tip
Changes
Adds guidance on when users should configure text analysis
and when not.
Previews
http://elasticsearch_51184.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/analysis.html
http://elasticsearch_51184.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/analysis-index-search-time.html
http://elasticsearch_51184.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/specify-analyzer.html