Skip to content

Commit bb7dd2e

Browse files
authored
[DOCS][101] Refine mappings + documents/indices overviews (#112545) (#112698)
1 parent 1d08adf commit bb7dd2e

File tree

2 files changed

+50
-33
lines changed

2 files changed

+50
-33
lines changed

docs/reference/intro.asciidoc

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Use {es} to search, index, store, and analyze data of all shapes and sizes in ne
1414

1515
{es} is used for a wide and growing range of use cases. Here are a few examples:
1616

17-
* *Monitor log and event data*. Store logs, metrics, and event data for observability and security information and event management (SIEM).
18-
* *Build search applications*. Add search capabilities to apps or websites, or build enterprise search engines over your organization's internal data sources.
19-
* *Vector database*. Store and search vectorized data, and create vector embeddings with built-in and third-party natural language processing (NLP) models.
20-
* *Retrieval augmented generation (RAG)*. Use {es} as a retrieval engine to augment Generative AI models.
21-
* *Application and security monitoring*. Monitor and analyze application performance and security data effectively.
22-
* *Machine learning*. Use {ml} to automatically model the behavior of your data in real-time.
17+
* *Monitor log and event data*: Store logs, metrics, and event data for observability and security information and event management (SIEM).
18+
* *Build search applications*: Add search capabilities to apps or websites, or build search engines over internal data.
19+
* *Vector database*: Store and search vectorized data, and create vector embeddings with built-in and third-party natural language processing (NLP) models.
20+
* *Retrieval augmented generation (RAG)*: Use {es} as a retrieval engine to augment generative AI models.
21+
* *Application and security monitoring*: Monitor and analyze application performance and security data.
22+
* *Machine learning*: Use {ml} to automatically model the behavior of your data in real-time.
2323

2424
This is just a sample of search, observability, and security use cases enabled by {es}.
2525
Refer to our https://www.elastic.co/customers/success-stories[customer success stories] for concrete examples across a range of industries.
@@ -41,25 +41,25 @@ https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its
4141
To use {es}, you need a running instance of the {es} service.
4242
You can deploy {es} in various ways:
4343

44-
* <<run-elasticsearch-locally,*Local dev*>>. Get started quickly with a minimal local Docker setup.
45-
* {cloud}/ec-getting-started-trial.html[*Elastic Cloud*]. {es} is available as part of our hosted Elastic Stack offering, deployed in the cloud with your provider of choice. Sign up for a https://cloud.elastic.co/registration[14 day free trial].
46-
* {serverless-docs}/general/sign-up-trial[*Elastic Cloud Serverless* (technical preview)]. Create serverless projects for autoscaled and fully managed {es} deployments. Sign up for a https://cloud.elastic.co/serverless-registration[14 day free trial].
44+
* <<run-elasticsearch-locally,*Local dev*>>: Get started quickly with a minimal local Docker setup.
45+
* {cloud}/ec-getting-started-trial.html[*Elastic Cloud*]: {es} is available as part of our hosted Elastic Stack offering, deployed in the cloud with your provider of choice. Sign up for a https://cloud.elastic.co/registration[14-day free trial].
46+
* {serverless-docs}/general/sign-up-trial[*Elastic Cloud Serverless* (technical preview)]: Create serverless projects for autoscaled and fully managed {es} deployments. Sign up for a https://cloud.elastic.co/serverless-registration[14-day free trial].
4747

4848
**Advanced deployment options**
4949

50-
* <<elasticsearch-deployment-options,*Self-managed*>>. Install, configure, and run {es} on your own premises.
51-
* {ece-ref}/Elastic-Cloud-Enterprise-overview.html[*Elastic Cloud Enterprise*]. Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises.
52-
* {eck-ref}/k8s-overview.html[*Elastic Cloud on Kubernetes*]. Deploy Elastic Cloud on Kubernetes.
50+
* <<elasticsearch-deployment-options,*Self-managed*>>: Install, configure, and run {es} on your own premises.
51+
* {ece-ref}/Elastic-Cloud-Enterprise-overview.html[*Elastic Cloud Enterprise*]: Deploy Elastic Cloud on public or private clouds, virtual machines, or your own premises.
52+
* {eck-ref}/k8s-overview.html[*Elastic Cloud on Kubernetes*]: Deploy Elastic Cloud on Kubernetes.
5353

5454
[discrete]
5555
[[elasticsearch-next-steps]]
5656
=== Learn more
5757

58-
Some resources to help you get started:
58+
Here are some resources to help you get started:
5959

60-
* <<getting-started, Quickstart>>. A beginner's guide to deploying your first {es} instance, indexing data, and running queries.
61-
* https://elastic.co/webinars/getting-started-elasticsearch[Webinar: Introduction to {es}]. Register for our live webinars to learn directly from {es} experts.
62-
* https://www.elastic.co/search-labs[Elastic Search Labs]. Tutorials and blogs that explore AI-powered search using the latest {es} features.
60+
* <<getting-started, Quickstart>>: A beginner's guide to deploying your first {es} instance, indexing data, and running queries.
61+
* https://elastic.co/webinars/getting-started-elasticsearch[Webinar: Introduction to {es}]: Register for our live webinars to learn directly from {es} experts.
62+
* https://www.elastic.co/search-labs[Elastic Search Labs]: Tutorials and blogs that explore AI-powered search using the latest {es} features.
6363
** Follow our tutorial https://www.elastic.co/search-labs/tutorials/search-tutorial/welcome[to build a hybrid search solution in Python].
6464
** Check out the https://github.com/elastic/elasticsearch-labs?tab=readme-ov-file#elasticsearch-examples--apps[`elasticsearch-labs` repository] for a range of Python notebooks and apps for various use cases.
6565

@@ -133,9 +133,9 @@ In {es}, metadata fields are prefixed with an underscore.
133133

134134
The most important metadata fields are:
135135

136-
* `_source`. Contains the original JSON document.
137-
* `_index`. The name of the index where the document is stored.
138-
* `_id`. The document's ID. IDs must be unique per index.
136+
* `_source`: Contains the original JSON document.
137+
* `_index`: The name of the index where the document is stored.
138+
* `_id`: The document's ID. IDs must be unique per index.
139139

140140
[discrete]
141141
[[elasticsearch-intro-documents-fields-mappings]]
@@ -146,8 +146,8 @@ A mapping defines the <<mapping-types,data type>> for each field, how the field
146146
and how it should be stored.
147147
When adding documents to {es}, you have two options for mappings:
148148

149-
* <<mapping-dynamic, Dynamic mapping>>. Let {es} automatically detect the data types and create the mappings for you. This is great for getting started quickly.
150-
* <<mapping-explicit, Explicit mapping>>. Define the mappings up front by specifying data types for each field. Recommended for production use cases.
149+
* <<mapping-dynamic, Dynamic mapping>>: Let {es} automatically detect the data types and create the mappings for you. This is great for getting started quickly, but can lead to unexpected results for complex data.
150+
* <<mapping-explicit, Explicit mapping>>: Define the mappings up front by specifying data types for each field. Recommended for production use cases, because you have much more control over how your data is indexed.
151151

152152
[TIP]
153153
====

docs/reference/mapping.asciidoc

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,25 +33,42 @@ mapping values by overriding values in the mapping during the search request.
3333
[discrete]
3434
[[mapping-dynamic]]
3535
== Dynamic mapping
36-
<<dynamic-field-mapping,Dynamic mapping>> allows you to experiment with
37-
and explore data when you’re just getting started. {es} adds new fields
38-
automatically, just by indexing a document. You can add fields to the top-level
39-
mapping, and to inner <<object,`object`>> and <<nested,`nested`>> fields.
36+
37+
When you use <<dynamic-field-mapping,dynamic mapping>>, {es} automatically
38+
attempts to detect the data type of fields in your documents. This allows
39+
you to get started quickly by just adding data to an index. If you index
40+
additional documents with new fields, {es} will add these fields automatically.
41+
You can add fields to the top-level mapping, and to inner <<object,`object`>>
42+
and <<nested,`nested`>> fields.
4043

4144
Use <<dynamic-templates,dynamic templates>> to define custom mappings that are
4245
applied to dynamically added fields based on the matching condition.
4346

4447
[discrete]
4548
[[mapping-explicit]]
4649
== Explicit mapping
47-
<<explicit-mapping,Explicit mapping>> allows you to precisely choose how to
48-
define the mapping definition, such as:
49-
50-
* Which string fields should be treated as full text fields.
51-
* Which fields contain numbers, dates, or geolocations.
52-
* The <<mapping-date-format,format>> of date values.
53-
* Custom rules to control the mapping for
54-
<<dynamic-mapping,dynamically added fields>>.
50+
51+
Use <<explicit-mapping,explicit mapping>> to define exactly how data types
52+
are mapped to fields, customized to your specific use case.
53+
54+
Defining your own mappings enables you to:
55+
56+
* Define which string fields should be treated as full-text fields.
57+
* Define which fields contain numbers, dates, or geolocations.
58+
* Use data types that cannot be automatically detected (such as `geo_point` and `geo_shape`.)
59+
* Choose date value <<mapping-date-format,formats>>, including custom date formats.
60+
* Create custom rules to control the mapping for <<dynamic-mapping,dynamically added fields>>.
61+
* Optimize fields for partial matching.
62+
* Perform language-specific text analysis.
63+
64+
[TIP]
65+
====
66+
It’s often useful to index the same field in different ways for different purposes.
67+
For example, you might want to index a string field as both a text field for full-text
68+
search and as a keyword field for sorting or aggregating your data. Or, you might
69+
choose to use more than one language analyzer to process the contents of a string field
70+
that contains user input.
71+
====
5572

5673
Use <<runtime-mapping-fields,runtime fields>> to make schema changes without
5774
reindexing. You can use runtime fields in conjunction with indexed fields to

0 commit comments

Comments
 (0)