diff --git a/docs/reference/query-languages/esql/_snippets/functions/examples/top_snippets.md b/docs/reference/query-languages/esql/_snippets/functions/examples/top_snippets.md index de97c82addb86..3d2001f627252 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/examples/top_snippets.md +++ b/docs/reference/query-languages/esql/_snippets/functions/examples/top_snippets.md @@ -7,9 +7,18 @@ stack: preview 9.3.0 ``` ```esql -null +FROM books +| EVAL snippets = TOP_SNIPPETS(description, "Tolkien") ``` +| book_no:keyword | title:text | snippets:keyword | +| --- | --- | --- | +| 1211 | The brothers Karamazov | null | +| 1463 | Realms of Tolkien: Images of Middle-earth | Twenty new and familiar Tolkien artists are represented in this fabulous volume, breathing an extraordinary variety of life into 58 different scenes, each of which is accompanied by appropriate passage from The Hobbit and The Lord of the Rings and The Silmarillion | +| 1502 | Selected Passages from Correspondence with Friends | null | +| 1937 | The Best Short Stories of Dostoevsky (Modern Library) | null | +| 1985 | Brothers Karamazov | null | + ```{applies_to} stack: preview 9.3.0 ``` 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 e9b359b19541c..f8f3e650ac826 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 @@ -42,7 +42,7 @@ } ], "examples" : [ - null, + "FROM books\n| EVAL snippets = TOP_SNIPPETS(description, \"Tolkien\")", "FROM books\n| WHERE MATCH(title, \"Return\")\n| EVAL snippets = TOP_SNIPPETS(description, \"Tolkien\", { \"num_snippets\": 3, \"num_words\": 25 })" ], "preview" : true, diff --git a/docs/reference/query-languages/esql/kibana/docs/functions/top_snippets.md b/docs/reference/query-languages/esql/kibana/docs/functions/top_snippets.md index c64689e1b6f01..42544d83044c2 100644 --- a/docs/reference/query-languages/esql/kibana/docs/functions/top_snippets.md +++ b/docs/reference/query-languages/esql/kibana/docs/functions/top_snippets.md @@ -4,5 +4,6 @@ Use `TOP_SNIPPETS` to extract the best snippets for a given query string from a text field. ```esql -null +FROM books +| EVAL snippets = TOP_SNIPPETS(description, "Tolkien") ``` 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 09b108bedde2c..5f73cd43f3e8b 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 @@ -79,7 +79,7 @@ public class TopSnippets extends EsqlScalarFunction implements OptionalArgument TopSnippets will extract the best snippets for a given query string. """, examples = { - @Example(file = "top-snippets", tag = "top-snippets", applies_to = "stack: preview 9.3.0"), + @Example(file = "top-snippets", tag = "top-snippets-with-field", applies_to = "stack: preview 9.3.0"), @Example(file = "top-snippets", tag = "top-snippets-with-options", applies_to = "stack: preview 9.3.0") } ) public TopSnippets(