OpenSearch/docs/reference/analysis.asciidoc
James Rodewig 4fcf5a9de4 [DOCS] Rewrite analysis intro (#51184)
* [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
2020-01-30 09:32:16 -05:00

58 lines
1.4 KiB
Plaintext

[[analysis]]
= Text analysis
[partintro]
--
_Text analysis_ is the process of converting unstructured text, like
the body of an email or a product description, into a structured format that's
optimized for search.
[float]
[[when-to-configure-analysis]]
=== When to configure text analysis
{es} performs text analysis when indexing or searching <<text,`text`>> fields.
If your index doesn't contain `text` fields, no further setup is needed; you can
skip the pages in this section.
However, if you use `text` fields or your text searches aren't returning results
as expected, configuring text analysis can often help. You should also look into
analysis configuration if you're using {es} to:
* Build a search engine
* Mine unstructured data
* Fine-tune search for a specific language
* Perform lexicographic or linguistic research
[float]
[[analysis-toc]]
=== In this section
* <<analysis-overview>>
* <<analysis-concepts>>
* <<configure-text-analysis>>
* <<analysis-analyzers>>
* <<analysis-tokenizers>>
* <<analysis-tokenfilters>>
* <<analysis-charfilters>>
* <<analysis-normalizers>>
--
include::analysis/overview.asciidoc[]
include::analysis/concepts.asciidoc[]
include::analysis/configure-text-analysis.asciidoc[]
include::analysis/analyzers.asciidoc[]
include::analysis/tokenizers.asciidoc[]
include::analysis/tokenfilters.asciidoc[]
include::analysis/charfilters.asciidoc[]
include::analysis/normalizers.asciidoc[]