Package com.algolia.model.search

Class ConsequenceParams

java.lang.Object
com.algolia.model.search.ConsequenceParams
public class ConsequenceParams extends Object
ConsequenceParams

  • Constructor Details

    • ConsequenceParams

      public ConsequenceParams()

  • Method Details

    • setSimilarQuery

      public ConsequenceParams setSimilarQuery(String similarQuery)

    • getSimilarQuery

      @Nullable public String getSimilarQuery()
      Overrides the query parameter and performs a more generic search.

    • setFilters

      public ConsequenceParams setFilters(String filters)

    • getFilters

      @Nullable public String getFilters()
      [Filter](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) the query with numeric, facet, or tag filters.

    • setFacetFilters

      public ConsequenceParams setFacetFilters(FacetFilters facetFilters)

    • getFacetFilters

      @Nullable public FacetFilters getFacetFilters()
      Get facetFilters

    • setOptionalFilters

      public ConsequenceParams setOptionalFilters(OptionalFilters optionalFilters)

    • getOptionalFilters

      @Nullable public OptionalFilters getOptionalFilters()
      Get optionalFilters

    • setNumericFilters

      public ConsequenceParams setNumericFilters(NumericFilters numericFilters)

    • getNumericFilters

      @Nullable public NumericFilters getNumericFilters()
      Get numericFilters

    • setTagFilters

      public ConsequenceParams setTagFilters(TagFilters tagFilters)

    • getTagFilters

      @Nullable public TagFilters getTagFilters()
      Get tagFilters

    • setSumOrFiltersScores

      public ConsequenceParams setSumOrFiltersScores(Boolean sumOrFiltersScores)

    • getSumOrFiltersScores

      @Nullable public Boolean getSumOrFiltersScores()
      Determines how to calculate [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores). If `false`, maximum score is kept. If `true`, score is summed.

    • setRestrictSearchableAttributes

      public ConsequenceParams setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

    • addRestrictSearchableAttributes

      public ConsequenceParams addRestrictSearchableAttributes(String restrictSearchableAttributesItem)

    • getRestrictSearchableAttributes

      @Nullable public List<String> getRestrictSearchableAttributes()
      Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).

    • setFacets

      public ConsequenceParams setFacets(List<String> facets)

    • addFacets

      public ConsequenceParams addFacets(String facetsItem)

    • getFacets

      @Nullable public List<String> getFacets()
      Returns [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts), their facet values, and the number of matching facet values.

    • setFacetingAfterDistinct

      public ConsequenceParams setFacetingAfterDistinct(Boolean facetingAfterDistinct)

    • getFacetingAfterDistinct

      @Nullable public Boolean getFacetingAfterDistinct()
      Forces faceting to be applied after [de-duplication](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/) (with the distinct feature). Alternatively, the `afterDistinct` [modifier](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) of `attributesForFaceting` allows for more granular control.

    • setPage

      public ConsequenceParams setPage(Integer page)

    • getPage

      @Nullable public Integer getPage()
      Page to retrieve (the first page is `0`, not `1`).

    • setOffset

      public ConsequenceParams setOffset(Integer offset)

    • getOffset

      @Nullable public Integer getOffset()
      Specifies the offset of the first hit to return. > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length).

    • setLength

      public ConsequenceParams setLength(Integer length)

    • getLength

      @Nullable public Integer getLength()
      Sets the number of hits to retrieve (for use with `offset`). > **Note**: Using `page` and `hitsPerPage` is the recommended method for [paging results](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/). However, you can use `offset` and `length` to implement [an alternative approach to paging](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/#retrieving-a-subset-of-records-with-offset-and-length). minimum: 1 maximum: 1000

    • setAroundLatLng

      public ConsequenceParams setAroundLatLng(String aroundLatLng)

    • getAroundLatLng

      @Nullable public String getAroundLatLng()
      Search for entries [around a central location](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filter-around-a-central-point), enabling a geographical search within a circular area.

    • setAroundLatLngViaIP

      public ConsequenceParams setAroundLatLngViaIP(Boolean aroundLatLngViaIP)

    • getAroundLatLngViaIP

      @Nullable public Boolean getAroundLatLngViaIP()
      Search for entries around a location. The location is automatically computed from the requester's IP address.

    • setAroundRadius

      public ConsequenceParams setAroundRadius(AroundRadius aroundRadius)

    • getAroundRadius

      @Nullable public AroundRadius getAroundRadius()
      Get aroundRadius

    • setAroundPrecision

      public ConsequenceParams setAroundPrecision(AroundPrecision aroundPrecision)

    • getAroundPrecision

      @Nullable public AroundPrecision getAroundPrecision()
      Get aroundPrecision

    • setMinimumAroundRadius

      public ConsequenceParams setMinimumAroundRadius(Integer minimumAroundRadius)

    • getMinimumAroundRadius

      @Nullable public Integer getMinimumAroundRadius()
      Minimum radius (in meters) used for a geographical search when `aroundRadius` isn't set. minimum: 1

    • setInsideBoundingBox

      public ConsequenceParams setInsideBoundingBox(List<List<Double>> insideBoundingBox)

    • addInsideBoundingBox

      public ConsequenceParams addInsideBoundingBox(List<Double> insideBoundingBoxItem)

    • getInsideBoundingBox

      @Nullable public List<List<Double>> getInsideBoundingBox()
      Search inside a [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).

    • setInsidePolygon

      public ConsequenceParams setInsidePolygon(List<List<Double>> insidePolygon)

    • addInsidePolygon

      public ConsequenceParams addInsidePolygon(List<Double> insidePolygonItem)

    • getInsidePolygon

      @Nullable public List<List<Double>> getInsidePolygon()
      Search inside a [polygon](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas) (in geographical coordinates).

    • setNaturalLanguages

      public ConsequenceParams setNaturalLanguages(List<String> naturalLanguages)

    • addNaturalLanguages

      public ConsequenceParams addNaturalLanguages(String naturalLanguagesItem)

    • getNaturalLanguages

      @Nullable public List<String> getNaturalLanguages()
      Changes the default values of parameters that work best for a natural language query, such as `ignorePlurals`, `removeStopWords`, `removeWordsIfNoResults`, `analyticsTags`, and `ruleContexts`. These parameters work well together when the query consists of fuller natural language strings instead of keywords, for example when processing voice search queries.

    • setRuleContexts

      public ConsequenceParams setRuleContexts(List<String> ruleContexts)

    • addRuleContexts

      public ConsequenceParams addRuleContexts(String ruleContextsItem)

    • getRuleContexts

      @Nullable public List<String> getRuleContexts()
      Assigns [rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) to search queries.

    • setPersonalizationImpact

      public ConsequenceParams setPersonalizationImpact(Integer personalizationImpact)

    • getPersonalizationImpact

      @Nullable public Integer getPersonalizationImpact()
      Defines how much [Personalization affects results](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).

    • setUserToken

      public ConsequenceParams setUserToken(String userToken)

    • getUserToken

      @Nullable public String getUserToken()
      Associates a [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/) with the current search.

    • setGetRankingInfo

      public ConsequenceParams setGetRankingInfo(Boolean getRankingInfo)

    • getGetRankingInfo

      @Nullable public Boolean getGetRankingInfo()
      Incidates whether the search response includes [detailed ranking information](https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/understanding-the-api-response/#ranking-information).

    • setExplain

      public ConsequenceParams setExplain(List<String> explain)

    • addExplain

      public ConsequenceParams addExplain(String explainItem)

    • getExplain

      @Nullable public List<String> getExplain()
      Enriches the API's response with information about how the query was processed.

    • setSynonyms

      public ConsequenceParams setSynonyms(Boolean synonyms)

    • getSynonyms

      @Nullable public Boolean getSynonyms()
      Whether to take into account an index's synonyms for a particular search.

    • setClickAnalytics

      public ConsequenceParams setClickAnalytics(Boolean clickAnalytics)

    • getClickAnalytics

      @Nullable public Boolean getClickAnalytics()
      Indicates whether a query ID parameter is included in the search response. This is required for [tracking click and conversion events](https://www.algolia.com/doc/guides/sending-events/concepts/event-types/#events-related-to-algolia-requests).

    • setAnalytics

      public ConsequenceParams setAnalytics(Boolean analytics)

    • getAnalytics

      @Nullable public Boolean getAnalytics()
      Indicates whether this query will be included in [analytics](https://www.algolia.com/doc/guides/search-analytics/guides/exclude-queries/).

    • setAnalyticsTags

      public ConsequenceParams setAnalyticsTags(List<String> analyticsTags)

    • addAnalyticsTags

      public ConsequenceParams addAnalyticsTags(String analyticsTagsItem)

    • getAnalyticsTags

      @Nullable public List<String> getAnalyticsTags()
      Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).

    • setPercentileComputation

      public ConsequenceParams setPercentileComputation(Boolean percentileComputation)

    • getPercentileComputation

      @Nullable public Boolean getPercentileComputation()
      Whether to include or exclude a query from the processing-time percentile computation.

    • setEnableABTest

      public ConsequenceParams setEnableABTest(Boolean enableABTest)

    • getEnableABTest

      @Nullable public Boolean getEnableABTest()
      Incidates whether this search will be considered in A/B testing.

    • setAttributesForFaceting

      public ConsequenceParams setAttributesForFaceting(List<String> attributesForFaceting)

    • addAttributesForFaceting

      public ConsequenceParams addAttributesForFaceting(String attributesForFacetingItem)

    • getAttributesForFaceting

      @Nullable public List<String> getAttributesForFaceting()
      Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.

    • setAttributesToRetrieve

      public ConsequenceParams setAttributesToRetrieve(List<String> attributesToRetrieve)

    • addAttributesToRetrieve

      public ConsequenceParams addAttributesToRetrieve(String attributesToRetrieveItem)

    • getAttributesToRetrieve

      @Nullable public List<String> getAttributesToRetrieve()
      Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.

    • setRanking

      public ConsequenceParams setRanking(List<String> ranking)

    • addRanking

      public ConsequenceParams addRanking(String rankingItem)

    • getRanking

      @Nullable public List<String> getRanking()
      Determines the order in which Algolia [returns your results](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).

    • setCustomRanking

      public ConsequenceParams setCustomRanking(List<String> customRanking)

    • addCustomRanking

      public ConsequenceParams addCustomRanking(String customRankingItem)

    • getCustomRanking

      @Nullable public List<String> getCustomRanking()
      Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Use the `asc` and `desc` modifiers to specify the ranking order: ascending or descending.

    • setRelevancyStrictness

      public ConsequenceParams setRelevancyStrictness(Integer relevancyStrictness)

    • getRelevancyStrictness

      @Nullable public Integer getRelevancyStrictness()
      Relevancy threshold below which less relevant results aren't included in the results.

    • setAttributesToHighlight

      public ConsequenceParams setAttributesToHighlight(List<String> attributesToHighlight)

    • addAttributesToHighlight

      public ConsequenceParams addAttributesToHighlight(String attributesToHighlightItem)

    • getAttributesToHighlight

      @Nullable public List<String> getAttributesToHighlight()
      Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (`highlightPreTag` and `highlightPostTag`).

    • setAttributesToSnippet

      public ConsequenceParams setAttributesToSnippet(List<String> attributesToSnippet)

    • addAttributesToSnippet

      public ConsequenceParams addAttributesToSnippet(String attributesToSnippetItem)

    • getAttributesToSnippet

      @Nullable public List<String> getAttributesToSnippet()
      Attributes to _snippet_. 'Snippeting' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: `body:20`.

    • setHighlightPreTag

      public ConsequenceParams setHighlightPreTag(String highlightPreTag)

    • getHighlightPreTag

      @Nullable public String getHighlightPreTag()
      HTML string to insert before the highlighted parts in all highlight and snippet results.

    • setHighlightPostTag

      public ConsequenceParams setHighlightPostTag(String highlightPostTag)

    • getHighlightPostTag

      @Nullable public String getHighlightPostTag()
      HTML string to insert after the highlighted parts in all highlight and snippet results.

    • setSnippetEllipsisText

      public ConsequenceParams setSnippetEllipsisText(String snippetEllipsisText)

    • getSnippetEllipsisText

      @Nullable public String getSnippetEllipsisText()
      String used as an ellipsis indicator when a snippet is truncated.

    • setRestrictHighlightAndSnippetArrays

      public ConsequenceParams setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

    • getRestrictHighlightAndSnippetArrays

      @Nullable public Boolean getRestrictHighlightAndSnippetArrays()
      Restrict highlighting and snippeting to items that matched the query.

    • setHitsPerPage

      public ConsequenceParams setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

      @Nullable public Integer getHitsPerPage()
      Number of hits per page. minimum: 1 maximum: 1000

    • setMinWordSizefor1Typo

      public ConsequenceParams setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

    • getMinWordSizefor1Typo

      @Nullable public Integer getMinWordSizefor1Typo()
      Minimum number of characters a word in the query string must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).

    • setMinWordSizefor2Typos

      public ConsequenceParams setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

    • getMinWordSizefor2Typos

      @Nullable public Integer getMinWordSizefor2Typos()
      Minimum number of characters a word in the query string must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).

    • setTypoTolerance

      public ConsequenceParams setTypoTolerance(TypoTolerance typoTolerance)

    • getTypoTolerance

      @Nullable public TypoTolerance getTypoTolerance()
      Get typoTolerance

    • setAllowTyposOnNumericTokens

      public ConsequenceParams setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

    • getAllowTyposOnNumericTokens

      @Nullable public Boolean getAllowTyposOnNumericTokens()
      Whether to allow typos on numbers (\"numeric tokens\") in the query string.

    • setDisableTypoToleranceOnAttributes

      public ConsequenceParams setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

    • addDisableTypoToleranceOnAttributes

      public ConsequenceParams addDisableTypoToleranceOnAttributes(String disableTypoToleranceOnAttributesItem)

    • getDisableTypoToleranceOnAttributes

      @Nullable public List<String> getDisableTypoToleranceOnAttributes()
      Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).

    • setIgnorePlurals

      public ConsequenceParams setIgnorePlurals(IgnorePlurals ignorePlurals)

    • getIgnorePlurals

      @Nullable public IgnorePlurals getIgnorePlurals()
      Get ignorePlurals

    • setRemoveStopWords

      public ConsequenceParams setRemoveStopWords(RemoveStopWords removeStopWords)

    • getRemoveStopWords

      @Nullable public RemoveStopWords getRemoveStopWords()
      Get removeStopWords

    • setKeepDiacriticsOnCharacters

      public ConsequenceParams setKeepDiacriticsOnCharacters(String keepDiacriticsOnCharacters)

    • getKeepDiacriticsOnCharacters

      @Nullable public String getKeepDiacriticsOnCharacters()
      Characters that the engine shouldn't automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).

    • setQueryLanguages

      public ConsequenceParams setQueryLanguages(List<String> queryLanguages)

    • addQueryLanguages

      public ConsequenceParams addQueryLanguages(String queryLanguagesItem)

    • getQueryLanguages

      @Nullable public List<String> getQueryLanguages()
      Sets your user's search language. This adjusts language-specific settings and features such as `ignorePlurals`, `removeStopWords`, and [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) word detection.

    • setDecompoundQuery

      public ConsequenceParams setDecompoundQuery(Boolean decompoundQuery)

    • getDecompoundQuery

      @Nullable public Boolean getDecompoundQuery()
      [Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.

    • setEnableRules

      public ConsequenceParams setEnableRules(Boolean enableRules)

    • getEnableRules

      @Nullable public Boolean getEnableRules()
      Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.

    • setEnablePersonalization

      public ConsequenceParams setEnablePersonalization(Boolean enablePersonalization)

    • getEnablePersonalization

      @Nullable public Boolean getEnablePersonalization()
      Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.

    • setQueryType

      public ConsequenceParams setQueryType(QueryType queryType)

    • getQueryType

      @Nullable public QueryType getQueryType()
      Get queryType

    • setRemoveWordsIfNoResults

      public ConsequenceParams setRemoveWordsIfNoResults(RemoveWordsIfNoResults removeWordsIfNoResults)

    • getRemoveWordsIfNoResults

      @Nullable public RemoveWordsIfNoResults getRemoveWordsIfNoResults()
      Get removeWordsIfNoResults

    • setMode

      public ConsequenceParams setMode(Mode mode)

    • getMode

      @Nullable public Mode getMode()
      Get mode

    • setSemanticSearch

      public ConsequenceParams setSemanticSearch(SemanticSearch semanticSearch)

    • getSemanticSearch

      @Nullable public SemanticSearch getSemanticSearch()
      Get semanticSearch

    • setAdvancedSyntax

      public ConsequenceParams setAdvancedSyntax(Boolean advancedSyntax)

    • getAdvancedSyntax

      @Nullable public Boolean getAdvancedSyntax()
      Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).

    • setOptionalWords

      public ConsequenceParams setOptionalWords(List<String> optionalWords)

    • addOptionalWords

      public ConsequenceParams addOptionalWords(String optionalWordsItem)

    • getOptionalWords

      @Nullable public List<String> getOptionalWords()
      Words which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.

    • setDisableExactOnAttributes

      public ConsequenceParams setDisableExactOnAttributes(List<String> disableExactOnAttributes)

    • addDisableExactOnAttributes

      public ConsequenceParams addDisableExactOnAttributes(String disableExactOnAttributesItem)

    • getDisableExactOnAttributes

      @Nullable public List<String> getDisableExactOnAttributes()
      Attributes for which you want to [turn off the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).

    • setExactOnSingleWordQuery

      public ConsequenceParams setExactOnSingleWordQuery(ExactOnSingleWordQuery exactOnSingleWordQuery)

    • getExactOnSingleWordQuery

      @Nullable public ExactOnSingleWordQuery getExactOnSingleWordQuery()
      Get exactOnSingleWordQuery

    • setAlternativesAsExact

      public ConsequenceParams setAlternativesAsExact(List<AlternativesAsExact> alternativesAsExact)

    • addAlternativesAsExact

      public ConsequenceParams addAlternativesAsExact(AlternativesAsExact alternativesAsExactItem)

    • getAlternativesAsExact

      @Nullable public List<AlternativesAsExact> getAlternativesAsExact()
      Alternatives that should be considered an exact match by [the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).

    • setAdvancedSyntaxFeatures

      public ConsequenceParams setAdvancedSyntaxFeatures(List<AdvancedSyntaxFeatures> advancedSyntaxFeatures)

    • addAdvancedSyntaxFeatures

      public ConsequenceParams addAdvancedSyntaxFeatures(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem)

    • getAdvancedSyntaxFeatures

      @Nullable public List<AdvancedSyntaxFeatures> getAdvancedSyntaxFeatures()
      Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.

    • setDistinct

      public ConsequenceParams setDistinct(Distinct distinct)

    • getDistinct

      @Nullable public Distinct getDistinct()
      Get distinct

    • setReplaceSynonymsInHighlight

      public ConsequenceParams setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

    • getReplaceSynonymsInHighlight

      @Nullable public Boolean getReplaceSynonymsInHighlight()
      Whether to highlight and snippet the original word that matches the synonym or the synonym itself.

    • setMinProximity

      public ConsequenceParams setMinProximity(Integer minProximity)

    • getMinProximity

      @Nullable public Integer getMinProximity()
      Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity). minimum: 1 maximum: 7

    • setResponseFields

      public ConsequenceParams setResponseFields(List<String> responseFields)

    • addResponseFields

      public ConsequenceParams addResponseFields(String responseFieldsItem)

    • getResponseFields

      @Nullable public List<String> getResponseFields()
      Attributes to include in the API response for search and browse queries.

    • setMaxFacetHits

      public ConsequenceParams setMaxFacetHits(Integer maxFacetHits)

    • getMaxFacetHits

      @Nullable public Integer getMaxFacetHits()
      Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). maximum: 100

    • setMaxValuesPerFacet

      public ConsequenceParams setMaxValuesPerFacet(Integer maxValuesPerFacet)

    • getMaxValuesPerFacet

      @Nullable public Integer getMaxValuesPerFacet()
      Maximum number of facet values to return for each facet.

    • setSortFacetValuesBy

      public ConsequenceParams setSortFacetValuesBy(String sortFacetValuesBy)

    • getSortFacetValuesBy

      @Nullable public String getSortFacetValuesBy()
      Controls how facet values are fetched.

    • setAttributeCriteriaComputedByMinProximity

      public ConsequenceParams setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity)

    • getAttributeCriteriaComputedByMinProximity

      @Nullable public Boolean getAttributeCriteriaComputedByMinProximity()
      When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.

    • setRenderingContent

      public ConsequenceParams setRenderingContent(RenderingContent renderingContent)

    • getRenderingContent

      @Nullable public RenderingContent getRenderingContent()
      Get renderingContent

    • setEnableReRanking

      public ConsequenceParams setEnableReRanking(Boolean enableReRanking)

    • getEnableReRanking

      @Nullable public Boolean getEnableReRanking()
      Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).

    • setReRankingApplyFilter

      public ConsequenceParams setReRankingApplyFilter(ReRankingApplyFilter reRankingApplyFilter)

    • getReRankingApplyFilter

      @Nullable public ReRankingApplyFilter getReRankingApplyFilter()
      Get reRankingApplyFilter

    • setQuery

      public ConsequenceParams setQuery(ConsequenceQuery query)

    • getQuery

      @Nullable public ConsequenceQuery getQuery()
      Get query

    • setAutomaticFacetFilters

      public ConsequenceParams setAutomaticFacetFilters(AutomaticFacetFilters automaticFacetFilters)

    • getAutomaticFacetFilters

      @Nullable public AutomaticFacetFilters getAutomaticFacetFilters()
      Get automaticFacetFilters

    • setAutomaticOptionalFacetFilters

      public ConsequenceParams setAutomaticOptionalFacetFilters(AutomaticFacetFilters automaticOptionalFacetFilters)

    • getAutomaticOptionalFacetFilters

      @Nullable public AutomaticFacetFilters getAutomaticOptionalFacetFilters()
      Get automaticOptionalFacetFilters

    • 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