com.o19s.es.ltr.query.FeatureVectorWeight Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-learning-to-rank Show documentation

Learing to Rank Query w/ RankLib Models

There is a newer version: 6.8.0

Show newest version

/*
 * Copyright [2017] Wikimedia Foundation
 *
 * Licensed 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 com.o19s.es.ltr.query;

import com.o19s.es.ltr.ranker.LtrRanker;
import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.search.Explanation;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.Scorer;
import org.apache.lucene.search.Weight;

import java.io.IOException;
import java.util.function.Supplier;

/**
 * A weight allowing to inject the FeatureVector in use by the RankerQuery
 */
public abstract class FeatureVectorWeight extends Weight {
    protected FeatureVectorWeight(Query query) {
        super(query);
    }

    @Override
    public final Scorer scorer(LeafReaderContext context) throws IOException {
        throw new UnsupportedOperationException("This Weight cannot work outside the RankerQuery context: " +
                "you must call scorer(context, vectorSupplier)");
    }

    @Override
    public Explanation explain(LeafReaderContext context, int doc) throws IOException {
        throw new UnsupportedOperationException("This Weight cannot work outside the RankerQuery context:" +
                "you must call explain(context, vector, doc)");
    }

    public abstract Explanation explain(LeafReaderContext context, LtrRanker.FeatureVector vector, int doc) throws IOException;

    /**
     *
     * @param context surrent segment
     * @param vectorSupplier supplier of the feature vector (always call get(), it must not be cached)
     * @return The scorer
     */
    public abstract Scorer scorer(LeafReaderContext context, Supplier vectorSupplier) throws IOException;
}