Package org.apache.solr.ltr.search

Class LTRQParserPlugin

java.lang.Object

org.apache.solr.search.QParserPlugin

org.apache.solr.ltr.search.LTRQParserPlugin

All Implemented Interfaces:

org.apache.lucene.analysis.util.ResourceLoaderAware, SolrInfoBean, ManagedResourceObserver, NamedListInitializedPlugin

public class LTRQParserPlugin
extends QParserPlugin
implements org.apache.lucene.analysis.util.ResourceLoaderAware, ManagedResourceObserver

Plug into solr a rerank model. Learning to Rank Query Parser Syntax: rq={!ltr model=6029760550880411648 reRankDocs=300 efi.myCompanyQueryIntent=0.98}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LTRQParserPlugin.LTRQParser
class	LTRQParserPlugin.LTRQuery	A learning to rank Query, will incapsulate a learning to rank model, and delegate to it the rescoring of the documents.

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean

SolrInfoBean.Category, SolrInfoBean.Group

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_RERANK_DOCS	query parser plugin: default number of documents to rerank
static String	MODEL	query parser plugin: the name of the attribute for setting the model
static String	NAME
static String	RERANK_DOCS	query parser plugin:the param that will select how the number of document to rerank

Fields inherited from class org.apache.solr.search.QParserPlugin

DEFAULT_QTYPE, standardPlugins

Constructor Summary

Constructors

Constructor	Description
LTRQParserPlugin()

Method Summary

Modifier and Type	Method	Description
QParser	createParser(String qstr, SolrParams localParams, SolrParams params, SolrQueryRequest req)
static Map<String,String[]>	extractEFIParams(SolrParams localParams)	Given a set of local SolrParams, extract all of the efi.key=value params into a map
void	inform(org.apache.lucene.analysis.util.ResourceLoader loader)
void	init(NamedList args)
void	onManagedResourceInitialized(NamedList<?> args, ManagedResource res)

Methods inherited from class org.apache.solr.search.QParserPlugin

getCategory, getDescription, getMetricNames, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.core.SolrInfoBean

getMetricRegistry, getMetricsSnapshot, registerMetricName

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

MODEL

public static final String MODEL

query parser plugin: the name of the attribute for setting the model

See Also:

Constant Field Values

DEFAULT_RERANK_DOCS

public static final int DEFAULT_RERANK_DOCS

query parser plugin: default number of documents to rerank

See Also:

Constant Field Values

RERANK_DOCS

public static final String RERANK_DOCS

query parser plugin:the param that will select how the number of document to rerank

See Also:

Constant Field Values

Constructor Detail

LTRQParserPlugin

public LTRQParserPlugin()

Method Detail

init

public void init(NamedList args)

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class QParserPlugin

createParser

public QParser createParser(String qstr,
                            SolrParams localParams,
                            SolrParams params,
                            SolrQueryRequest req)

Specified by:

createParser in class QParserPlugin

extractEFIParams

public static Map<String,String[]> extractEFIParams(SolrParams localParams)

Given a set of local SolrParams, extract all of the efi.key=value params into a map

Parameters:

localParams - Local request parameters that might conatin efi params

Returns:

Map of efi params, where the key is the name of the efi param, and the value is the value of the efi param

inform

public void inform(org.apache.lucene.analysis.util.ResourceLoader loader)
            throws IOException

Specified by:

inform in interface org.apache.lucene.analysis.util.ResourceLoaderAware

Throws:

IOException

onManagedResourceInitialized

public void onManagedResourceInitialized(NamedList<?> args,
                                         ManagedResource res)
                                  throws SolrException

Specified by:

onManagedResourceInitialized in interface ManagedResourceObserver

Throws:

SolrException