[GRPC][Full-text] Match Phrase, Multi-match queries

Signed-off-by: Karen X <[email protected]>

Author: karenyrx

CHANGELOG.md

@@ -29,6 +29,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add all-active ingestion as docrep equivalent in pull-based ingestion ([#19316](https://github.com/opensearch-project/OpenSearch/pull/19316))
 - Adding logic for histogram aggregation using skiplist ([#19130](https://github.com/opensearch-project/OpenSearch/pull/19130))
 - Add skip_list param for date, scaled float and token count fields ([#19142](https://github.com/opensearch-project/OpenSearch/pull/19142))
+- Implement GRPC MatchPhrase, MultiMatch queries ([#19449](https://github.com/opensearch-project/OpenSearch/pull/19449))
 
 ### Changed
 - Refactor `if-else` chains to use `Java 17 pattern matching switch expressions`(([#18965](https://github.com/opensearch-project/OpenSearch/pull/18965))

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/MatchPhraseQueryBuilderProtoConverter.java

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.index.query.QueryBuilder;
+import org.opensearch.protobufs.QueryContainer;
+import org.opensearch.transport.grpc.spi.QueryBuilderProtoConverter;
+
+/**
+ * Converter for MatchPhrase queries.
+ * This class implements the QueryBuilderProtoConverter interface to provide MatchPhrase query support
+ * for the gRPC transport module.
+ */
+public class MatchPhraseQueryBuilderProtoConverter implements QueryBuilderProtoConverter {
+
+    /**
+     * Constructs a new MatchPhraseQueryBuilderProtoConverter.
+     */
+    public MatchPhraseQueryBuilderProtoConverter() {
+        // Default constructor
+    }
+
+    @Override
+    public QueryContainer.QueryContainerCase getHandledQueryCase() {
+        return QueryContainer.QueryContainerCase.MATCH_PHRASE;
+    }
+
+    @Override
+    public QueryBuilder fromProto(QueryContainer queryContainer) {
+        if (queryContainer == null || !queryContainer.hasMatchPhrase()) {
+            throw new IllegalArgumentException("QueryContainer does not contain a MatchPhrase query");
+        }
+
+        return MatchPhraseQueryBuilderProtoUtils.fromProto(queryContainer.getMatchPhrase());
+    }
+}

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/MatchPhraseQueryBuilderProtoUtils.java

@@ -0,0 +1,120 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.index.query.AbstractQueryBuilder;
+import org.opensearch.index.query.MatchPhraseQueryBuilder;
+import org.opensearch.index.search.MatchQuery;
+import org.opensearch.protobufs.MatchPhraseQuery;
+import org.opensearch.protobufs.ZeroTermsQuery;
+
+/**
+ * Utility class for converting Protocol Buffer MatchPhraseQuery objects to OpenSearch MatchPhraseQueryBuilder instances.
+ * This class handles the detailed conversion logic, including parsing of all MatchPhraseQuery parameters,
+ * analyzer settings, slop configuration, zero terms query behavior, boost values, and query names.
+ *
+ * @opensearch.internal
+ */
+public class MatchPhraseQueryBuilderProtoUtils {
+    /**
+     * Private constructor to prevent instantiation of utility class.
+     */
+    private MatchPhraseQueryBuilderProtoUtils() {
+        // Utility class
+    }
+
+    /**
+     * Converts a Protocol Buffer MatchPhraseQuery to a MatchPhraseQueryBuilder.
+     * This method extracts all relevant parameters from the protobuf representation and
+     * creates a properly configured MatchPhraseQueryBuilder with the appropriate field name,
+     * query value, analyzer, slop, zero terms query behavior, boost, and query name.
+     *
+     * @param matchPhraseQueryProto The Protocol Buffer MatchPhraseQuery object
+     * @return A properly configured MatchPhraseQueryBuilder
+     * @throws IllegalArgumentException if the MatchPhraseQuery is null or if required fields are missing
+     */
+    public static MatchPhraseQueryBuilder fromProto(MatchPhraseQuery matchPhraseQueryProto) {
+        if (matchPhraseQueryProto == null) {
+            throw new IllegalArgumentException("MatchPhraseQuery cannot be null");
+        }
+
+        String fieldName = matchPhraseQueryProto.getField();
+        if (fieldName.isEmpty()) {
+            throw new IllegalArgumentException("Field name cannot be null or empty for match phrase query");
+        }
+
+        String value = matchPhraseQueryProto.getQuery();
+        if (value.isEmpty()) {
+            throw new IllegalArgumentException("Query value cannot be null or empty for match phrase query");
+        }
+
+        float boost = AbstractQueryBuilder.DEFAULT_BOOST;
+        String analyzer = null;
+        int slop = MatchQuery.DEFAULT_PHRASE_SLOP;
+        MatchQuery.ZeroTermsQuery zeroTermsQuery = MatchQuery.DEFAULT_ZERO_TERMS_QUERY;
+        String queryName = null;
+        if (matchPhraseQueryProto.hasAnalyzer()) {
+            analyzer = matchPhraseQueryProto.getAnalyzer();
+        }
+
+        if (matchPhraseQueryProto.hasSlop()) {
+            int slopValue = matchPhraseQueryProto.getSlop();
+            if (slopValue < 0) {
+                throw new IllegalArgumentException("No negative slop allowed.");
+            }
+            slop = slopValue;
+        }
+
+        if (matchPhraseQueryProto.hasZeroTermsQuery()) {
+            ZeroTermsQuery zeroTermsQueryProto = matchPhraseQueryProto.getZeroTermsQuery();
+            MatchQuery.ZeroTermsQuery parsedZeroTermsQuery = parseZeroTermsQuery(zeroTermsQueryProto);
+            if (parsedZeroTermsQuery != null) {
+                zeroTermsQuery = parsedZeroTermsQuery;
+            }
+        }
+
+        if (matchPhraseQueryProto.hasBoost()) {
+            boost = matchPhraseQueryProto.getBoost();
+        }
+
+        if (matchPhraseQueryProto.hasXName()) {
+            queryName = matchPhraseQueryProto.getXName();
+        }
+
+        MatchPhraseQueryBuilder matchQuery = new MatchPhraseQueryBuilder(fieldName, value);
+        matchQuery.analyzer(analyzer);
+        matchQuery.slop(slop);
+        matchQuery.zeroTermsQuery(zeroTermsQuery);
+        matchQuery.queryName(queryName);
+        matchQuery.boost(boost);
+
+        return matchQuery;
+    }
+
+    /**
+     * Parses ZeroTermsQuery enum to MatchQuery.ZeroTermsQuery.
+     *
+     * @param zeroTermsQueryProto The ZeroTermsQuery enum value
+     * @return The corresponding MatchQuery.ZeroTermsQuery, or null if unsupported
+     */
+    private static MatchQuery.ZeroTermsQuery parseZeroTermsQuery(ZeroTermsQuery zeroTermsQueryProto) {
+        if (zeroTermsQueryProto == null) {
+            return null;
+        }
+
+        switch (zeroTermsQueryProto) {
+            case ZERO_TERMS_QUERY_ALL:
+                return MatchQuery.ZeroTermsQuery.ALL;
+            case ZERO_TERMS_QUERY_NONE:
+                return MatchQuery.ZeroTermsQuery.NONE;
+            default:
+                return null;
+        }
+    }
+}

modules/transport-grpc/src/main/java/org/opensearch/transport/grpc/proto/request/search/query/MultiMatchQueryBuilderProtoConverter.java

@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+package org.opensearch.transport.grpc.proto.request.search.query;
+
+import org.opensearch.index.query.QueryBuilder;
+import org.opensearch.protobufs.QueryContainer;
+import org.opensearch.transport.grpc.spi.QueryBuilderProtoConverter;
+
+/**
+ * Converter for MultiMatch queries.
+ * This class implements the QueryBuilderProtoConverter interface to provide MultiMatch query support
+ * for the gRPC transport module.
+ */
+public class MultiMatchQueryBuilderProtoConverter implements QueryBuilderProtoConverter {
+
+    /**
+     * Constructs a new MultiMatchQueryBuilderProtoConverter.
+     */
+    public MultiMatchQueryBuilderProtoConverter() {
+        // Default constructor
+    }
+
+    @Override
+    public QueryContainer.QueryContainerCase getHandledQueryCase() {
+        return QueryContainer.QueryContainerCase.MULTI_MATCH;
+    }
+
+    @Override
+    public QueryBuilder fromProto(QueryContainer queryContainer) {
+        if (queryContainer == null || !queryContainer.hasMultiMatch()) {
+            throw new IllegalArgumentException("QueryContainer does not contain a MultiMatch query");
+        }
+
+        return MultiMatchQueryBuilderProtoUtils.fromProto(queryContainer.getMultiMatch());
+    }
+}