Package com.algolia.model.recommend

Class RecommendationsResults

java.lang.Object

com.algolia.model.recommend.RecommendationsResults

public class RecommendationsResults
extends Object

RecommendationsResults

Constructor Summary

Constructors

Constructor	Description
RecommendationsResults()

Method Summary

Modifier and Type	Method	Description
RecommendationsResults	addHits(RecommendationsHit hitsItem)
boolean	equals(Object o)
Integer	getAbTestID()	A/B test ID.
Integer	getAbTestVariantID()	Variant ID.
String	getAroundLatLng()	Computed geographical location.
Boolean	getAutomaticInsights()	Whether automatic events collection is enabled for the application.
String	getAutomaticRadius()	Distance from a central coordinate provided by `aroundLatLng`.
Exhaustive	getExhaustive()	Get exhaustive
Boolean	getExhaustiveFacetsCount()	Deprecated.
Boolean	getExhaustiveNbHits()	Deprecated.
Boolean	getExhaustiveTypo()	Deprecated.
Map<String,Map<String,Integer>>	getFacets()	Facet counts.
Map<String,FacetStats>	getFacetsStats()	Statistics for numerical facets.
List<RecommendationsHit>	getHits()	Get hits
Integer	getHitsPerPage()	Number of hits per page.
String	getIndex()	Index name used for the query.
String	getIndexUsed()	Index name used for the query.
String	getMessage()	Warnings about the query.
Integer	getNbHits()	Number of results (hits).
Integer	getNbPages()	Number of pages of results.
Integer	getNbSortedHits()	Number of hits selected and sorted by the relevant sort algorithm.
Integer	getPage()	Page of search results to retrieve.
String	getParsedQuery()	Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
Integer	getProcessingTimeMS()	Time the server took to process the request, in milliseconds.
Object	getProcessingTimingsMS()	Experimental.
String	getQueryAfterRemoval()	Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
String	getQueryID()	Unique identifier for the query.
Redirect	getRedirect()	Get redirect
RenderingContent	getRenderingContent()	Get renderingContent
Integer	getServerTimeMS()	Time the server took to process the request, in milliseconds.
String	getServerUsed()	Host name of the server that processed the request.
Object	getUserData()	An object with custom data.
int	hashCode()
RecommendationsResults	putFacets(String key, Map<String,Integer> facetsItem)
RecommendationsResults	putFacetsStats(String key, FacetStats facetsStatsItem)
RecommendationsResults	setAbTestID(Integer abTestID)
RecommendationsResults	setAbTestVariantID(Integer abTestVariantID)
RecommendationsResults	setAroundLatLng(String aroundLatLng)
RecommendationsResults	setAutomaticInsights(Boolean automaticInsights)
RecommendationsResults	setAutomaticRadius(String automaticRadius)
RecommendationsResults	setExhaustive(Exhaustive exhaustive)
RecommendationsResults	setExhaustiveFacetsCount(Boolean exhaustiveFacetsCount)
RecommendationsResults	setExhaustiveNbHits(Boolean exhaustiveNbHits)
RecommendationsResults	setExhaustiveTypo(Boolean exhaustiveTypo)
RecommendationsResults	setFacets(Map<String,Map<String,Integer>> facets)
RecommendationsResults	setFacetsStats(Map<String,FacetStats> facetsStats)
RecommendationsResults	setHits(List<RecommendationsHit> hits)
RecommendationsResults	setHitsPerPage(Integer hitsPerPage)
RecommendationsResults	setIndex(String index)
RecommendationsResults	setIndexUsed(String indexUsed)
RecommendationsResults	setMessage(String message)
RecommendationsResults	setNbHits(Integer nbHits)
RecommendationsResults	setNbPages(Integer nbPages)
RecommendationsResults	setNbSortedHits(Integer nbSortedHits)
RecommendationsResults	setPage(Integer page)
RecommendationsResults	setParsedQuery(String parsedQuery)
RecommendationsResults	setProcessingTimeMS(Integer processingTimeMS)
RecommendationsResults	setProcessingTimingsMS(Object processingTimingsMS)
RecommendationsResults	setQueryAfterRemoval(String queryAfterRemoval)
RecommendationsResults	setQueryID(String queryID)
RecommendationsResults	setRedirect(Redirect redirect)
RecommendationsResults	setRenderingContent(RenderingContent renderingContent)
RecommendationsResults	setServerTimeMS(Integer serverTimeMS)
RecommendationsResults	setServerUsed(String serverUsed)
RecommendationsResults	setUserData(Object userData)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RecommendationsResults

public RecommendationsResults()

Method Details

setAbTestID

public RecommendationsResults setAbTestID(Integer abTestID)

getAbTestID

@Nullable
public Integer getAbTestID()

A/B test ID. This is only included in the response for indices that are part of an A/B test.

setAbTestVariantID

public RecommendationsResults setAbTestVariantID(Integer abTestVariantID)

getAbTestVariantID

@Nullable
public Integer getAbTestVariantID()

Variant ID. This is only included in the response for indices that are part of an A/B test. minimum: 1

setAroundLatLng

public RecommendationsResults setAroundLatLng(String aroundLatLng)

getAroundLatLng

@Nullable
public String getAroundLatLng()

Computed geographical location.

setAutomaticRadius

public RecommendationsResults setAutomaticRadius(String automaticRadius)

getAutomaticRadius

@Nullable
public String getAutomaticRadius()

Distance from a central coordinate provided by `aroundLatLng`.

setExhaustive

public RecommendationsResults setExhaustive(Exhaustive exhaustive)

getExhaustive

@Nullable
public Exhaustive getExhaustive()

Get exhaustive

setExhaustiveFacetsCount

public RecommendationsResults setExhaustiveFacetsCount(Boolean exhaustiveFacetsCount)

getExhaustiveFacetsCount

@Deprecated
@Nullable
public Boolean getExhaustiveFacetsCount()

Deprecated.

See the `facetsCount` field of the `exhaustive` object in the response.

setExhaustiveNbHits

public RecommendationsResults setExhaustiveNbHits(Boolean exhaustiveNbHits)

getExhaustiveNbHits

@Deprecated
@Nullable
public Boolean getExhaustiveNbHits()

Deprecated.

See the `nbHits` field of the `exhaustive` object in the response.

setExhaustiveTypo

public RecommendationsResults setExhaustiveTypo(Boolean exhaustiveTypo)

getExhaustiveTypo

@Deprecated
@Nullable
public Boolean getExhaustiveTypo()

Deprecated.

See the `typo` field of the `exhaustive` object in the response.

setFacets

public RecommendationsResults setFacets(Map<String,Map<String,Integer>> facets)

putFacets

public RecommendationsResults putFacets(String key,
 Map<String,Integer> facetsItem)

getFacets

@Nullable
public Map<String,Map<String,Integer>> getFacets()

Facet counts.

setFacetsStats

public RecommendationsResults setFacetsStats(Map<String,FacetStats> facetsStats)

putFacetsStats

public RecommendationsResults putFacetsStats(String key,
 FacetStats facetsStatsItem)

getFacetsStats

@Nullable
public Map<String,FacetStats> getFacetsStats()

Statistics for numerical facets.

setIndex

public RecommendationsResults setIndex(String index)

getIndex

@Nullable
public String getIndex()

Index name used for the query.

setIndexUsed

public RecommendationsResults setIndexUsed(String indexUsed)

getIndexUsed

@Nullable
public String getIndexUsed()

Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.

setMessage

public RecommendationsResults setMessage(String message)

getMessage

@Nullable
public String getMessage()

Warnings about the query.

setNbSortedHits

public RecommendationsResults setNbSortedHits(Integer nbSortedHits)

getNbSortedHits

@Nullable
public Integer getNbSortedHits()

Number of hits selected and sorted by the relevant sort algorithm.

setParsedQuery

public RecommendationsResults setParsedQuery(String parsedQuery)

getParsedQuery

@Nullable
public String getParsedQuery()

Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.

setProcessingTimeMS

public RecommendationsResults setProcessingTimeMS(Integer processingTimeMS)

getProcessingTimeMS

@Nonnull
public Integer getProcessingTimeMS()

Time the server took to process the request, in milliseconds.

setProcessingTimingsMS

public RecommendationsResults setProcessingTimingsMS(Object processingTimingsMS)

getProcessingTimingsMS

@Nullable
public Object getProcessingTimingsMS()

Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.

setQueryAfterRemoval

public RecommendationsResults setQueryAfterRemoval(String queryAfterRemoval)

getQueryAfterRemoval

@Nullable
public String getQueryAfterRemoval()

Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.

setRedirect

public RecommendationsResults setRedirect(Redirect redirect)

getRedirect

@Nullable
public Redirect getRedirect()

Get redirect

setRenderingContent

public RecommendationsResults setRenderingContent(RenderingContent renderingContent)

getRenderingContent

@Nullable
public RenderingContent getRenderingContent()

Get renderingContent

setServerTimeMS

public RecommendationsResults setServerTimeMS(Integer serverTimeMS)

getServerTimeMS

@Nullable
public Integer getServerTimeMS()

Time the server took to process the request, in milliseconds.

setServerUsed

public RecommendationsResults setServerUsed(String serverUsed)

getServerUsed

@Nullable
public String getServerUsed()

Host name of the server that processed the request.

setUserData

public RecommendationsResults setUserData(Object userData)

getUserData

@Nullable
public Object getUserData()

An object with custom data. You can store up to 32kB as custom data.

setQueryID

public RecommendationsResults setQueryID(String queryID)

getQueryID

@Nullable
public String getQueryID()

Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).

setAutomaticInsights

public RecommendationsResults setAutomaticInsights(Boolean automaticInsights)

getAutomaticInsights

@Nullable
public Boolean getAutomaticInsights()

Whether automatic events collection is enabled for the application.

setPage

public RecommendationsResults setPage(Integer page)

getPage

@Nullable
public Integer getPage()

Page of search results to retrieve. minimum: 0

setNbHits

public RecommendationsResults setNbHits(Integer nbHits)

getNbHits

@Nullable
public Integer getNbHits()

Number of results (hits).

setNbPages

public RecommendationsResults setNbPages(Integer nbPages)

getNbPages

@Nullable
public Integer getNbPages()

Number of pages of results.

setHitsPerPage

public RecommendationsResults setHitsPerPage(Integer hitsPerPage)

getHitsPerPage

@Nullable
public Integer getHitsPerPage()

Number of hits per page. minimum: 1 maximum: 1000

setHits

public RecommendationsResults setHits(List<RecommendationsHit> hits)

addHits

public RecommendationsResults addHits(RecommendationsHit hitsItem)

getHits

@Nonnull
public List<RecommendationsHit> getHits()

Get hits

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