|
| 1 | +/* |
| 2 | + * Copyright OpenSearch Contributors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package org.opensearch.knn.index.query; |
| 7 | + |
| 8 | +import lombok.AllArgsConstructor; |
| 9 | +import lombok.Builder; |
| 10 | +import lombok.Getter; |
| 11 | +import lombok.NonNull; |
| 12 | +import lombok.extern.log4j.Log4j2; |
| 13 | +import org.apache.lucene.search.Query; |
| 14 | +import org.apache.lucene.search.join.BitSetProducer; |
| 15 | +import org.apache.lucene.search.join.ToChildBlockJoinQuery; |
| 16 | +import org.opensearch.index.query.QueryBuilder; |
| 17 | +import org.opensearch.index.query.QueryShardContext; |
| 18 | +import org.opensearch.index.search.NestedHelper; |
| 19 | +import org.opensearch.knn.index.VectorDataType; |
| 20 | +import org.opensearch.knn.index.util.KNNEngine; |
| 21 | + |
| 22 | +import java.io.IOException; |
| 23 | +import java.util.Optional; |
| 24 | + |
| 25 | +/** |
| 26 | +* Base class for creating vector search queries. |
| 27 | +*/ |
| 28 | +@Log4j2 |
| 29 | +public abstract class BaseQueryFactory { |
| 30 | + /** |
| 31 | + * DTO object to hold data required to create a Query instance. |
| 32 | + */ |
| 33 | + @AllArgsConstructor |
| 34 | + @Builder |
| 35 | + @Getter |
| 36 | + public static class CreateQueryRequest { |
| 37 | + @NonNull |
| 38 | + private KNNEngine knnEngine; |
| 39 | + @NonNull |
| 40 | + private String indexName; |
| 41 | + private String fieldName; |
| 42 | + private float[] vector; |
| 43 | + private byte[] byteVector; |
| 44 | + private VectorDataType vectorDataType; |
| 45 | + private Integer k; |
| 46 | + private Float radius; |
| 47 | + private QueryBuilder filter; |
| 48 | + private QueryShardContext context; |
| 49 | + |
| 50 | + public Optional<QueryBuilder> getFilter() { |
| 51 | + return Optional.ofNullable(filter); |
| 52 | + } |
| 53 | + |
| 54 | + public Optional<QueryShardContext> getContext() { |
| 55 | + return Optional.ofNullable(context); |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + /** |
| 60 | + * Creates a query filter. |
| 61 | + * |
| 62 | + * @param createQueryRequest request object that has all required fields to construct the query |
| 63 | + * @return Lucene Query |
| 64 | + */ |
| 65 | + protected static Query getFilterQuery(BaseQueryFactory.CreateQueryRequest createQueryRequest) { |
| 66 | + if (!createQueryRequest.getFilter().isPresent()) { |
| 67 | + return null; |
| 68 | + } |
| 69 | + |
| 70 | + final QueryShardContext queryShardContext = createQueryRequest.getContext() |
| 71 | + .orElseThrow(() -> new RuntimeException("Shard context cannot be null")); |
| 72 | + log.debug( |
| 73 | + String.format( |
| 74 | + "Creating query with filter for index [%s], field [%s]", |
| 75 | + createQueryRequest.getIndexName(), |
| 76 | + createQueryRequest.getFieldName() |
| 77 | + ) |
| 78 | + ); |
| 79 | + final Query filterQuery; |
| 80 | + try { |
| 81 | + filterQuery = createQueryRequest.getFilter().get().toQuery(queryShardContext); |
| 82 | + } catch (IOException e) { |
| 83 | + throw new RuntimeException("Cannot create query with filter", e); |
| 84 | + } |
| 85 | + BitSetProducer parentFilter = queryShardContext.getParentFilter(); |
| 86 | + if (parentFilter != null) { |
| 87 | + boolean mightMatch = new NestedHelper(queryShardContext.getMapperService()).mightMatchNestedDocs(filterQuery); |
| 88 | + if (mightMatch) { |
| 89 | + return filterQuery; |
| 90 | + } |
| 91 | + return new ToChildBlockJoinQuery(filterQuery, parentFilter); |
| 92 | + } |
| 93 | + return filterQuery; |
| 94 | + } |
| 95 | +} |
0 commit comments