Take match_phrase out of snapshot and make tech preview (#128925)

* Take match_phrase out of snapshot and make tech preview

* Update docs/changelog/128925.yaml

* PR feedback

* Adding regenerated test data

* Update docs/changelog/128925.yaml

Co-authored-by: Carlos Delgado <[email protected]>

* [CI] Auto commit changes from spotless

* Checkstyle

* Correct docs

* Hopefully fix docs build

* Found one more bad docs link - here's hoping this now fixes the doc build

* OMG bitten by - vs _

---------

Co-authored-by: Carlos Delgado <[email protected]>
Co-authored-by: elasticsearchmachine <[email protected]>
Co-authored-by: Aurélien FOUCRET <[email protected]>

Author: 4 people

docs/changelog/128925.yaml

@@ -0,0 +1,5 @@
+pr: 128925
+summary: ES|QL - Add `match_phrase` full text function (tech preview)
+area: ES|QL
+type: enhancement
+issues: []

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

@@ -1,7 +1,6 @@
 * [preview] [`KQL`](../../functions-operators/search-functions.md#esql-kql)
 * [preview] [`MATCH`](../../functions-operators/search-functions.md#esql-match)
-  % * [preview] [
-  `MATCH_PHRASE`](../../functions-operators/search-functions.md#esql-match-phrase)
+* [preview] [`MATCH_PHRASE`](../../functions-operators/search-functions.md#esql-match_phrase)
 * [preview] [`QSTR`](../../functions-operators/search-functions.md#esql-qstr)
   % * [preview] [
   `TERM`](../../functions-operators/search-functions.md#esql-term)

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

@@ -36,9 +36,8 @@ for information on the limitations of full text search.
 :::{include} ../_snippets/functions/layout/match.md
 :::
 
-% MATCH_PHRASE is currently hidden
-% :::{include} ../_snippets/functions/layout/match_phrase.md
-% :::
+:::{include} ../_snippets/functions/layout/match_phrase.md
+:::
 
 :::{include} ../_snippets/functions/layout/qstr.md
 :::

docs/reference/query-languages/esql/_snippets/lists/search-functions.md

@@ -13,9 +13,6 @@
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.xpack.esql.VerificationException;
 import org.elasticsearch.xpack.esql.action.AbstractEsqlIntegTestCase;
-import org.elasticsearch.xpack.esql.action.EsqlCapabilities;
-import org.elasticsearch.xpack.esql.action.EsqlQueryRequest;
-import org.elasticsearch.xpack.esql.action.EsqlQueryResponse;
 import org.hamcrest.Matchers;
 import org.junit.Before;
 
@@ -34,12 +31,6 @@ public void setupIndex() {
         createAndPopulateIndex();
     }
 
-    @Override
-    protected EsqlQueryResponse run(EsqlQueryRequest request) {
-        assumeTrue("match_phrase function capability not available", EsqlCapabilities.Cap.MATCH_PHRASE_FUNCTION.isEnabled());
-        return super.run(request);
-    }
-
     public void testSimpleWhereMatchPhrase() {
         var query = """
             FROM test

docs/reference/query-languages/esql/functions-operators/search-functions.md

@@ -50,12 +50,10 @@ public static List<Object[]> params() {
         params.add(new Object[] { "content:\"fox\"" });
         params.add(new Object[] { "qstr(\"content: fox\")" });
         params.add(new Object[] { "kql(\"content*: fox\")" });
+        params.add(new Object[] { "match_phrase(content, \"fox\")" });
         if (EsqlCapabilities.Cap.TERM_FUNCTION.isEnabled()) {
             params.add(new Object[] { "term(content, \"fox\")" });
         }
-        if (EsqlCapabilities.Cap.MATCH_PHRASE_FUNCTION.isEnabled()) {
-            params.add(new Object[] { "match_phrase(content, \"fox\")" });
-        }
         return params;
     }
 

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

@@ -1185,7 +1185,7 @@ public enum Cap {
         /**
          * MATCH PHRASE function
          */
-        MATCH_PHRASE_FUNCTION(Build.current().isSnapshot());
+        MATCH_PHRASE_FUNCTION;
 
         private final boolean enabled;
 

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

@@ -23,15 +23,12 @@ public static List<NamedWriteableRegistry.Entry> getNamedWriteables() {
         entries.add(Match.ENTRY);
         entries.add(MultiMatch.ENTRY);
         entries.add(Kql.ENTRY);
+        entries.add(MatchPhrase.ENTRY);
 
         if (EsqlCapabilities.Cap.TERM_FUNCTION.isEnabled()) {
             entries.add(Term.ENTRY);
         }
 
-        if (EsqlCapabilities.Cap.MATCH_PHRASE_FUNCTION.isEnabled()) {
-            entries.add(MatchPhrase.ENTRY);
-        }
-
         return Collections.unmodifiableList(entries);
     }
 }

x-pack/plugin/esql/src/internalClusterTest/java/org/elasticsearch/xpack/esql/plugin/MatchPhraseFunctionIT.java

@@ -94,7 +94,8 @@ public class MatchPhrase extends FullTextFunction implements OptionalArgument, P
         returnType = "boolean",
         preview = true,
         description = """
-            Use `MATCH_PHRASE` to perform a <<query-dsl-match-query-phrase,match_phrase query>> on the specified field.
+            Use `MATCH_PHRASE` to perform a [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) on the
+            specified field.
             Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.
 
             MatchPhrase can be used on <<text, text>> fields, as well as other field types like keyword, boolean, or date types.
@@ -149,7 +150,7 @@ public MatchPhrase(
                     description = "Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0."
                 ) },
             description = "(Optional) MatchPhrase additional options as <<esql-function-named-params,function named parameters>>."
-                + " See <<query-dsl-match-query-phrase,match_phrase query>> for more information.",
+                + " See [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) for more information.",
             optional = true
         ) Expression options
     ) {