Package com.algolia.model.recommend

Class RecommendationsResponse

java.lang.Object

com.algolia.model.recommend.RecommendationsResponse

public class RecommendationsResponse
extends Object

RecommendationsResponse

Constructor Summary

Constructors

Constructor	Description
RecommendationsResponse()

Method Summary

Modifier and Type	Method	Description
RecommendationsResponse	addHits(RecommendHit hitsItem)
boolean	equals(Object o)
Integer	getAbTestID()	A/B test ID.
Integer	getAbTestVariantID()	Variant ID.
String	getAroundLatLng()	Computed geographical location.
String	getAutomaticRadius()	Automatically-computed radius.
Boolean	getExhaustiveFacetsCount()	Indicates whether the facet count is exhaustive (exact) or approximate.
Boolean	getExhaustiveNbHits()	Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.
Boolean	getExhaustiveTypo()	Indicates whether the search for typos was exhaustive (exact) or approximate.
Map<String,Map<String,Integer>>	getFacets()	Mapping of each facet name to the corresponding facet counts.
Map<String,FacetsStats>	getFacetsStats()	Statistics for numerical facets.
List<RecommendHit>	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 hits the search query matched.
Integer	getNbPages()	Number of pages of results for the current query.
Integer	getNbSortedHits()	Number of hits selected and sorted by the relevant sort algorithm.
Integer	getPage()	Page to retrieve (the first page is `0`, not `1`).
String	getParams()	URL-encoded string of all search parameters.
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.
String	getQuery()	Text to search for in an index.
String	getQueryAfterRemoval()	Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
BaseSearchResponseRedirect	getRedirect()	Get redirect
RenderingContent	getRenderingContent()	Get renderingContent
String	getServerUsed()	Host name of the server that processed the request.
Object	getUserData()	Lets you store custom data in your indices.
int	hashCode()
RecommendationsResponse	putFacets(String key, Map<String,Integer> facetsItem)
RecommendationsResponse	putFacetsStats(String key, FacetsStats facetsStatsItem)
RecommendationsResponse	setAbTestID(Integer abTestID)
RecommendationsResponse	setAbTestVariantID(Integer abTestVariantID)
RecommendationsResponse	setAroundLatLng(String aroundLatLng)
RecommendationsResponse	setAutomaticRadius(String automaticRadius)
RecommendationsResponse	setExhaustiveFacetsCount(Boolean exhaustiveFacetsCount)
RecommendationsResponse	setExhaustiveNbHits(Boolean exhaustiveNbHits)
RecommendationsResponse	setExhaustiveTypo(Boolean exhaustiveTypo)
RecommendationsResponse	setFacets(Map<String,Map<String,Integer>> facets)
RecommendationsResponse	setFacetsStats(Map<String,FacetsStats> facetsStats)
RecommendationsResponse	setHits(List<RecommendHit> hits)
RecommendationsResponse	setHitsPerPage(Integer hitsPerPage)
RecommendationsResponse	setIndex(String index)
RecommendationsResponse	setIndexUsed(String indexUsed)
RecommendationsResponse	setMessage(String message)
RecommendationsResponse	setNbHits(Integer nbHits)
RecommendationsResponse	setNbPages(Integer nbPages)
RecommendationsResponse	setNbSortedHits(Integer nbSortedHits)
RecommendationsResponse	setPage(Integer page)
RecommendationsResponse	setParams(String params)
RecommendationsResponse	setParsedQuery(String parsedQuery)
RecommendationsResponse	setProcessingTimeMS(Integer processingTimeMS)
RecommendationsResponse	setQuery(String query)
RecommendationsResponse	setQueryAfterRemoval(String queryAfterRemoval)
RecommendationsResponse	setRedirect(BaseSearchResponseRedirect redirect)
RecommendationsResponse	setRenderingContent(RenderingContent renderingContent)
RecommendationsResponse	setServerUsed(String serverUsed)
RecommendationsResponse	setUserData(Object userData)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

RecommendationsResponse

public RecommendationsResponse()

Method Details

setAbTestID

public RecommendationsResponse 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 RecommendationsResponse 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 RecommendationsResponse setAroundLatLng(String aroundLatLng)

getAroundLatLng

@Nullable
public String getAroundLatLng()

Computed geographical location.

setAutomaticRadius

public RecommendationsResponse setAutomaticRadius(String automaticRadius)

getAutomaticRadius

@Nullable
public String getAutomaticRadius()

Automatically-computed radius.

setExhaustiveFacetsCount

public RecommendationsResponse setExhaustiveFacetsCount(Boolean exhaustiveFacetsCount)

getExhaustiveFacetsCount

@Nullable
public Boolean getExhaustiveFacetsCount()

Indicates whether the facet count is exhaustive (exact) or approximate.

setExhaustiveNbHits

public RecommendationsResponse setExhaustiveNbHits(Boolean exhaustiveNbHits)

getExhaustiveNbHits

@Nonnull
public Boolean getExhaustiveNbHits()

Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.

setExhaustiveTypo

public RecommendationsResponse setExhaustiveTypo(Boolean exhaustiveTypo)

getExhaustiveTypo

@Nullable
public Boolean getExhaustiveTypo()

Indicates whether the search for typos was exhaustive (exact) or approximate.

setFacets

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

putFacets

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

getFacets

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

Mapping of each facet name to the corresponding facet counts.

setFacetsStats

public RecommendationsResponse setFacetsStats(Map<String,FacetsStats> facetsStats)

putFacetsStats

public RecommendationsResponse putFacetsStats(String key,
 FacetsStats facetsStatsItem)

getFacetsStats

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

Statistics for numerical facets.

setHitsPerPage

public RecommendationsResponse setHitsPerPage(Integer hitsPerPage)

getHitsPerPage

@Nonnull
public Integer getHitsPerPage()

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

setIndex

public RecommendationsResponse setIndex(String index)

getIndex

@Nullable
public String getIndex()

Index name used for the query.

setIndexUsed

public RecommendationsResponse 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 RecommendationsResponse setMessage(String message)

getMessage

@Nullable
public String getMessage()

Warnings about the query.

setNbHits

public RecommendationsResponse setNbHits(Integer nbHits)

getNbHits

@Nonnull
public Integer getNbHits()

Number of hits the search query matched.

setNbPages

public RecommendationsResponse setNbPages(Integer nbPages)

getNbPages

@Nonnull
public Integer getNbPages()

Number of pages of results for the current query.

setNbSortedHits

public RecommendationsResponse setNbSortedHits(Integer nbSortedHits)

getNbSortedHits

@Nullable
public Integer getNbSortedHits()

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

setPage

public RecommendationsResponse setPage(Integer page)

getPage

@Nonnull
public Integer getPage()

Page to retrieve (the first page is `0`, not `1`).

setRedirect

public RecommendationsResponse setRedirect(BaseSearchResponseRedirect redirect)

getRedirect

@Nullable
public BaseSearchResponseRedirect getRedirect()

Get redirect

setParsedQuery

public RecommendationsResponse 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 RecommendationsResponse setProcessingTimeMS(Integer processingTimeMS)

getProcessingTimeMS

@Nonnull
public Integer getProcessingTimeMS()

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

setQueryAfterRemoval

public RecommendationsResponse 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.

setServerUsed

public RecommendationsResponse setServerUsed(String serverUsed)

getServerUsed

@Nullable
public String getServerUsed()

Host name of the server that processed the request.

setUserData

public RecommendationsResponse setUserData(Object userData)

getUserData

@Nullable
public Object getUserData()

Lets you store custom data in your indices.

setRenderingContent

public RecommendationsResponse setRenderingContent(RenderingContent renderingContent)

getRenderingContent

@Nullable
public RenderingContent getRenderingContent()

Get renderingContent

setHits

public RecommendationsResponse setHits(List<RecommendHit> hits)

addHits

public RecommendationsResponse addHits(RecommendHit hitsItem)

getHits

@Nonnull
public List<RecommendHit> getHits()

Get hits

setQuery

public RecommendationsResponse setQuery(String query)

getQuery

@Nullable
public String getQuery()

Text to search for in an index.

setParams

public RecommendationsResponse setParams(String params)

getParams

@Nullable
public String getParams()

URL-encoded string of all search parameters.

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