org.apache.solr.ltr.feature.ValueFeature Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of solr-ltr Show documentation
Show all versions of solr-ltr Show documentation
Apache Solr Learning to Rank Package
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.ltr.feature;
import java.io.IOException;
import java.util.LinkedHashMap;
import java.util.Map;
import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.search.DocIdSetIterator;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.Query;
import org.apache.solr.request.SolrQueryRequest;
/**
* This feature allows to return a constant given value for the current document.
*
* Example configuration:
*
*
* {
* "name" : "userFromMobile",
* "class" : "org.apache.solr.ltr.feature.ValueFeature",
* "params" : { "value" : "${userFromMobile}", "required":true }
* }
*
*
* You can place a constant value like "1.3f" in the value params, but many times you would want to
* pass in external information to use per request. For instance, maybe you want to rank things
* differently if the search came from a mobile device, or maybe you want to use your external query
* intent system as a feature. In the rerank request you can pass in rq={... efi.userFromMobile=1},
* and the above feature will return 1 for all the docs for that request. If required is set to
* true, the request will return an error since you failed to pass in the efi, otherwise if will
* just skip the feature and use a default value of 0 instead.
*/
public class ValueFeature extends Feature {
private float configValue = -1f;
private String configValueStr = null;
private Object value = null;
private Boolean required = null;
public Object getValue() {
return value;
}
public void setValue(Object value) {
this.value = value;
if (value instanceof String) {
configValueStr = (String) value;
} else if (value instanceof Double) {
configValue = ((Double) value).floatValue();
} else if (value instanceof Float) {
configValue = ((Float) value).floatValue();
} else if (value instanceof Integer) {
configValue = ((Integer) value).floatValue();
} else if (value instanceof Long) {
configValue = ((Long) value).floatValue();
} else {
throw new FeatureException("Invalid type for 'value' in params for " + this);
}
}
public boolean isRequired() {
return Boolean.TRUE.equals(required);
}
public void setRequired(boolean required) {
this.required = required;
}
@Override
public LinkedHashMap paramsToMap() {
final LinkedHashMap params = defaultParamsToMap();
params.put("value", value);
if (required != null) {
params.put("required", required);
}
return params;
}
@Override
protected void validate() throws FeatureException {
if (configValueStr != null && configValueStr.trim().isEmpty()) {
throw new FeatureException("Empty field 'value' in params for " + this);
}
}
public ValueFeature(String name, Map params) {
super(name, params);
}
@Override
public FeatureWeight createWeight(
IndexSearcher searcher,
boolean needsScores,
SolrQueryRequest request,
Query originalQuery,
Map efi)
throws IOException {
return new ValueFeatureWeight(searcher, request, originalQuery, efi);
}
public class ValueFeatureWeight extends FeatureWeight {
protected final Float featureValue;
public ValueFeatureWeight(
IndexSearcher searcher,
SolrQueryRequest request,
Query originalQuery,
Map efi) {
super(ValueFeature.this, searcher, request, originalQuery, efi);
if (configValueStr != null) {
final String expandedValue = macroExpander.expand(configValueStr);
if (expandedValue != null) {
featureValue = Float.parseFloat(expandedValue);
} else if (isRequired()) {
throw new FeatureException(
this.getClass().getSimpleName()
+ " requires efi parameter that was not passed in request.");
} else {
featureValue = null;
}
} else {
featureValue = configValue;
}
}
@Override
public FeatureScorer scorer(LeafReaderContext context) throws IOException {
if (featureValue != null) {
return new ValueFeatureScorer(
this, featureValue, DocIdSetIterator.all(DocIdSetIterator.NO_MORE_DOCS));
} else {
return null;
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy