Package org.opensearch.index.similarity

Class SimilarityService

java.lang.Object

org.opensearch.index.AbstractIndexComponent

org.opensearch.index.similarity.SimilarityService

All Implemented Interfaces:

IndexComponent

@PublicApi(since="1.0.0")
public final class SimilarityService
extends AbstractIndexComponent

Service for similarity computations

Opensearch.api:

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,org.opensearch.common.TriFunction<Settings,org.opensearch.Version,ScriptService,org.apache.lucene.search.similarities.Similarity>>	BUILT_IN
static final String	DEFAULT_SIMILARITY

Fields inherited from class org.opensearch.index.AbstractIndexComponent

indexSettings, logger

Constructor Summary

Constructors

Constructor	Description
SimilarityService(IndexSettings indexSettings, ScriptService scriptService, Map<String,org.opensearch.common.TriFunction<Settings,org.opensearch.Version,ScriptService,org.apache.lucene.search.similarities.Similarity>> similarities)

Method Summary

Modifier and Type	Method	Description
SimilarityProvider	getSimilarity(String name)
org.apache.lucene.search.similarities.Similarity	similarity(MapperService mapperService)

Methods inherited from class org.opensearch.index.AbstractIndexComponent

getIndexSettings, index

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SIMILARITY

public static final String DEFAULT_SIMILARITY

See Also:

• Constant Field Values

BUILT_IN

public static final Map<String,org.opensearch.common.TriFunction<Settings,org.opensearch.Version,ScriptService,org.apache.lucene.search.similarities.Similarity>> BUILT_IN

Constructor Details

SimilarityService

public SimilarityService(IndexSettings indexSettings,
 ScriptService scriptService,
 Map<String,org.opensearch.common.TriFunction<Settings,org.opensearch.Version,ScriptService,org.apache.lucene.search.similarities.Similarity>> similarities)

Method Details

similarity

public org.apache.lucene.search.similarities.Similarity similarity(MapperService mapperService)

getSimilarity

public SimilarityProvider getSimilarity(String name)