Package com.algolia.model.recommend
Class RecommendationsResponse
java.lang.Object
com.algolia.model.recommend.RecommendationsResponse
RecommendationsResponse
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddHits
(RecommendHit hitsItem) boolean
A/B test ID.Variant ID.Computed geographical location.Automatically-computed radius.Indicates whether the facet count is exhaustive (exact) or approximate.Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.Indicates whether the search for typos was exhaustive (exact) or approximate.Mapping of each facet name to the corresponding facet counts.Statistics for numerical facets.getHits()
Get hitsNumber of hits per page.getIndex()
Index name used for the query.Index name used for the query.Warnings about the query.Number of hits the search query matched.Number of pages of results for the current query.Number of hits selected and sorted by the relevant sort algorithm.getPage()
Page to retrieve (the first page is `0`, not `1`).URL-encoded string of all search parameters.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.Time the server took to process the request, in milliseconds.getQuery()
Text to search for in an index.Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.Get redirectGet renderingContentHost name of the server that processed the request.Lets you store custom data in your indices.int
hashCode()
putFacetsStats
(String key, FacetsStats facetsStatsItem) setAbTestID
(Integer abTestID) setAbTestVariantID
(Integer abTestVariantID) setAroundLatLng
(String aroundLatLng) setAutomaticRadius
(String automaticRadius) setExhaustiveFacetsCount
(Boolean exhaustiveFacetsCount) setExhaustiveNbHits
(Boolean exhaustiveNbHits) setExhaustiveTypo
(Boolean exhaustiveTypo) setFacetsStats
(Map<String, FacetsStats> facetsStats) setHits
(List<RecommendHit> hits) setHitsPerPage
(Integer hitsPerPage) setIndexUsed
(String indexUsed) setMessage
(String message) setNbPages
(Integer nbPages) setNbSortedHits
(Integer nbSortedHits) setParsedQuery
(String parsedQuery) setProcessingTimeMS
(Integer processingTimeMS) setQueryAfterRemoval
(String queryAfterRemoval) setRedirect
(BaseSearchResponseRedirect redirect) setRenderingContent
(RenderingContent renderingContent) setServerUsed
(String serverUsed) setUserData
(Object userData) toString()
-
Constructor Details
-
RecommendationsResponse
public RecommendationsResponse()
-
-
Method Details
-
setAbTestID
-
getAbTestID
A/B test ID. This is only included in the response for indices that are part of an A/B test.- Returns:
- abTestID
-
setAbTestVariantID
-
getAbTestVariantID
Variant ID. This is only included in the response for indices that are part of an A/B test. minimum: 1- Returns:
- abTestVariantID
-
setAroundLatLng
-
getAroundLatLng
Computed geographical location.- Returns:
- aroundLatLng
-
setAutomaticRadius
-
getAutomaticRadius
Automatically-computed radius.- Returns:
- automaticRadius
-
setExhaustiveFacetsCount
-
getExhaustiveFacetsCount
Indicates whether the facet count is exhaustive (exact) or approximate.- Returns:
- exhaustiveFacetsCount
-
setExhaustiveNbHits
-
getExhaustiveNbHits
Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.- Returns:
- exhaustiveNbHits
-
setExhaustiveTypo
-
getExhaustiveTypo
Indicates whether the search for typos was exhaustive (exact) or approximate.- Returns:
- exhaustiveTypo
-
setFacets
-
putFacets
-
getFacets
Mapping of each facet name to the corresponding facet counts.- Returns:
- facets
-
setFacetsStats
-
putFacetsStats
-
getFacetsStats
Statistics for numerical facets.- Returns:
- facetsStats
-
setHitsPerPage
-
getHitsPerPage
Number of hits per page. minimum: 1 maximum: 1000- Returns:
- hitsPerPage
-
setIndex
-
getIndex
Index name used for the query.- Returns:
- index
-
setIndexUsed
-
getIndexUsed
Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.- Returns:
- indexUsed
-
setMessage
-
getMessage
Warnings about the query.- Returns:
- message
-
setNbHits
-
getNbHits
Number of hits the search query matched.- Returns:
- nbHits
-
setNbPages
-
getNbPages
Number of pages of results for the current query.- Returns:
- nbPages
-
setNbSortedHits
-
getNbSortedHits
Number of hits selected and sorted by the relevant sort algorithm.- Returns:
- nbSortedHits
-
setPage
-
getPage
Page to retrieve (the first page is `0`, not `1`).- Returns:
- page
-
setRedirect
-
getRedirect
Get redirect- Returns:
- redirect
-
setParsedQuery
-
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.- Returns:
- parsedQuery
-
setProcessingTimeMS
-
getProcessingTimeMS
Time the server took to process the request, in milliseconds.- Returns:
- processingTimeMS
-
setQueryAfterRemoval
-
getQueryAfterRemoval
Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.- Returns:
- queryAfterRemoval
-
setServerUsed
-
getServerUsed
Host name of the server that processed the request.- Returns:
- serverUsed
-
setUserData
-
getUserData
Lets you store custom data in your indices.- Returns:
- userData
-
setRenderingContent
-
getRenderingContent
Get renderingContent- Returns:
- renderingContent
-
setHits
-
addHits
-
getHits
Get hits- Returns:
- hits
-
setQuery
-
getQuery
Text to search for in an index.- Returns:
- query
-
setParams
-
getParams
URL-encoded string of all search parameters.- Returns:
- params
-
equals
-
hashCode
public int hashCode() -
toString
-