1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// Copyright 2019 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.searchers;
import com.google.common.annotations.Beta;
import com.yahoo.prelude.query.Item;
import com.yahoo.prelude.query.NearestNeighborItem;
import com.yahoo.prelude.query.QueryCanonicalizer;
import com.yahoo.prelude.query.ToolBox;
import com.yahoo.processing.request.CompoundName;
import com.yahoo.search.Query;
import com.yahoo.search.Result;
import com.yahoo.search.Searcher;
import com.yahoo.search.query.profile.QueryProfileProperties;
import com.yahoo.search.query.profile.compiled.CompiledQueryProfile;
import com.yahoo.search.query.profile.types.FieldDescription;
import com.yahoo.search.query.profile.types.QueryProfileFieldType;
import com.yahoo.search.query.profile.types.QueryProfileType;
import com.yahoo.search.query.ranking.RankProperties;
import com.yahoo.search.result.ErrorMessage;
import com.yahoo.search.searchchain.Execution;
import com.yahoo.tensor.Tensor;
import com.yahoo.tensor.TensorType;
import com.yahoo.vespa.config.search.AttributesConfig;
import com.yahoo.yolean.chain.After;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
/**
* Validates any NearestNeighborItem query items.
*
* @author arnej
*/
@Beta
// This depends on tensors in query.getRanking which are moved to rank.properties during query.prepare()
// Query.prepare is done at the same time as canonicalization (by GroupingExecutor), so use that constraint.
@After(QueryCanonicalizer.queryCanonicalization)
public class ValidateNearestNeighborSearcher extends Searcher {
private Map<String, TensorType> validAttributes = new HashMap<>();
public ValidateNearestNeighborSearcher(AttributesConfig attributesConfig) {
for (AttributesConfig.Attribute a : attributesConfig.attribute()) {
TensorType tt = null;
if (a.datatype() == AttributesConfig.Attribute.Datatype.TENSOR) {
tt = TensorType.fromSpec(a.tensortype());
}
validAttributes.put(a.name(), tt);
}
}
@Override
public Result search(Query query, Execution execution) {
Optional<ErrorMessage> e = validate(query);
return e.isEmpty() ? execution.search(query) : new Result(query, e.get());
}
private Optional<ErrorMessage> validate(Query query) {
NNVisitor visitor = new NNVisitor(query.getRanking().getProperties(), validAttributes, query);
ToolBox.visit(visitor, query.getModel().getQueryTree().getRoot());
return visitor.errorMessage;
}
private static class NNVisitor extends ToolBox.QueryVisitor {
public Optional<ErrorMessage> errorMessage = Optional.empty();
private final RankProperties rankProperties;
private final Map<String, TensorType> validAttributes;
private final Query query;
public NNVisitor(RankProperties rankProperties, Map<String, TensorType> validAttributes, Query query) {
this.rankProperties = rankProperties;
this.validAttributes = validAttributes;
this.query = query;
}
@Override
public boolean visit(Item item) {
if (item instanceof NearestNeighborItem) {
String error = validate((NearestNeighborItem)item);
if (error != null)
errorMessage = Optional.of(ErrorMessage.createIllegalQuery(error));
}
return true;
}
private static boolean isCompatible(TensorType lhs, TensorType rhs) {
return lhs.dimensions().equals(rhs.dimensions());
}
private static boolean isDenseVector(TensorType tt) {
List<TensorType.Dimension> dims = tt.dimensions();
if (dims.size() != 1) return false;
for (var d : dims) {
if (d.type() != TensorType.Dimension.Type.indexedBound) return false;
}
return true;
}
/** Returns an error message if this is invalid, or null if it is valid */
private String validate(NearestNeighborItem item) {
int target = item.getTargetNumHits();
if (target < 1) return item + " has invalid targetNumHits";
List<Object> rankPropValList = rankProperties.asMap().get(item.getQueryTensorName());
if (rankPropValList == null) return item + " query tensor not found";
if (rankPropValList.size() != 1) return item + " query tensor does not have a single value";
Object rankPropValue = rankPropValList.get(0);
if (! (rankPropValue instanceof Tensor)) {
return item + " expected a query tensor but got " +
(rankPropValue == null ? "null" : rankPropValue.getClass()) +
resolvedTypeInfo();
}
String field = item.getIndexName();
if ( ! validAttributes.containsKey(field)) return item + " field is not an attribute";
TensorType fTensorType = validAttributes.get(field);
TensorType qTensorType = ((Tensor)rankPropValue).type();
if (fTensorType == null) return item + " field is not a tensor";
if ( ! isCompatible(fTensorType, qTensorType)) {
return item + " field type " + fTensorType + " does not match query tensor type " + qTensorType;
}
if (! isDenseVector(fTensorType)) return item + " tensor type " + fTensorType+" is not a dense vector";
return null;
}
@Override
public void onExit() {}
// TODO: Remove
private String resolvedTypeInfo() {
StringBuilder b = new StringBuilder();
QueryProfileProperties properties = query.properties().getInstance(QueryProfileProperties.class);
if (properties == null) return b.toString();
CompiledQueryProfile profile = properties.getQueryProfile();
b.append(", profile: ").append(profile);
CompoundName name = new CompoundName("ranking.features.query(q_vec)");
if ( ! profile.getTypes().isEmpty()) {
QueryProfileType type = null;
for (int i = 0; i < name.size(); i++) {
if (type == null) // We're on the first iteration, or no type is explicitly specified
type = profile.getType(name.first(i), new HashMap<>());
if (type == null) continue;
String localName = name.get(i);
FieldDescription fieldDescription = type.getField(localName);
if (fieldDescription == null && type.isStrict())
throw new IllegalArgumentException("'" + localName + "' is not declared in " + type + ", and the type is strict");
// TODO: In addition to strictness, check legality along the way
if (fieldDescription != null) {
if (i == name.size() - 1) { // at the end of the path, check the assignment type
b.append(", field description: ").append(fieldDescription);
} else if (fieldDescription.getType() instanceof QueryProfileFieldType) {
// If a type is specified, use that instead of the type implied by the name
type = ((QueryProfileFieldType) fieldDescription.getType()).getQueryProfileType();
}
}
}
}
else {
b.append(", profile types is empty");
}
return b.toString();
}
}
}
|
