Package com.algolia.model.search

Class BrowseParamsObject

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

  • Constructor Details

    • BrowseParamsObject

      public BrowseParamsObject()

  • Method Details

    • setQuery

      public BrowseParamsObject setQuery(String query)

    • getQuery

      @Nullable public String getQuery()
      Text to search for in an index.
      Returns:
      query

    • setSimilarQuery

      public BrowseParamsObject setSimilarQuery(String similarQuery)

    • getSimilarQuery

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

    • setFilters

      public BrowseParamsObject 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.
      Returns:
      filters

    • setFacetFilters

      public BrowseParamsObject setFacetFilters(FacetFilters facetFilters)

    • getFacetFilters

      @Nullable public FacetFilters getFacetFilters()
      Get facetFilters
      Returns:
      facetFilters

    • setOptionalFilters

      public BrowseParamsObject setOptionalFilters(OptionalFilters optionalFilters)

    • getOptionalFilters

      @Nullable public OptionalFilters getOptionalFilters()
      Get optionalFilters
      Returns:
      optionalFilters

    • setNumericFilters

      public BrowseParamsObject setNumericFilters(NumericFilters numericFilters)

    • getNumericFilters

      @Nullable public NumericFilters getNumericFilters()
      Get numericFilters
      Returns:
      numericFilters

    • setTagFilters

      public BrowseParamsObject setTagFilters(TagFilters tagFilters)

    • getTagFilters

      @Nullable public TagFilters getTagFilters()
      Get tagFilters
      Returns:
      tagFilters

    • setSumOrFiltersScores

      public BrowseParamsObject 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.
      Returns:
      sumOrFiltersScores

    • setRestrictSearchableAttributes

      public BrowseParamsObject setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

    • addRestrictSearchableAttributes

      public BrowseParamsObject 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/).
      Returns:
      restrictSearchableAttributes

    • setFacets

      public BrowseParamsObject setFacets(List<String> facets)

    • addFacets

      public BrowseParamsObject 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.
      Returns:
      facets

    • setFacetingAfterDistinct

      public BrowseParamsObject 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.
      Returns:
      facetingAfterDistinct

    • setPage

      public BrowseParamsObject setPage(Integer page)

    • getPage

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

    • setOffset

      public BrowseParamsObject 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).
      Returns:
      offset

    • setLength

      public BrowseParamsObject 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
      Returns:
      length

    • setAroundLatLng

      public BrowseParamsObject 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.
      Returns:
      aroundLatLng

    • setAroundLatLngViaIP

      public BrowseParamsObject 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.
      Returns:
      aroundLatLngViaIP

    • setAroundRadius

      public BrowseParamsObject setAroundRadius(AroundRadius aroundRadius)

    • getAroundRadius

      @Nullable public AroundRadius getAroundRadius()
      Get aroundRadius
      Returns:
      aroundRadius

    • setAroundPrecision

      public BrowseParamsObject setAroundPrecision(AroundPrecision aroundPrecision)

    • getAroundPrecision

      @Nullable public AroundPrecision getAroundPrecision()
      Get aroundPrecision
      Returns:
      aroundPrecision

    • setMinimumAroundRadius

      public BrowseParamsObject setMinimumAroundRadius(Integer minimumAroundRadius)

    • getMinimumAroundRadius

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

    • setInsideBoundingBox

      public BrowseParamsObject setInsideBoundingBox(List<Double> insideBoundingBox)

    • addInsideBoundingBox

      public BrowseParamsObject addInsideBoundingBox(Double insideBoundingBoxItem)

    • getInsideBoundingBox

      @Nullable public 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).
      Returns:
      insideBoundingBox

    • setInsidePolygon

      public BrowseParamsObject setInsidePolygon(List<Double> insidePolygon)

    • addInsidePolygon

      public BrowseParamsObject addInsidePolygon(Double insidePolygonItem)

    • getInsidePolygon

      @Nullable public 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).
      Returns:
      insidePolygon

    • setNaturalLanguages

      public BrowseParamsObject setNaturalLanguages(List<String> naturalLanguages)

    • addNaturalLanguages

      public BrowseParamsObject 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.
      Returns:
      naturalLanguages

    • setRuleContexts

      public BrowseParamsObject setRuleContexts(List<String> ruleContexts)

    • addRuleContexts

      public BrowseParamsObject 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.
      Returns:
      ruleContexts

    • setPersonalizationImpact

      public BrowseParamsObject 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).
      Returns:
      personalizationImpact

    • setUserToken

      public BrowseParamsObject 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.
      Returns:
      userToken

    • setGetRankingInfo

      public BrowseParamsObject 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).
      Returns:
      getRankingInfo

    • setExplain

      public BrowseParamsObject setExplain(List<String> explain)

    • addExplain

      public BrowseParamsObject addExplain(String explainItem)

    • getExplain

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

    • setSynonyms

      public BrowseParamsObject setSynonyms(Boolean synonyms)

    • getSynonyms

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

    • setClickAnalytics

      public BrowseParamsObject 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).
      Returns:
      clickAnalytics

    • setAnalytics

      public BrowseParamsObject 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/).
      Returns:
      analytics

    • setAnalyticsTags

      public BrowseParamsObject setAnalyticsTags(List<String> analyticsTags)

    • addAnalyticsTags

      public BrowseParamsObject 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/).
      Returns:
      analyticsTags

    • setPercentileComputation

      public BrowseParamsObject setPercentileComputation(Boolean percentileComputation)

    • getPercentileComputation

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

    • setEnableABTest

      public BrowseParamsObject setEnableABTest(Boolean enableABTest)

    • getEnableABTest

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

    • setAttributesForFaceting

      public BrowseParamsObject setAttributesForFaceting(List<String> attributesForFaceting)

    • addAttributesForFaceting

      public BrowseParamsObject 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`.
      Returns:
      attributesForFaceting

    • setAttributesToRetrieve

      public BrowseParamsObject setAttributesToRetrieve(List<String> attributesToRetrieve)

    • addAttributesToRetrieve

      public BrowseParamsObject 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.
      Returns:
      attributesToRetrieve

    • setRanking

      public BrowseParamsObject setRanking(List<String> ranking)

    • addRanking

      public BrowseParamsObject 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/).
      Returns:
      ranking

    • setCustomRanking

      public BrowseParamsObject setCustomRanking(List<String> customRanking)

    • addCustomRanking

      public BrowseParamsObject 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.
      Returns:
      customRanking

    • setRelevancyStrictness

      public BrowseParamsObject setRelevancyStrictness(Integer relevancyStrictness)

    • getRelevancyStrictness

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

    • setAttributesToHighlight

      public BrowseParamsObject setAttributesToHighlight(List<String> attributesToHighlight)

    • addAttributesToHighlight

      public BrowseParamsObject 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`).
      Returns:
      attributesToHighlight

    • setAttributesToSnippet

      public BrowseParamsObject setAttributesToSnippet(List<String> attributesToSnippet)

    • addAttributesToSnippet

      public BrowseParamsObject 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`.
      Returns:
      attributesToSnippet

    • setHighlightPreTag

      public BrowseParamsObject setHighlightPreTag(String highlightPreTag)

    • getHighlightPreTag

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

    • setHighlightPostTag

      public BrowseParamsObject setHighlightPostTag(String highlightPostTag)

    • getHighlightPostTag

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

    • setSnippetEllipsisText

      public BrowseParamsObject setSnippetEllipsisText(String snippetEllipsisText)

    • getSnippetEllipsisText

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

    • setRestrictHighlightAndSnippetArrays

      public BrowseParamsObject setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

    • getRestrictHighlightAndSnippetArrays

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

    • setHitsPerPage

      public BrowseParamsObject setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

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

    • setMinWordSizefor1Typo

      public BrowseParamsObject 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).
      Returns:
      minWordSizefor1Typo

    • setMinWordSizefor2Typos

      public BrowseParamsObject 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).
      Returns:
      minWordSizefor2Typos

    • setTypoTolerance

      public BrowseParamsObject setTypoTolerance(TypoTolerance typoTolerance)

    • getTypoTolerance

      @Nullable public TypoTolerance getTypoTolerance()
      Get typoTolerance
      Returns:
      typoTolerance

    • setAllowTyposOnNumericTokens

      public BrowseParamsObject setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

    • getAllowTyposOnNumericTokens

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

    • setDisableTypoToleranceOnAttributes

      public BrowseParamsObject setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

    • addDisableTypoToleranceOnAttributes

      public BrowseParamsObject 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/).
      Returns:
      disableTypoToleranceOnAttributes

    • setIgnorePlurals

      public BrowseParamsObject setIgnorePlurals(IgnorePlurals ignorePlurals)

    • getIgnorePlurals

      @Nullable public IgnorePlurals getIgnorePlurals()
      Get ignorePlurals
      Returns:
      ignorePlurals

    • setRemoveStopWords

      public BrowseParamsObject setRemoveStopWords(RemoveStopWords removeStopWords)

    • getRemoveStopWords

      @Nullable public RemoveStopWords getRemoveStopWords()
      Get removeStopWords
      Returns:
      removeStopWords

    • setKeepDiacriticsOnCharacters

      public BrowseParamsObject 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/).
      Returns:
      keepDiacriticsOnCharacters

    • setQueryLanguages

      public BrowseParamsObject setQueryLanguages(List<String> queryLanguages)

    • addQueryLanguages

      public BrowseParamsObject 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.
      Returns:
      queryLanguages

    • setDecompoundQuery

      public BrowseParamsObject 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.
      Returns:
      decompoundQuery

    • setEnableRules

      public BrowseParamsObject setEnableRules(Boolean enableRules)

    • getEnableRules

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

    • setEnablePersonalization

      public BrowseParamsObject setEnablePersonalization(Boolean enablePersonalization)

    • getEnablePersonalization

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

    • setQueryType

      public BrowseParamsObject setQueryType(QueryType queryType)

    • getQueryType

      @Nullable public QueryType getQueryType()
      Get queryType
      Returns:
      queryType

    • setRemoveWordsIfNoResults

      public BrowseParamsObject setRemoveWordsIfNoResults(RemoveWordsIfNoResults removeWordsIfNoResults)

    • getRemoveWordsIfNoResults

      @Nullable public RemoveWordsIfNoResults getRemoveWordsIfNoResults()
      Get removeWordsIfNoResults
      Returns:
      removeWordsIfNoResults

    • setMode

      public BrowseParamsObject setMode(Mode mode)

    • getMode

      @Nullable public Mode getMode()
      Get mode
      Returns:
      mode

    • setSemanticSearch

      public BrowseParamsObject setSemanticSearch(SemanticSearch semanticSearch)

    • getSemanticSearch

      @Nullable public SemanticSearch getSemanticSearch()
      Get semanticSearch
      Returns:
      semanticSearch

    • setAdvancedSyntax

      public BrowseParamsObject 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).
      Returns:
      advancedSyntax

    • setOptionalWords

      public BrowseParamsObject setOptionalWords(List<String> optionalWords)

    • addOptionalWords

      public BrowseParamsObject 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.
      Returns:
      optionalWords

    • setDisableExactOnAttributes

      public BrowseParamsObject setDisableExactOnAttributes(List<String> disableExactOnAttributes)

    • addDisableExactOnAttributes

      public BrowseParamsObject 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).
      Returns:
      disableExactOnAttributes

    • setExactOnSingleWordQuery

      public BrowseParamsObject setExactOnSingleWordQuery(ExactOnSingleWordQuery exactOnSingleWordQuery)

    • getExactOnSingleWordQuery

      @Nullable public ExactOnSingleWordQuery getExactOnSingleWordQuery()
      Get exactOnSingleWordQuery
      Returns:
      exactOnSingleWordQuery

    • setAlternativesAsExact

      public BrowseParamsObject setAlternativesAsExact(List<AlternativesAsExact> alternativesAsExact)

    • addAlternativesAsExact

      public BrowseParamsObject 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).
      Returns:
      alternativesAsExact

    • setAdvancedSyntaxFeatures

      public BrowseParamsObject setAdvancedSyntaxFeatures(List<AdvancedSyntaxFeatures> advancedSyntaxFeatures)

    • addAdvancedSyntaxFeatures

      public BrowseParamsObject addAdvancedSyntaxFeatures(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem)

    • getAdvancedSyntaxFeatures

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

    • setDistinct

      public BrowseParamsObject setDistinct(Distinct distinct)

    • getDistinct

      @Nullable public Distinct getDistinct()
      Get distinct
      Returns:
      distinct

    • setAttributeForDistinct

      public BrowseParamsObject setAttributeForDistinct(String attributeForDistinct)

    • getAttributeForDistinct

      @Nullable public String getAttributeForDistinct()
      Name of the deduplication attribute to be used with Algolia's [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
      Returns:
      attributeForDistinct

    • setReplaceSynonymsInHighlight

      public BrowseParamsObject setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

    • getReplaceSynonymsInHighlight

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

    • setMinProximity

      public BrowseParamsObject 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
      Returns:
      minProximity

    • setResponseFields

      public BrowseParamsObject setResponseFields(List<String> responseFields)

    • addResponseFields

      public BrowseParamsObject addResponseFields(String responseFieldsItem)

    • getResponseFields

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

    • setMaxFacetHits

      public BrowseParamsObject 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
      Returns:
      maxFacetHits

    • setMaxValuesPerFacet

      public BrowseParamsObject setMaxValuesPerFacet(Integer maxValuesPerFacet)

    • getMaxValuesPerFacet

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

    • setSortFacetValuesBy

      public BrowseParamsObject setSortFacetValuesBy(String sortFacetValuesBy)

    • getSortFacetValuesBy

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

    • setAttributeCriteriaComputedByMinProximity

      public BrowseParamsObject 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.
      Returns:
      attributeCriteriaComputedByMinProximity

    • setRenderingContent

      public BrowseParamsObject setRenderingContent(RenderingContent renderingContent)

    • getRenderingContent

      @Nullable public RenderingContent getRenderingContent()
      Get renderingContent
      Returns:
      renderingContent

    • setEnableReRanking

      public BrowseParamsObject 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/).
      Returns:
      enableReRanking

    • setReRankingApplyFilter

      public BrowseParamsObject setReRankingApplyFilter(ReRankingApplyFilter reRankingApplyFilter)

    • getReRankingApplyFilter

      @Nullable public ReRankingApplyFilter getReRankingApplyFilter()
      Get reRankingApplyFilter
      Returns:
      reRankingApplyFilter

    • setCursor

      public BrowseParamsObject setCursor(String cursor)

    • getCursor

      @Nullable public String getCursor()
      Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, `cursor` is absent from the response.
      Returns:
      cursor

    • 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