Skip to content

Commit 13debcc

Browse files
authored
Tweak search toc, add apis and tools page, move stuff (#604)
Closes elastic/developer-docs-team#264 - move near-real-time-search.md to manage-data as it's es internal - Add apis and tools page - Tweak search toc - Update applies to stuff - Other minor cosmetic stuff
1 parent 9a3ec20 commit 13debcc

File tree

14 files changed

+94
-42
lines changed

14 files changed

+94
-42
lines changed

deploy-manage/tools/snapshot-and-restore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ In Elasticsearch 8.0 and later versions, feature states are the only way to back
106106

107107
## How snapshots work
108108

109-
Snapshots are **automatically deduplicated** to save storage space and reduce network transfer costs. To back up an index, a snapshot makes a copy of the index’s [segments](/solutions/search/search-approaches/near-real-time-search.md) and stores them in the snapshot repository. Since segments are immutable, the snapshot only needs to copy any new segments created since the repository’s last snapshot.
109+
Snapshots are **automatically deduplicated** to save storage space and reduce network transfer costs. To back up an index, a snapshot makes a copy of the index’s [segments](/manage-data/data-store/near-real-time-search.md) and stores them in the snapshot repository. Since segments are immutable, the snapshot only needs to copy any new segments created since the repository’s last snapshot.
110110

111111
Each snapshot is **logically independent**. When you delete a snapshot, Elasticsearch only deletes the segments used exclusively by that snapshot. Elasticsearch doesn’t delete segments used by other snapshots in the repository.
112112

explore-analyze/query-filter/tools.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ mapped_pages:
88

99
# Query tools [devtools-kibana]
1010

11-
Elasticsearch offers tools that you can use to query your data, manage those queries, and optimize them to be as efficient as possible.
11+
Access these specialized tools in Kibana and the Serverless UI to develop, debug, and refine your search queries while monitoring their performance and efficiency.
1212

13-
| | |
14-
| --- | --- |
15-
| [Saved queries](tools/saved-queries.md) | Save your searches and queries to reuse them later. |
13+
| Tool | Function |
14+
|------|----------|
15+
| [Saved queries](tools/saved-queries.md) | Save your searches and queries to reuse them later. |
1616
| [Console](tools/console.md) | Interact with the REST APIs of {{es}} and {{kib}}, including sending requests and viewing API documentation. |
1717
| [{{searchprofiler}}](tools/search-profiler.md) | Inspect and analyze your search queries. |
18-
| [Grok Debugger   ](tools/grok-debugger.md) | Build and debug grok patterns before you use them in your data processing pipelines. |
19-
| [Painless Lab](../scripting/painless-lab.md) | [beta] Test and debug Painless scripts in real-time. |
20-
| [Playground](tools/playground.md) | Combine your Elasticsearch data with the power of large language models (LLMs) for retrieval augmented generation (RAG), using a chat interface. |
18+
| [Grok Debugger](tools/grok-debugger.md) | Build and debug grok patterns before you use them in your data processing pipelines. |
19+
| [Painless Lab](../scripting/painless-lab.md) | [beta] Test and debug Painless scripts in real-time. |
20+
| [Playground](tools/playground.md) | Combine your Elasticsearch data with the power of large language models (LLMs) for retrieval augmented generation (RAG), using a chat interface. |
2121

2222

2323

solutions/search/search-approaches/near-real-time-search.md renamed to manage-data/data-store/near-real-time-search.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/near-real-time.html
44
applies_to:
55
stack:
6-
serverless:
76
---
87

98
# Near real-time search [near-real-time]
@@ -14,15 +13,15 @@ Lucene, the Java libraries on which {{es}} is based, introduced the concept of p
1413

1514
Sitting between {{es}} and the disk is the filesystem cache. Documents in the in-memory indexing buffer ([Figure 1](#img-pre-refresh)) are written to a new segment ([Figure 2](#img-post-refresh)). The new segment is written to the filesystem cache first (which is cheap) and only later is it flushed to disk (which is expensive). However, after a file is in the cache, it can be opened and read just like any other file.
1615

17-
:::{image} ../../../images/elasticsearch-reference-lucene-in-memory-buffer.png
16+
:::{image} /images/elasticsearch-reference-lucene-in-memory-buffer.png
1817
:alt: A Lucene index with new documents in the in-memory buffer
1918
:title: A Lucene index with new documents in the in-memory buffer
2019
:name: img-pre-refresh
2120
:::
2221

2322
Lucene allows new segments to be written and opened, making the documents they contain visible to search ​without performing a full commit. This is a much lighter process than a commit to disk, and can be done frequently without degrading performance.
2423

25-
:::{image} ../../../images/elasticsearch-reference-lucene-written-not-committed.png
24+
:::{image} /images/elasticsearch-reference-lucene-written-not-committed.png
2625
:alt: The buffer contents are written to a segment, which is searchable, but is not yet committed
2726
:title: The buffer contents are written to a segment, which is searchable, but is not yet committed
2827
:name: img-post-refresh

manage-data/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ toc:
44
- file: data-store.md
55
children:
66
- file: data-store/index-basics.md
7+
- file: data-store/near-real-time-search.md
78
- file: data-store/data-streams.md
89
children:
910
- file: data-store/data-streams/set-up-data-stream.md

raw-migrated-files/docs-content/serverless/elasticsearch-dev-tools.md

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

raw-migrated-files/elasticsearch/elasticsearch-reference/snapshot-restore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ In {{es}} 8.0 and later versions, feature states are the only way to back up and
6262

6363
## How snapshots work [how-snapshots-work]
6464

65-
Snapshots are automatically deduplicated to save storage space and reduce network transfer costs. To back up an index, a snapshot makes a copy of the index’s [segments](../../../solutions/search/search-approaches/near-real-time-search.md) and stores them in the snapshot repository. Since segments are immutable, the snapshot only needs to copy any new segments created since the repository’s last snapshot.
65+
Snapshots are automatically deduplicated to save storage space and reduce network transfer costs. To back up an index, a snapshot makes a copy of the index’s [segments](../../../manage-data/data-store/near-real-time-search.md) and stores them in the snapshot repository. Since segments are immutable, the snapshot only needs to copy any new segments created since the repository’s last snapshot.
6666

6767
Each snapshot is also logically independent. When you delete a snapshot, {{es}} only deletes the segments used exclusively by that snapshot. {{es}} doesn’t delete segments used by other snapshots in the repository.
6868

raw-migrated-files/toc.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,6 @@ toc:
160160
- file: docs-content/serverless/connect-to-byo-llm.md
161161
- file: docs-content/serverless/cspm-required-permissions.md
162162
- file: docs-content/serverless/detections-logsdb-index-mode-impact.md
163-
- file: docs-content/serverless/elasticsearch-dev-tools.md
164163
- file: docs-content/serverless/elasticsearch-differences.md
165164
- file: docs-content/serverless/elasticsearch-explore-your-data.md
166165
- file: docs-content/serverless/elasticsearch-http-apis.md

redirects.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
redirects:
2+
'solutions/search/search-approaches/near-real-time-search.md': '!manage-data/data-store/near-real-time-search.md'
23
'get-started/installing-elastic-stack.md': '!deploy-manage/deploy/self-managed.md'
34
'deploy-manage/deploy/elastic-cloud/ec-configure-deployment-settings.md': '!deploy-manage/deploy/elastic-cloud/ec-customize-deployment-components.md'
45
'deploy-manage/users-roles/cluster-or-deployment-auth/user-authentication.md':

solutions/search/apis-and-tools.md

Lines changed: 62 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,67 @@ applies_to:
99

1010
# APIs and tools
1111

12-
% What needs to be done: Write from scratch
12+
This page is handy list of the most important APIs and tools you need to build, test, and manage your search app built with {{es}}.
1313

14-
% Use migrated content from existing pages that map to this page:
14+
## API endpoints
1515

16-
% - [ ] ./raw-migrated-files/docs-content/serverless/elasticsearch-dev-tools.md
17-
% - [ ] https://www.elastic.co/guide/en/enterprise-search/current/search-ui.html
18-
% Notes: mostly redirect purposes, this page wasn't migrated, but you can pull from the live URL if needed.
16+
### Query & search APIs
17+
18+
| Endpoint | Function |
19+
|----------|----------|
20+
| [`_search`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-search) | Searches and aggregations written in [Query DSL](/explore-analyze/query-filter/languages/querydsl.md) and [retrievers](retrievers-overview.md) syntax |
21+
| [`_query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-esql)| Endpoint for [{{esql}}](/explore-analyze/query-filter/languages/esql.md) queries |
22+
| [`_explain`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-explain) | Provides detailed explanation of how a specific document matches a query with scoring breakdown |
23+
| [`_count`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-count) | Returns count of documents matching a query without retrieving results |
24+
| [`_validate/query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-validate-query) | Validates query syntax without executing the search |
25+
| [`_analyze`](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html) | Performs analysis for [full-text search](./full-text.md) on a text string and returns the resulting tokens. |
26+
27+
### Ingestion & mapping APIs
28+
29+
| Endpoint | Function |
30+
|----------|----------|
31+
| [`_mapping`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-field-mapping) | Retrieves or updates field mappings with options for specific field inspection |
32+
| [`_reindex`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-reindex) | Copies documents from one index to another, useful for mapping changes |
33+
| [`_update_by_query`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-update-by-query) | Updates documents matching a query without reindexing |
34+
| [`_bulk`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-bulk-1) | Performs multiple index/update/delete operations in a single request |
35+
| [`_refresh`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-refresh-3) | Forces a refresh to make recent operations searchable |
36+
| [`_ingest/pipeline`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-ingest) | Creates and manages document processing pipelines before indexing |
37+
38+
### Search optimization APIs
39+
40+
| Endpoint | Function |
41+
|----------|----------|
42+
| [`_rank_eval`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-rank-eval)| Evaluates search quality against known relevant documents |
43+
| [`_settings`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-settings-1) | Configures settings including slow logs, refresh intervals, and replicas (only index-level settings available in serverless) |
44+
| [`_scripts`](https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-script) | Creates or updates stored scripts for reuse in queries and aggregations |
45+
46+
47+
## UI tools [elasticsearch-dev-tools]
48+
49+
### Dev tools
50+
51+
Access these specialized tools in Kibana and the Serverless UI to develop, debug, and refine your search queries while monitoring their performance and efficiency.
52+
53+
These tools are documented in the **Explore & Analyze** section:
54+
55+
| Tool | Function |
56+
|------|----------|
57+
| [Saved queries](/explore-analyze/query-filter/tools/saved-queries.md) | Save your searches and queries to reuse them later. |
58+
| [Console](/explore-analyze/query-filter/tools/console.md) | Interact with the REST APIs of {{es}} and {{kib}}, including sending requests and viewing API documentation. |
59+
| [{{searchprofiler}}](/explore-analyze/query-filter/tools/search-profiler.md) | Inspect and analyze your search queries. |
60+
| [Grok Debugger](/explore-analyze/query-filter/tools/grok-debugger.md) | Build and debug grok patterns before you use them in your data processing pipelines. |
61+
| [Painless Lab](/explore-analyze/scripting/painless-lab.md) | Test and debug Painless scripts in real-time. |
62+
63+
### Playground
64+
65+
Use [Playground](rag/playground.md) to combine your {{es}} data with the power of large language models (LLMs) for retrieval augmented generation (RAG), using a chat interface. Playground is also very useful for testing and debugging your {{es}} queries, using the [retrievers](retrievers-overview.md) syntax with the `_search` endpoint.
66+
67+
### Search UI
68+
69+
[Elastic Search UI](./site-or-app/search-ui.md) is a library of JavaScript and React tools for building search experiences, optimized for use with {{es}}.
70+
71+
:::{tip}
72+
Check out the Elasticsearch Labs [blog](https://www.elastic.co/search-labs) to learn how to use Elastic to build advanced search experiences including generative AI, embedding models, reranking capabilities and more.
73+
74+
The accompanying [GitHub repository](https://www.github.com/elastic/elasticsearch-labs) contains hands-on Python notebooks and sample apps to help you get started with these advanced search features.
75+
:::

solutions/search/search-applications.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,10 @@ navigation_title: "Search Applications"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-overview.html
55
applies_to:
6-
stack:
7-
serverless:
6+
stack: beta
7+
serverless: beta
88
---
99

10-
11-
1210
# Search applications [search-application-overview]
1311

1412

@@ -32,14 +30,15 @@ The Search Applications feature was introduced in Elastic version **8.8.0**.
3230

3331
::::{note}
3432
Search Applications is a beta feature. Beta features are subject to change and are not covered by the support SLA of general release (GA) features. Elastic plans to promote this feature to GA in a future release.
35-
3633
::::
3734

3835

39-
This feature is available to all **Elastic Cloud** deployments.
36+
This feature is available to all **{{ech}}** deployments.
4037

4138
This feature is also available to **self-managed** deployments when Elastic subscription requirements are satisfied. View the requirements for this feature under the **Elastic Search** section of the [Elastic Stack subscriptions](https://www.elastic.co/subscriptions) page.
4239

40+
For Serverless users, this is an API-only feature. You can create and manage search applications using the [Search Application APIs](https://www.elastic.co/docs/api/doc/elasticsearch-serverless/group/endpoint-search_application).
41+
4342
Your deployment must include the {{es}} and {{kib}} services.
4443

4544
Managing search applications requires the `manage_search_application` cluster privilege, and also requires the `manage` [index privilege](../../deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md#privileges-list-indices) on all indices associated with the search application.
@@ -57,6 +56,10 @@ Search Applications use [search templates](search-templates.md) to simplify the
5756

5857
### Option 1: Get started in the UI [search-application-overview-get-started-ui]
5958

59+
```{applies_to}
60+
serverless: unavailable
61+
```
62+
6063
You can create build, and manage your search applications directly in the {{kib}} UI under **Search**. Make sure you have at least one {{es}} index to work with on your deployment. The indices underlying your search application are searched together, similar to how an [alias](../../manage-data/data-store/aliases.md) searches over multiple indices.
6164

6265
To create a new search application in {{kib}}:

solutions/search/search-applications/search-application-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ navigation_title: "Search API and templates"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-api.html
55
applies_to:
6-
stack:
7-
serverless:
6+
stack: beta
7+
serverless: beta
88
---
99

1010

solutions/search/search-applications/search-application-client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ navigation_title: "Search Application client guide"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-client.html
55
applies_to:
6-
stack:
7-
serverless:
6+
stack: beta
7+
serverless: beta
88
---
99

1010

solutions/search/search-applications/search-application-security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ navigation_title: "Security"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-security.html
55
applies_to:
6-
stack:
7-
serverless:
6+
stack: beta
7+
serverless: beta
88
---
99

1010

solutions/toc.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -644,6 +644,9 @@ toc:
644644
children:
645645
- file: search/ranking/learning-to-rank-model-training.md
646646
- file: search/ranking/learning-to-rank-search-usage.md
647+
- file: search/cross-cluster-search.md
648+
children:
649+
- file: search/using-resolve-cluster-endpoint-before-cross-cluster-search.md
647650
- file: search/querying-for-search.md
648651
children:
649652
- file: search/the-search-api.md
@@ -661,8 +664,4 @@ toc:
661664
- file: search/search-applications/search-application-api.md
662665
- file: search/search-applications/search-application-security.md
663666
- file: search/search-applications/search-application-client.md
664-
- file: search/apis-and-tools.md
665-
- file: search/search-approaches/near-real-time-search.md
666-
- file: search/cross-cluster-search.md
667-
children:
668-
- file: search/using-resolve-cluster-endpoint-before-cross-cluster-search.md
667+
- file: search/apis-and-tools.md

0 commit comments

Comments
 (0)