Package com.algolia.model.recommend

Class BaseSearchParamsWithoutQuery

java.lang.Object
com.algolia.model.recommend.BaseSearchParamsWithoutQuery
public class BaseSearchParamsWithoutQuery extends Object
BaseSearchParamsWithoutQuery

  • Constructor Details

    • BaseSearchParamsWithoutQuery

      public BaseSearchParamsWithoutQuery()

  • Method Details

    • setSimilarQuery

      public BaseSearchParamsWithoutQuery setSimilarQuery(String similarQuery)

    • getSimilarQuery

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

    • setFilters

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setFacetFilters(FacetFilters facetFilters)

    • getFacetFilters

      @Nullable public FacetFilters getFacetFilters()
      Get facetFilters

    • setOptionalFilters

      public BaseSearchParamsWithoutQuery setOptionalFilters(OptionalFilters optionalFilters)

    • getOptionalFilters

      @Nullable public OptionalFilters getOptionalFilters()
      Get optionalFilters

    • setNumericFilters

      public BaseSearchParamsWithoutQuery setNumericFilters(NumericFilters numericFilters)

    • getNumericFilters

      @Nullable public NumericFilters getNumericFilters()
      Get numericFilters

    • setTagFilters

      public BaseSearchParamsWithoutQuery setTagFilters(TagFilters tagFilters)

    • getTagFilters

      @Nullable public TagFilters getTagFilters()
      Get tagFilters

    • setSumOrFiltersScores

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setRestrictSearchableAttributes(List<String> restrictSearchableAttributes)

    • addRestrictSearchableAttributes

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setFacets(List<String> facets)

    • addFacets

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setPage(Integer page)

    • getPage

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

    • setOffset

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setAroundRadius(AroundRadius aroundRadius)

    • getAroundRadius

      @Nullable public AroundRadius getAroundRadius()
      Get aroundRadius

    • setAroundPrecision

      public BaseSearchParamsWithoutQuery setAroundPrecision(AroundPrecision aroundPrecision)

    • getAroundPrecision

      @Nullable public AroundPrecision getAroundPrecision()
      Get aroundPrecision

    • setMinimumAroundRadius

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setInsideBoundingBox(List<List<Double>> insideBoundingBox)

    • addInsideBoundingBox

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setInsidePolygon(List<List<Double>> insidePolygon)

    • addInsidePolygon

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setNaturalLanguages(List<String> naturalLanguages)

    • addNaturalLanguages

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setRuleContexts(List<String> ruleContexts)

    • addRuleContexts

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setExplain(List<String> explain)

    • addExplain

      public BaseSearchParamsWithoutQuery addExplain(String explainItem)

    • getExplain

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

    • setSynonyms

      public BaseSearchParamsWithoutQuery setSynonyms(Boolean synonyms)

    • getSynonyms

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

    • setClickAnalytics

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setAnalyticsTags(List<String> analyticsTags)

    • addAnalyticsTags

      public BaseSearchParamsWithoutQuery 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 BaseSearchParamsWithoutQuery setPercentileComputation(Boolean percentileComputation)

    • getPercentileComputation

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

    • setEnableABTest

      public BaseSearchParamsWithoutQuery setEnableABTest(Boolean enableABTest)

    • getEnableABTest

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

    • 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