Skip to content

Commit 16a7434

Browse files
authored
Merge branch 'main' into szabosteve/anomaly-detection-refine
2 parents 858f675 + 75b6666 commit 16a7434

File tree

9 files changed

+106
-147
lines changed

9 files changed

+106
-147
lines changed

raw-migrated-files/docs-content/serverless/elasticsearch-connecting-to-es-serverless-endpoint.md

Lines changed: 0 additions & 90 deletions
This file was deleted.

raw-migrated-files/toc.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -272,11 +272,9 @@ toc:
272272
- file: docs-content/serverless/data-views.md
273273
- file: docs-content/serverless/detections-logsdb-index-mode-impact.md
274274
- file: docs-content/serverless/elasticsearch-clients.md
275-
- file: docs-content/serverless/elasticsearch-connecting-to-es-serverless-endpoint.md
276275
- file: docs-content/serverless/elasticsearch-dev-tools.md
277276
- file: docs-content/serverless/elasticsearch-differences.md
278277
- file: docs-content/serverless/elasticsearch-explore-your-data.md
279-
- file: docs-content/serverless/elasticsearch-get-started.md
280278
- file: docs-content/serverless/elasticsearch-http-apis.md
281279
- file: docs-content/serverless/elasticsearch-ingest-data-file-upload.md
282280
- file: docs-content/serverless/elasticsearch-ingest-data-through-api.md
@@ -616,8 +614,6 @@ toc:
616614
- file: elasticsearch/elasticsearch-reference/field-level-security.md
617615
- file: elasticsearch/elasticsearch-reference/file-realm.md
618616
- file: elasticsearch/elasticsearch-reference/fips-140-compliance.md
619-
- file: elasticsearch/elasticsearch-reference/full-text-filter-tutorial.md
620-
- file: elasticsearch/elasticsearch-reference/getting-started.md
621617
- file: elasticsearch/elasticsearch-reference/how-monitoring-works.md
622618
- file: elasticsearch/elasticsearch-reference/ignore_missing_component_templates.md
623619
- file: elasticsearch/elasticsearch-reference/index-lifecycle-management.md
@@ -649,7 +645,6 @@ toc:
649645
- file: elasticsearch/elasticsearch-reference/retrievers-overview.md
650646
- file: elasticsearch/elasticsearch-reference/role-mapping-resources.md
651647
- file: elasticsearch/elasticsearch-reference/rollup-overview.md
652-
- file: elasticsearch/elasticsearch-reference/run-elasticsearch-locally.md
653648
- file: elasticsearch/elasticsearch-reference/saml-guide-stack.md
654649
- file: elasticsearch/elasticsearch-reference/saml-realm.md
655650
- file: elasticsearch/elasticsearch-reference/scalability.md
@@ -720,7 +715,6 @@ toc:
720715
- file: kibana/kibana/save-load-delete-query.md
721716
- file: kibana/kibana/saved-object-ids.md
722717
- file: kibana/kibana/search-ai-assistant.md
723-
- file: kibana/kibana/search-space-connection-details.md
724718
- file: kibana/kibana/secure-reporting.md
725719
- file: kibana/kibana/secure-settings.md
726720
- file: kibana/kibana/Security-production-considerations.md
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# API quickstarts
2+
3+
Use the following quickstarts to get hands-on experience with Elasticsearch APIs and tools:
4+
5+
- [Index and search data using Elasticsearch APIs](elasticsearch-basics-quickstart.md): Learn about indices, documents, and mappings, and perform a basic search using the Query DSL.
6+
- [Basic full-text search and filtering in Elasticsearch](querydsl-full-text-filter-tutorial.md): Learn about different options for querying data, including full-text search and filtering, using the Query DSL.
7+
- [Analyze eCommerce data with aggregations using Query DSL](/explore-analyze/aggregations/tutorial-analyze-ecommerce-data-with-aggregations-using-query-dsl.md): Learn how to analyze data using different types of aggregations, including metrics, buckets, and pipelines.
8+
% - [Getting started with ES|QL](esql-getting-started.md): Learn how to query and aggregate your data using ES|QL.
9+
- [Semantic search](semantic-search/semantic-search-semantic-text.md): Learn how to create embeddings for your data with `semantic_text` and query using the `semantic` query.
10+
- [Hybrid search](semantic-search/semantic-text-hybrid-search.md): Learn how to combine semantic search using`semantic_text` with full-text search.
11+
- [Bring your own dense vector embeddings](semantic-search/bring-own-vectors.md): Learn how to ingest dense vector embeddings into Elasticsearch.
12+
13+
:::{tip}
14+
To run the quickstarts, you need a running Elasticsearch cluster. Use [`start-local`](https://github.com/elastic/start-local) to set up a fast local dev environment in Docker, together with Kibana. Run the following command in your terminal:
15+
16+
```sh
17+
curl -fsSL https://elastic.co/start-local | sh
18+
```
19+
<br>
20+
Alternatively, refer to our other [deployment options](/deploy-manage/index.md).
21+
% TODO: UPDATE LINK
22+
:::
Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
1-
---
2-
navigation_title: "Basics: Index and search using APIs"
3-
---
1+
# {{es}} API quickstart [getting-started]
42

5-
# Index and search data using {{es}} APIs [getting-started]
63

7-
8-
This quick start guide is a hands-on introduction to the fundamental concepts of Elasticsearch: [indices, documents and field type mappings](../../../manage-data/data-store/index-basics.md).
4+
This quick start guide is a hands-on introduction to the fundamental concepts of Elasticsearch: [indices, documents and field type mappings](../../manage-data/data-store/index-basics.md).
95

106
You’ll learn how to create an index, add data as documents, work with dynamic and explicit mappings, and perform your first basic searches.
117

128
::::{tip}
13-
The code examples in this tutorial are in [Console](../../../explore-analyze/query-filter/tools/console.md) syntax by default. You can [convert into other programming languages](../../../explore-analyze/query-filter/tools/console.md#import-export-console-requests) in the Console UI.
9+
The code examples in this tutorial are in [Console](../../explore-analyze/query-filter/tools/console.md) syntax by default. You can [convert into other programming languages](../../explore-analyze/query-filter/tools/console.md#import-export-console-requests) in the Console UI.
1410

1511
::::
1612

1713

1814

1915
## Requirements [getting-started-requirements]
2016

21-
You’ll need a running {{es}} cluster, together with {{kib}} to use the Dev Tools API Console. Run the following command in your terminal to set up a [single-node local cluster in Docker](../../../solutions/search/get-started.md):
17+
You’ll need a running {{es}} cluster, together with {{kib}} to use the Dev Tools API Console. Run the following command in your terminal to set up a [single-node local cluster in Docker](get-started.md):
2218

2319
```sh
2420
curl -fsSL https://elastic.co/start-local | sh
@@ -51,7 +47,7 @@ The following response indicates the index was created successfully.
5147
## Step 2: Add data to your index [getting-started-add-documents]
5248

5349
::::{tip}
54-
This tutorial uses {{es}} APIs, but there are many other ways to [add data to {{es}}](../../../solutions/search/ingest-for-search.md).
50+
This tutorial uses {{es}} APIs, but there are many other ways to [add data to {{es}}](ingest-for-search.md).
5551

5652
::::
5753

@@ -102,7 +98,7 @@ The response includes metadata that {{es}} generates for the document, including
10298
2. The `_id` field is the unique identifier for the document.
10399
3. The `_version` field indicates the version of the document.
104100
4. The `result` field indicates the result of the indexing operation.
105-
5. The `_shards` field contains information about the number of [shards](../../../deploy-manage/index.md) that the indexing operation was executed on and the number that succeeded.
101+
5. The `_shards` field contains information about the number of [shards](../../deploy-manage/index.md) that the indexing operation was executed on and the number that succeeded.
106102
6. The `total` field indicates the total number of shards for the index.
107103
7. The `successful` field indicates the number of shards that the indexing operation was executed on.
108104
8. The `failed` field indicates the number of shards that failed during the indexing operation. *0* indicates no failures.
@@ -230,7 +226,7 @@ You should receive a response indicating there were no errors.
230226

231227
## Step 3: Define mappings and data types [getting-started-mappings-and-data-types]
232228

233-
[Mappings](../../../manage-data/data-store/index-basics.md#elasticsearch-intro-documents-fields-mappings) define how data is stored and indexed in {{es}}, like a schema in a relational database.
229+
[Mappings](../../manage-data/data-store/index-basics.md#elasticsearch-intro-documents-fields-mappings) define how data is stored and indexed in {{es}}, like a schema in a relational database.
234230

235231

236232
### Use dynamic mapping [getting-started-dynamic-mapping]
@@ -348,12 +344,12 @@ PUT /my-explicit-mappings-books
348344

349345
Explicit mappings are defined at index creation, and documents must conform to these mappings. You can also use the [Update mapping API](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html). When an index has the `dynamic` flag set to `true`, you can add new fields to documents without updating the mapping.
350346

351-
This allows you to combine explicit and dynamic mappings. Learn more about [managing and updating mappings](../../../manage-data/data-store/mapping.md#mapping-manage-update).
347+
This allows you to combine explicit and dynamic mappings. Learn more about [managing and updating mappings](../../manage-data/data-store/mapping.md#mapping-manage-update).
352348

353349

354350
## Step 4: Search your index [getting-started-search-data]
355351

356-
Indexed documents are available for search in near real-time, using the [`_search` API](../../../solutions/search/querying-for-search.md).
352+
Indexed documents are available for search in near real-time, using the [`_search` API](querying-for-search.md).
357353

358354

359355
### Search all documents [getting-started-search-all-documents]

0 commit comments

Comments
 (0)