From 5136cb55a6472d7b800bbc9e28eddc5cf85ca2ad Mon Sep 17 00:00:00 2001 From: Ioana Tagirta Date: Fri, 9 Jan 2026 11:07:46 +0100 Subject: [PATCH] Search functions docs cleanup --- .../esql/_snippets/functions/description/top_snippets.md | 4 ++-- .../esql/_snippets/functions/parameters/top_snippets.md | 2 +- .../esql/functions-operators/search-functions.md | 6 ------ .../esql/kibana/definition/functions/top_snippets.json | 4 ++-- .../esql/expression/function/scalar/string/TopSnippets.java | 6 +++--- 5 files changed, 8 insertions(+), 14 deletions(-) diff --git a/docs/reference/query-languages/esql/_snippets/functions/description/top_snippets.md b/docs/reference/query-languages/esql/_snippets/functions/description/top_snippets.md index 0b59d5479e510..96fa5bc161a8a 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/description/top_snippets.md +++ b/docs/reference/query-languages/esql/_snippets/functions/description/top_snippets.md @@ -4,6 +4,6 @@ Use `TOP_SNIPPETS` to extract the best snippets for a given query string from a text field. -TopSnippets can be used on fields from the text famiy like [text](/reference/elasticsearch/mapping-reference/text.md) and [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md). - TopSnippets will extract the best snippets for a given query string. +`TOP_SNIPPETS` can be used on fields from the text famiy like [text](/reference/elasticsearch/mapping-reference/text.md) and [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md). + `TOP_SNIPPETS` will extract the best snippets for a given query string. diff --git a/docs/reference/query-languages/esql/_snippets/functions/parameters/top_snippets.md b/docs/reference/query-languages/esql/_snippets/functions/parameters/top_snippets.md index f0684cca6e200..cc13f80f11ed6 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/parameters/top_snippets.md +++ b/docs/reference/query-languages/esql/_snippets/functions/parameters/top_snippets.md @@ -9,5 +9,5 @@ : The input text containing only query terms for snippet extraction. Lucene query syntax, operators, and wildcards are not allowed. `options` -: (Optional) TopSnippets additional options as [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params). +: (Optional) `TOP_SNIPPETS` additional options as [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params). diff --git a/docs/reference/query-languages/esql/functions-operators/search-functions.md b/docs/reference/query-languages/esql/functions-operators/search-functions.md index 1a30775ee96cc..507c7f223b31e 100644 --- a/docs/reference/query-languages/esql/functions-operators/search-functions.md +++ b/docs/reference/query-languages/esql/functions-operators/search-functions.md @@ -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 -% To make it visible again, uncomment this and the line in -lists/search-functions.md -% :::{include} ../_snippets/functions/layout/term.md -% ::: diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/top_snippets.json b/docs/reference/query-languages/esql/kibana/definition/functions/top_snippets.json index 61bccc6d17037..6a1f3b078b218 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/top_snippets.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/top_snippets.json @@ -41,7 +41,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='num_words', values=[300], description='The maximum number of words to return in each snippet.\nThis allows better control of inference costs by limiting the size of tokens per snippet.\n', type=[integer]}, {name='num_snippets', values=[3], description='The maximum number of matching snippets to return.', type=[integer]}", "optional" : true, - "description" : "(Optional) TopSnippets additional options as [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params)." + "description" : "(Optional) `TOP_SNIPPETS` additional options as [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params)." } ], "variadic" : false, @@ -84,7 +84,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='num_words', values=[300], description='The maximum number of words to return in each snippet.\nThis allows better control of inference costs by limiting the size of tokens per snippet.\n', type=[integer]}, {name='num_snippets', values=[3], description='The maximum number of matching snippets to return.', type=[integer]}", "optional" : true, - "description" : "(Optional) TopSnippets additional options as [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params)." + "description" : "(Optional) `TOP_SNIPPETS` additional options as [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params)." } ], "variadic" : false, diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippets.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippets.java index 6e860f9a291dd..9c7b4142ad6be 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippets.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/TopSnippets.java @@ -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 <> and <>. - TopSnippets will extract the best snippets for a given query string. + `TOP_SNIPPETS` can be used on fields from the text famiy like <> and <>. + `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"), @@ -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 = {