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()
      Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.

    • setFilters

      public ConsequenceParams setFilters(String filters)

    • getFilters

      @Nullable public String getFilters()
      Filter the search so that only records with matching values are included in the results. These filters are supported: - **Numeric filters.** ` `, where `` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `: TO ` where `` and `` are the lower and upper limits of the range (inclusive). - **Facet filters.** `:` where `` is a facet attribute (case-sensitive) and `` a facet value. - **Tag filters.** `_tags:` or just `` (case-sensitive). - **Boolean filters.** `: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).

    • 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()
      Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).

    • setRestrictSearchableAttributes

      public ConsequenceParams setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

    • addRestrictSearchableAttributes

      public ConsequenceParams addRestrictSearchableAttributes(String restrictSearchableAttributesItem)

    • getRestrictSearchableAttributes

      @Nullable public List<String> getRestrictSearchableAttributes()
      Restricts a search to a subset of your searchable attributes.

    • setFacets

      public ConsequenceParams setFacets(List<String> facets)

    • addFacets

      public ConsequenceParams addFacets(String facetsItem)

    • getFacets

      @Nullable public List<String> getFacets()
      Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).

    • setFacetingAfterDistinct

      public ConsequenceParams setFacetingAfterDistinct(Boolean facetingAfterDistinct)

    • getFacetingAfterDistinct

      @Nullable public Boolean getFacetingAfterDistinct()
      Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.

    • setPage

      public ConsequenceParams setPage(Integer page)

    • getPage

      @Nullable public Integer getPage()
      Page of search results to retrieve. minimum: 0

    • setOffset

      public ConsequenceParams setOffset(Integer offset)

    • getOffset

      @Nullable public Integer getOffset()
      Position of the first hit to retrieve.

    • setLength

      public ConsequenceParams setLength(Integer length)

    • getLength

      @Nullable public Integer getLength()
      Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000

    • setAroundLatLng

      public ConsequenceParams setAroundLatLng(String aroundLatLng)

    • getAroundLatLng

      @Nullable public String getAroundLatLng()
      Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.

    • setAroundLatLngViaIP

      public ConsequenceParams setAroundLatLngViaIP(Boolean aroundLatLngViaIP)

    • getAroundLatLngViaIP

      @Nullable public Boolean getAroundLatLngViaIP()
      Whether to obtain the coordinates from the request'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) for a search around a location 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()
      Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).

    • setInsidePolygon

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

    • addInsidePolygon

      public ConsequenceParams addInsidePolygon(List<Double> insidePolygonItem)

    • getInsidePolygon

      @Nullable public List<List<Double>> getInsidePolygon()
      Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored, if you also specify `insideBoundingBox`.

    • setNaturalLanguages

      public ConsequenceParams setNaturalLanguages(List<String> naturalLanguages)

    • addNaturalLanguages

      public ConsequenceParams addNaturalLanguages(String naturalLanguagesItem)

    • getNaturalLanguages

      @Nullable public List<String> getNaturalLanguages()
      ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.

    • setRuleContexts

      public ConsequenceParams setRuleContexts(List<String> ruleContexts)

    • addRuleContexts

      public ConsequenceParams addRuleContexts(String ruleContextsItem)

    • getRuleContexts

      @Nullable public List<String> getRuleContexts()
      Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.

    • setPersonalizationImpact

      public ConsequenceParams setPersonalizationImpact(Integer personalizationImpact)

    • getPersonalizationImpact

      @Nullable public Integer getPersonalizationImpact()
      Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact). minimum: 0 maximum: 100

    • setUserToken

      public ConsequenceParams setUserToken(String userToken)

    • getUserToken

      @Nullable public String getUserToken()
      Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).

    • setGetRankingInfo

      public ConsequenceParams setGetRankingInfo(Boolean getRankingInfo)

    • getGetRankingInfo

      @Nullable public Boolean getGetRankingInfo()
      Whether the search response should include detailed ranking information.

    • setSynonyms

      public ConsequenceParams setSynonyms(Boolean synonyms)

    • getSynonyms

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

    • setClickAnalytics

      public ConsequenceParams setClickAnalytics(Boolean clickAnalytics)

    • getClickAnalytics

      @Nullable public Boolean getClickAnalytics()
      Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).

    • setAnalytics

      public ConsequenceParams setAnalytics(Boolean analytics)

    • getAnalytics

      @Nullable public Boolean getAnalytics()
      Whether this search will be included in Analytics.

    • 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 this search when calculating processing-time percentiles.

    • setEnableABTest

      public ConsequenceParams setEnableABTest(Boolean enableABTest)

    • getEnableABTest

      @Nullable public Boolean getEnableABTest()
      Whether to enable A/B testing for this search.

    • 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. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.

    • 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. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers**
      asc(\"ATTRIBUTE\")
      Sort the index by the values of an attribute, in ascending order.
      desc(\"ATTRIBUTE\")
      Sort the index by the values of an attribute, in descending order.
      Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).

    • setCustomRanking

      public ConsequenceParams setCustomRanking(List<String> customRanking)

    • addCustomRanking

      public ConsequenceParams addCustomRanking(String customRankingItem)

    • getCustomRanking

      @Nullable public List<String> getCustomRanking()
      Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers**
      asc(\"ATTRIBUTE\")
      Sort the index by the values of an attribute, in ascending order.
      desc(\"ATTRIBUTE\")
      Sort the index by the values of an attribute, in descending order.
      If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.

    • setRelevancyStrictness

      public ConsequenceParams setRelevancyStrictness(Integer relevancyStrictness)

    • getRelevancyStrictness

      @Nullable public Integer getRelevancyStrictness()
      Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.

    • setAttributesToHighlight

      public ConsequenceParams setAttributesToHighlight(List<String> attributesToHighlight)

    • addAttributesToHighlight

      public ConsequenceParams addAttributesToHighlight(String attributesToHighlightItem)

    • getAttributesToHighlight

      @Nullable public List<String> getAttributesToHighlight()
      Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).

    • setAttributesToSnippet

      public ConsequenceParams setAttributesToSnippet(List<String> attributesToSnippet)

    • addAttributesToSnippet

      public ConsequenceParams addAttributesToSnippet(String attributesToSnippetItem)

    • getAttributesToSnippet

      @Nullable public List<String> getAttributesToSnippet()
      Attributes for which to enable snippets. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.

    • setHighlightPreTag

      public ConsequenceParams setHighlightPreTag(String highlightPreTag)

    • getHighlightPreTag

      @Nullable public String getHighlightPreTag()
      HTML tag to insert before the highlighted parts in all highlighted results and snippets.

    • setHighlightPostTag

      public ConsequenceParams setHighlightPostTag(String highlightPostTag)

    • getHighlightPostTag

      @Nullable public String getHighlightPostTag()
      HTML tag to insert after the highlighted parts in all highlighted results and snippets.

    • 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()
      Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.

    • 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 search query 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 search query 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 in the search query. Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.

    • 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/). Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.

    • 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 for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.

    • setQueryLanguages

      public ConsequenceParams setQueryLanguages(List<String> queryLanguages)

    • addQueryLanguages

      public ConsequenceParams addQueryLanguages(String queryLanguagesItem)

    • getQueryLanguages

      @Nullable public List<String> getQueryLanguages()
      [ISO code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for language-specific settings such as plurals, stop words, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).

    • setDecompoundQuery

      public ConsequenceParams setDecompoundQuery(Boolean decompoundQuery)

    • getDecompoundQuery

      @Nullable public Boolean getDecompoundQuery()
      Whether to split compound words into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.

    • setEnableRules

      public ConsequenceParams setEnableRules(Boolean enableRules)

    • getEnableRules

      @Nullable public Boolean getEnableRules()
      Whether to enable rules.

    • setEnablePersonalization

      public ConsequenceParams setEnablePersonalization(Boolean enablePersonalization)

    • getEnablePersonalization

      @Nullable public Boolean getEnablePersonalization()
      Whether to enable Personalization.

    • 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()
      Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported.

    • setOptionalWords

      public ConsequenceParams setOptionalWords(List<String> optionalWords)

    • addOptionalWords

      public ConsequenceParams addOptionalWords(String optionalWordsItem)

    • getOptionalWords

      @Nullable public List<String> getOptionalWords()
      Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).

    • setDisableExactOnAttributes

      public ConsequenceParams setDisableExactOnAttributes(List<String> disableExactOnAttributes)

    • addDisableExactOnAttributes

      public ConsequenceParams addDisableExactOnAttributes(String disableExactOnAttributesItem)

    • getDisableExactOnAttributes

      @Nullable public List<String> getDisableExactOnAttributes()
      Searchable 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). This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.

    • 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 of query words that should be considered as exact matches by the Exact ranking criterion.
      ignorePlurals
      Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.
      singleWordSynonym
      Single-word synonyms, such as \"NY/NYC\" are considered exact matches.
      multiWordsSynonym
      Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
      .

    • setAdvancedSyntaxFeatures

      public ConsequenceParams setAdvancedSyntaxFeatures(List<AdvancedSyntaxFeatures> advancedSyntaxFeatures)

    • addAdvancedSyntaxFeatures

      public ConsequenceParams addAdvancedSyntaxFeatures(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem)

    • getAdvancedSyntaxFeatures

      @Nullable public List<AdvancedSyntaxFeatures> getAdvancedSyntaxFeatures()
      Advanced search syntax features you want to support.
      exactPhrase
      Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".
      excludeWords
      Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\".
      This setting only has an effect if `advancedSyntax` is true.

    • 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 replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response.

    • setMinProximity

      public ConsequenceParams setMinProximity(Integer minProximity)

    • getMinProximity

      @Nullable public Integer getMinProximity()
      Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. minimum: 1 maximum: 7

    • setResponseFields

      public ConsequenceParams setResponseFields(List<String> responseFields)

    • addResponseFields

      public ConsequenceParams addResponseFields(String responseFieldsItem)

    • getResponseFields

      @Nullable public List<String> getResponseFields()
      Properties to include in the API response of `search` and `browse` requests. By default, all response properties are included. To reduce the response size, you can select, which attributes should be included. You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your search UI.

    • setMaxFacetHits

      public ConsequenceParams setMaxFacetHits(Integer maxFacetHits)

    • getMaxFacetHits

      @Nullable public Integer getMaxFacetHits()
      Maximum number of facet values 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. maximum: 1000

    • setSortFacetValuesBy

      public ConsequenceParams setSortFacetValuesBy(String sortFacetValuesBy)

    • getSortFacetValuesBy

      @Nullable public String getSortFacetValuesBy()
      Order in which to retrieve facet values.
      count
      Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value.
      alpha
      Retrieve facet values alphabetically.
      This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).

    • setAttributeCriteriaComputedByMinProximity

      public ConsequenceParams setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity)

    • getAttributeCriteriaComputedByMinProximity

      @Nullable public Boolean getAttributeCriteriaComputedByMinProximity()
      Whether the best matching attribute should be determined by minimum proximity. This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.

    • setRenderingContent

      public ConsequenceParams setRenderingContent(RenderingContent renderingContent)

    • getRenderingContent

      @Nullable public RenderingContent getRenderingContent()
      Get renderingContent

    • setEnableReRanking

      public ConsequenceParams setEnableReRanking(Boolean enableReRanking)

    • getEnableReRanking

      @Nullable public Boolean getEnableReRanking()
      Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

    • 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