Skip to content

Conversation

leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Jun 19, 2025

9.x portion of https://github.com/elastic/developer-docs-team/issues/300

Contains updates to:

  1. landing page for ESQL for Search
  2. hands-on tutorial

landing page changes:

reorganized around user journey - overview → concepts → functions → advanced flow
removed code examples - directs to tutorial and reference docs instead of duplicating content
grouped related functionality - consolidated search functions under clear sections
focused on orientation - helps users understand capabilities and find next steps
reduced maintenance - fewer duplicated explanations across multiple pages

tutorial changes:

restructured steps for logical progression
expanded section 3 into two focused steps
added new advanced features section
improved step titles
simplified next steps

@leemthompo leemthompo self-assigned this Jun 19, 2025
Copy link

github-actions bot commented Jun 19, 2025

🔍 Preview links for changed docs:

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

Copy link
Member

@carlosdelest carlosdelest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Some minor suggestions

@leemthompo
Copy link
Contributor Author

Thanks Carlos addressed all in latest commit

Copy link

github-actions bot commented Jul 2, 2025

🔍 Preview links for changed docs

@leemthompo leemthompo marked this pull request as ready for review July 7, 2025 09:30
@leemthompo leemthompo requested a review from a team as a code owner July 7, 2025 09:30
@leemthompo leemthompo enabled auto-merge (squash) July 7, 2025 09:48
@leemthompo leemthompo disabled auto-merge July 7, 2025 11:24
Copy link
Contributor

@kosabogi kosabogi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀 with just a tiny nit suggestion

@leemthompo leemthompo enabled auto-merge (squash) July 7, 2025 16:03
@leemthompo leemthompo merged commit d35f218 into main Jul 7, 2025
7 checks passed
@leemthompo leemthompo deleted the leemthompo/esql-search-9.1 branch July 7, 2025 16:05
Copy link
Contributor

@ketkee-aryamane ketkee-aryamane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Thanks.
Left minor suggestions.

::::{important}
These queries match documents but don't automatically sort by relevance. To get the most relevant results first, you need to use `METADATA _score` and sort by score. See [Relevance scoring](#esql-for-search-scoring) for more information.
::::
Use the [`MATCH_PHRASE` function](elasticsearch://reference/query-languages/esql/functions-operators/search-functions.md#esql-match_phrase) to perform a `match_phrase` query on the specified field. This is equivalent to using the [match_phrase query](elasticsearch://reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) in Query DSL.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the [`MATCH_PHRASE` function](elasticsearch://reference/query-languages/esql/functions-operators/search-functions.md#esql-match_phrase) to perform a `match_phrase` query on the specified field. This is equivalent to using the [match_phrase query](elasticsearch://reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) in Query DSL.
Use the [`MATCH_PHRASE` function](elasticsearch://reference/query-languages/esql/functions-operators/search-functions.md#esql-match_phrase) to perform a `match_phrase` query, equivalent to the [match_phrase query](elasticsearch://reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) in Query DSL.

| WHERE semantic_content: "What are the impacts of climate change on agriculture?"
| SORT _score DESC
```
Refer to [semantic search with semantic_text](/solutions/search/semantic-search/semantic-search-semantic-text.md) for an example or follow the [tutorial](esql-search-tutorial.md#step-5-semantic-search-and-hybrid-search).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Refer to [semantic search with semantic_text](/solutions/search/semantic-search/semantic-search-semantic-text.md) for an example or follow the [tutorial](esql-search-tutorial.md#step-5-semantic-search-and-hybrid-search).
For an example, see [semantic search with semantic_text](/solutions/search/semantic-search/semantic-search-semantic-text.md) or follow the [semantic search tutorial](esql-search-tutorial.md#step-5-semantic-search-and-hybrid-search).

Use the [KQL function](elasticsearch://reference/query-languages/esql/functions-operators/search-functions.md#esql-kql) to use the [Kibana Query Language](/explore-analyze/query-filter/languages/kql.md) in your {{esql}} queries.

You can perform semantic searches over [`semantic_text`](elasticsearch://reference/elasticsearch/mapping-reference/semantic-text.md) field types using the same match syntax as full-text search.
For migrating queries from other Kibana interfaces, the `KQL` function preserves existing query syntax and allows gradual migration to {{esql}} without rewriting existing Kibana queries.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure of the word "interfaces".

Suggested change
For migrating queries from other Kibana interfaces, the `KQL` function preserves existing query syntax and allows gradual migration to {{esql}} without rewriting existing Kibana queries.
If you are familiar with other query languages in Kibana before, the `KQL` function preserves existing query syntax and allows gradual migration to {{esql}} without rewriting existing Kibana queries.

## Limitations [esql-for-search-limitations]

Refer to [{{esql}} limitations](elasticsearch://reference/query-languages/esql/limitations.md#esql-limitations-full-text-search) for a list of known limitations.
Refer to [hybrid search with semantic_text](hybrid-semantic-text.md) for an example or follow the [tutorial](esql-search-tutorial.md#step-5-semantic-search-and-hybrid-search).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same comment as before.


:::{tip}
{{esql}} provides two ways to perform full-text searches:
{{esql}} provides multiple functions for full-text search, including `MATCH`, `MATCH_PHRASE`, and `QSTR`. For basic text matching, you can use either:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{esql}} provides multiple functions for full-text search, including `MATCH`, `MATCH_PHRASE`, and `QSTR`. For basic text matching, you can use either:
{{esql}} provides multiple functions for full-text search, including `MATCH`, `MATCH_PHRASE`, and `QSTR`. For basic text matching, you can use one of the following:

{{esql}} provides two ways to perform full-text searches:
{{esql}} provides multiple functions for full-text search, including `MATCH`, `MATCH_PHRASE`, and `QSTR`. For basic text matching, you can use either:

1. Full [match function](elasticsearch://reference/query-languages/esql/functions-operators/search-functions.md#esql-match) syntax: `match(field, "search terms")`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could replace with bullets instead of numbered sequence.

leemthompo added a commit to elastic/elasticsearch that referenced this pull request Jul 24, 2025
leemthompo added a commit to elastic/elasticsearch that referenced this pull request Jul 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants