Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Search] Refactor get started #305

Merged
merged 2 commits into from
Feb 4, 2025
Merged

[Search] Refactor get started #305

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2a4f6e
[Search] Refactor get started
leemthompo Feb 4, 2025
ddeb687
fix link
leemthompo Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 0 additions & 90 deletions ...s/docs-content/serverless/elasticsearch-connecting-to-es-serverless-endpoint.md
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions raw-migrated-files/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,11 +272,9 @@ toc:
- file: docs-content/serverless/data-views.md
- file: docs-content/serverless/detections-logsdb-index-mode-impact.md
- file: docs-content/serverless/elasticsearch-clients.md
- file: docs-content/serverless/elasticsearch-connecting-to-es-serverless-endpoint.md
- file: docs-content/serverless/elasticsearch-dev-tools.md
- file: docs-content/serverless/elasticsearch-differences.md
- file: docs-content/serverless/elasticsearch-explore-your-data.md
- file: docs-content/serverless/elasticsearch-get-started.md
- file: docs-content/serverless/elasticsearch-http-apis.md
- file: docs-content/serverless/elasticsearch-ingest-data-file-upload.md
- file: docs-content/serverless/elasticsearch-ingest-data-through-api.md
Expand Down Expand Up @@ -616,8 +614,6 @@ toc:
- file: elasticsearch/elasticsearch-reference/field-level-security.md
- file: elasticsearch/elasticsearch-reference/file-realm.md
- file: elasticsearch/elasticsearch-reference/fips-140-compliance.md
- file: elasticsearch/elasticsearch-reference/full-text-filter-tutorial.md
- file: elasticsearch/elasticsearch-reference/getting-started.md
- file: elasticsearch/elasticsearch-reference/how-monitoring-works.md
- file: elasticsearch/elasticsearch-reference/ignore_missing_component_templates.md
- file: elasticsearch/elasticsearch-reference/index-lifecycle-management.md
Expand Down Expand Up @@ -649,7 +645,6 @@ toc:
- file: elasticsearch/elasticsearch-reference/retrievers-overview.md
- file: elasticsearch/elasticsearch-reference/role-mapping-resources.md
- file: elasticsearch/elasticsearch-reference/rollup-overview.md
- file: elasticsearch/elasticsearch-reference/run-elasticsearch-locally.md
- file: elasticsearch/elasticsearch-reference/saml-guide-stack.md
- file: elasticsearch/elasticsearch-reference/saml-realm.md
- file: elasticsearch/elasticsearch-reference/scalability.md
Expand Down Expand Up @@ -720,7 +715,6 @@ toc:
- file: kibana/kibana/save-load-delete-query.md
- file: kibana/kibana/saved-object-ids.md
- file: kibana/kibana/search-ai-assistant.md
- file: kibana/kibana/search-space-connection-details.md
- file: kibana/kibana/secure-reporting.md
- file: kibana/kibana/secure-settings.md
- file: kibana/kibana/Security-production-considerations.md
Expand Down
22 changes: 22 additions & 0 deletions solutions/search/api-quickstarts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# API quickstarts

Use the following quickstarts to get hands-on experience with Elasticsearch APIs and tools:

- [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.
- [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.
- [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.
% - [Getting started with ES|QL](esql-getting-started.md): Learn how to query and aggregate your data using ES|QL.
- [Semantic search](semantic-search/semantic-search-semantic-text.html): Learn how to create embeddings for your data with `semantic_text` and query using the `semantic` query.

Check failure on line 9 in solutions/search/api-quickstarts.md

View workflow job for this annotation

GitHub Actions / preview / build 

`semantic-search/semantic-search-semantic-text.html` does not exist. resolved to `/github/workspace/solutions/search/semantic-search/semantic-search-semantic-text.html
- [Hybrid search](semantic-search/semantic-text-hybrid-search.md): Learn how to combine semantic search using`semantic_text` with full-text search.
- [Bring your own dense vector embeddings](semantic-search/bring-own-vectors.md): Learn how to ingest dense vector embeddings into Elasticsearch.

:::{tip}
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:

```sh
curl -fsSL https://elastic.co/start-local | sh
```
<br>
Alternatively, refer to our other [deployment options](/deploy-manage/index.md).
% TODO: UPDATE LINK
:::
22 changes: 9 additions & 13 deletions ...lasticsearch-reference/getting-started.md → ...search/elasticsearch-basics-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
---
navigation_title: "Basics: Index and search using APIs"
---
# {{es}} API quickstart [getting-started]

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


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).
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).

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

::::{tip}
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.
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.

::::



## Requirements [getting-started-requirements]

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):
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):

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

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

::::

Expand Down Expand Up @@ -102,7 +98,7 @@ The response includes metadata that {{es}} generates for the document, including
2. The `_id` field is the unique identifier for the document.
3. The `_version` field indicates the version of the document.
4. The `result` field indicates the result of the indexing operation.
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.
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.
6. The `total` field indicates the total number of shards for the index.
7. The `successful` field indicates the number of shards that the indexing operation was executed on.
8. The `failed` field indicates the number of shards that failed during the indexing operation. *0* indicates no failures.
Expand Down Expand Up @@ -230,7 +226,7 @@ You should receive a response indicating there were no errors.

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

[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.
[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.


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

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.

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).
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).


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

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


### Search all documents [getting-started-search-all-documents]
Expand Down
Loading
Loading