org.elasticsearch.search.rescore.Rescorer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.search.rescore;
import org.apache.lucene.search.Explanation;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.TopDocs;
import java.io.IOException;
/**
* A query rescorer interface used to re-rank the Top-K results of a previously
* executed search.
*
* Subclasses should borrow heavily from {@link QueryRescorer} because it is
* fairly well behaved and documents that tradeoffs that it is making. There
* is also an {@code ExampleRescorer} that is worth looking at.
*/
public interface Rescorer {
/**
* Modifies the result of the previously executed search ({@link TopDocs})
* in place based on the given {@link RescoreContext}.
*
* @param topDocs the result of the previously executed search
* @param searcher the searcher used for this search. This will never be null
.
* @param rescoreContext the {@link RescoreContext}. This will never be null
* @throws IOException if an {@link IOException} occurs during rescoring
*/
TopDocs rescore(TopDocs topDocs, IndexSearcher searcher, RescoreContext rescoreContext) throws IOException;
/**
* Executes an {@link Explanation} phase on the rescorer.
*
* @param topLevelDocId the global / top-level document ID to explain
* @param searcher the searcher used for this search. This will never be null
.
* @param rescoreContext context for this rescorer
* @param sourceExplanation explanation of the source of the documents being fed into this rescore
* @return the explain for the given top level document ID.
* @throws IOException if an {@link IOException} occurs
*/
Explanation explain(int topLevelDocId, IndexSearcher searcher, RescoreContext rescoreContext,
Explanation sourceExplanation) throws IOException;
}