Package com.algolia.model.recommend

Class RecommendationsQuery

java.lang.Object

com.algolia.model.recommend.RecommendationsQuery

All Implemented Interfaces:

RecommendationsRequest

public class RecommendationsQuery
extends Object
implements RecommendationsRequest

RecommendationsQuery

Nested Class Summary

Nested classes/interfaces inherited from interface com.algolia.model.recommend.RecommendationsRequest

RecommendationsRequest.Deserializer

Constructor Summary

Constructors

Constructor	Description
RecommendationsQuery()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SearchParamsObject	getFallbackParameters()	Get fallbackParameters
String	getIndexName()	Algolia index name.
Integer	getMaxRecommendations()	Maximum number of recommendations to retrieve.
RecommendationModels	getModel()	Get model
String	getObjectID()	Unique object identifier.
SearchParamsObject	getQueryParameters()	Get queryParameters
Integer	getThreshold()	Recommendations with a confidence score lower than `threshold` won't appear in results.
int	hashCode()
RecommendationsQuery	setFallbackParameters(SearchParamsObject fallbackParameters)
RecommendationsQuery	setIndexName(String indexName)
RecommendationsQuery	setMaxRecommendations(Integer maxRecommendations)
RecommendationsQuery	setModel(RecommendationModels model)
RecommendationsQuery	setObjectID(String objectID)
RecommendationsQuery	setQueryParameters(SearchParamsObject queryParameters)
RecommendationsQuery	setThreshold(Integer threshold)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RecommendationsQuery

public RecommendationsQuery()

Method Details

setIndexName

public RecommendationsQuery setIndexName(String indexName)

getIndexName

@Nonnull
public String getIndexName()

Algolia index name.

setThreshold

public RecommendationsQuery setThreshold(Integer threshold)

getThreshold

@Nullable
public Integer getThreshold()

Recommendations with a confidence score lower than `threshold` won't appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are. minimum: 0 maximum: 100

setMaxRecommendations

public RecommendationsQuery setMaxRecommendations(Integer maxRecommendations)

getMaxRecommendations

@Nullable
public Integer getMaxRecommendations()

Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.

setModel

public RecommendationsQuery setModel(RecommendationModels model)

getModel

@Nonnull
public RecommendationModels getModel()

Get model

setObjectID

public RecommendationsQuery setObjectID(String objectID)

getObjectID

@Nonnull
public String getObjectID()

Unique object identifier.

setQueryParameters

public RecommendationsQuery setQueryParameters(SearchParamsObject queryParameters)

getQueryParameters

@Nullable
public SearchParamsObject getQueryParameters()

Get queryParameters

setFallbackParameters

public RecommendationsQuery setFallbackParameters(SearchParamsObject fallbackParameters)

getFallbackParameters

@Nullable
public SearchParamsObject getFallbackParameters()

Get fallbackParameters

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object