Skip to content

ES|QL: Search functions docs cleanup #140435

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

Merged
ioanatia merged 1 commit into from
Jan 9, 2026
Merged

ES|QL: Search functions docs cleanup #140435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions .../reference/query-languages/esql/_snippets/functions/description/top_snippets.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/query-languages/esql/_snippets/functions/parameters/top_snippets.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 0 additions & 6 deletions docs/reference/query-languages/esql/functions-operators/search-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,3 @@ for information on the limitations of full text search.

:::{include} ../_snippets/functions/layout/top_snippets.md
:::

% TERM is currently a hidden feature
Copy link
Member

@carlosdelest carlosdelest Jan 9, 2026

Choose a reason for hiding this comment

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

Thanks for cleaning this!

% To make it visible again, uncomment this and the line in
lists/search-functions.md
% :::{include} ../_snippets/functions/layout/term.md
% :::
4 changes: 2 additions & 2 deletions docs/reference/query-languages/esql/kibana/definition/functions/top_snippets.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions ...main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ public class TopSnippets extends EsqlScalarFunction implements OptionalArgument
preview = true,
description = "Use `TOP_SNIPPETS` to extract the best snippets for a given query string from a text field.",
detailedDescription = """
TopSnippets can be used on fields from the text famiy like <<text, text>> and <<semantic-text, semantic_text>>.
TopSnippets will extract the best snippets for a given query string.
`TOP_SNIPPETS` can be used on fields from the text famiy like <<text, text>> and <<semantic-text, semantic_text>>.
`TOP_SNIPPETS` will extract the best snippets for a given query string.
""",
examples = {
@Example(file = "top-snippets", tag = "top-snippets-with-field", applies_to = "stack: preview 9.3.0"),
Expand All @@ -92,7 +92,7 @@ public TopSnippets(
""") Expression query,
@MapParam(
name = "options",
description = "(Optional) TopSnippets additional options as "
description = "(Optional) `TOP_SNIPPETS` additional options as "
+ "[function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params).",
optional = true,
params = {
Expand Down
Loading