Skip to content

Commit 694bf6a

Browse files
committed
Add ExtractSnippetTests and associated generated documentation
1 parent ec3ac7a commit 694bf6a

File tree

11 files changed

+224
-4
lines changed

11 files changed

+224
-4
lines changed

docs/reference/query-languages/esql/_snippets/functions/description/extract_snippets.md

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/examples/extract_snippets.md

Lines changed: 18 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/extract_snippets.md

Lines changed: 23 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/parameters/extract_snippets.md

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/types/extract_snippets.md

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/images/functions/extract_snippets.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/reference/query-languages/esql/kibana/definition/functions/extract_snippets.json

Lines changed: 49 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/docs/functions/extract_snippets.md

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ExtractSnippets.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,14 @@ public class ExtractSnippets extends EsqlScalarFunction
8484
returnType = "keyword",
8585
preview = true,
8686
description = """
87-
Extracts the most relevant snippets to return from a given input string""",
88-
examples = @Example(file = "keyword", tag = "extract_snippets")
87+
Extracts the most relevant snippets to return from a given input string.""",
88+
examples = {
89+
@Example(file = "extract-snippets-function", tag = "extract-snippets-with-field", applies_to = "stack: preview 9.2.0") }
8990
)
9091
public ExtractSnippets(
9192
Source source,
92-
@Param(name = "field", type = { "keyword" }, description = "The input string") Expression field,
93-
@Param(name = "str", type = { "keyword", "text" }, description = "The input string") Expression str,
93+
@Param(name = "field", type = { "keyword", "text" }, description = "The input string") Expression field,
94+
@Param(name = "str", type = { "keyword" }, description = "The input string") Expression str,
9495
@Param(
9596
optional = true,
9697
name = "num_snippets",
@@ -105,6 +106,7 @@ public ExtractSnippets(
105106
) Expression snippetLength
106107
) {
107108
this(source, field, str, numSnippets, snippetLength, new MatchQueryBuilder(field.sourceText(), str.sourceText()));
109+
108110
}
109111

110112
public ExtractSnippets(

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/SerializationTestUtils.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import org.elasticsearch.index.query.BoolQueryBuilder;
1919
import org.elasticsearch.index.query.ExistsQueryBuilder;
2020
import org.elasticsearch.index.query.MatchAllQueryBuilder;
21+
import org.elasticsearch.index.query.MatchQueryBuilder;
2122
import org.elasticsearch.index.query.QueryBuilder;
2223
import org.elasticsearch.index.query.RangeQueryBuilder;
2324
import org.elasticsearch.index.query.RegexpQueryBuilder;
@@ -113,6 +114,7 @@ public static NamedWriteableRegistry writableRegistry() {
113114
entries.add(new NamedWriteableRegistry.Entry(QueryBuilder.class, RegexpQueryBuilder.NAME, RegexpQueryBuilder::new));
114115
entries.add(new NamedWriteableRegistry.Entry(QueryBuilder.class, ExistsQueryBuilder.NAME, ExistsQueryBuilder::new));
115116
entries.add(new NamedWriteableRegistry.Entry(QueryBuilder.class, KnnVectorQueryBuilder.NAME, KnnVectorQueryBuilder::new));
117+
entries.add(new NamedWriteableRegistry.Entry(QueryBuilder.class, MatchQueryBuilder.NAME, MatchQueryBuilder::new));
116118
entries.add(SingleValueQuery.ENTRY);
117119
entries.addAll(ExpressionWritables.getNamedWriteables());
118120
entries.addAll(PlanWritables.getNamedWriteables());

0 commit comments

Comments
 (0)