Package org.opensearch.index.rankeval

Class RestRankEvalAction

java.lang.Object

org.opensearch.rest.BaseRestHandler

org.opensearch.index.rankeval.RestRankEvalAction

All Implemented Interfaces:

RestHandler

public class RestRankEvalAction
extends BaseRestHandler

{ "requests": [{ "id": "amsterdam_query", "request": { "query": { "match": { "text": "amsterdam" } } }, "ratings": [{ "_index": "foo", "_id": "doc1", "rating": 0 }, { "_index": "foo", "_id": "doc2", "rating": 1 }, { "_index": "foo", "_id": "doc3", "rating": 1 } ] }, { "id": "berlin_query", "request": { "query": { "match": { "text": "berlin" } }, "size": 10 }, "ratings": [{ "_index": "foo", "_id": "doc1", "rating": 1 }] } ], "metric": { "precision": { "ignore_unlabeled": true } } }

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.rest.BaseRestHandler

BaseRestHandler.RestChannelConsumer, BaseRestHandler.Wrapper

Nested classes/interfaces inherited from interface org.opensearch.rest.RestHandler

RestHandler.DeprecatedRoute, RestHandler.ReplacedRoute, RestHandler.Route

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDPOINT

Fields inherited from class org.opensearch.rest.BaseRestHandler

DUPLICATE_PARAMETER_ERROR_MESSAGE, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestRankEvalAction()

Method Summary

Modifier and Type	Method	Description
String	getName()
protected BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)
List<RestHandler.Route>	routes()

Methods inherited from class org.opensearch.rest.BaseRestHandler

getUsageCount, handleRequest, parseDeprecatedMasterTimeoutParameter, responseParams, sendTask, unrecognized, unrecognizedStrings

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.rest.RestHandler

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes, supportsContentStream

Field Details

ENDPOINT

public static String ENDPOINT

Constructor Details

RestRankEvalAction

public RestRankEvalAction()

Method Details

routes

public List<RestHandler.Route> routes()

prepareRequest

protected BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request,
 NodeClient client)
                                                      throws IOException

Specified by:

prepareRequest in class BaseRestHandler

Throws:

IOException

getName

public String getName()

Specified by:

getName in class BaseRestHandler