Add mapping parameters documentation #7115
Conversation
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
@mgodwan I was provided your name as the SME for mappings. Please confirm you're the appropriate point of contact. We need to close documentation content gaps for mappings parameters, including individual pages for each parameter. Thank you. |
Signed-off-by: Melissa Vagi <[email protected]>
hdhalter
added
3 - Tech review
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
hdhalter
added
backport 2.14
|
@ankitkala @mgodwan - Can you please give us an ETA for the tech review? We’ve documented 4 parameters and want to make sure we’re on the right track. We need you to give a general approval. Based on your input, we'll document the remaining parameters. |
|
Checking now |
| The key functions of the `analyzer` mapping parameter are: | ||
|
|
||
| 1. **Tokenization:** The analyzer determines how the text is broken down into individual tokens (words, numbers) that can be indexed and searched. | ||
|
|
||
| 2. **Normalization:** The analyzer can apply various normalization techniques, such as converting text to lowercase, removing stopwords, and stemming/lemmatizing words. | ||
|
|
||
| 3. **Consistency:** By defining the same analyzer for both indexing and searching, you ensure that the text analysis process is consistent, which helps improve the relevance of search results. | ||
|
|
||
| 4. **Customization:** OpenSearch allows you to define custom analyzers by specifying the tokenizer, character filters, and token filters to use. This gives you fine-grained control over the text analysis process. |
There was a problem hiding this comment.
This can all lie in a different page later, which defines how to setup analyzer followed by an index, and can be cross references from the page. [not necessarily as part of scope of this PR]
|
|
||
| The key functions of the `analyzer` mapping parameter are: | ||
|
|
||
| 1. **Tokenization:** The analyzer determines how the text is broken down into individual tokens (words, numbers) that can be indexed and searched. |
There was a problem hiding this comment.
Caveat to call out: Each generated should not be more than 32766 bytes in length as indexing fails otherwise.
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| In this example, the index-level `index.mapping.coerce` setting is set to `false`, which disables coercion globally. However, the `stock_count` field overrides this setting and enables coercion for that specific field. |
There was a problem hiding this comment.
Instead of globally, we should say for this index (globally may imply on the cluster level)
|
|
||
| # `copy-to` | ||
|
|
||
| The `copy-to` parameter allows you to copy the values of multiple fields into a single field. This can be useful if you often search across multiple fields, as it allows you to search the group field instead. |
|
@hdhalter Apologies for the delay in reviewing this earlier. Overall, the direction we're following looks good to me. I've left some high level comments on the documented fields. Are we planning another documentation update where for each field type (e.g. text, integer), we will document the paramters supported for that data type? I would like to see that as well to ensure users are aware how they can customize their mappings for any supported field using these parameters. |
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
added
backport 2.17
Signed-off-by: Melissa Vagi <[email protected]>
Description
Add mapping parameters
Issues Resolved
#4300
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.