Package com.algolia.model.search
Class BaseSearchParamsWithoutQuery
java.lang.Object
com.algolia.model.search.BaseSearchParamsWithoutQuery
BaseSearchParamsWithoutQuery
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAnalyticsTags
(String analyticsTagsItem) addInsideBoundingBox
(List<Double> insideBoundingBoxItem) addInsidePolygon
(List<Double> insidePolygonItem) addNaturalLanguages
(SupportedLanguage naturalLanguagesItem) addRestrictSearchableAttributes
(String restrictSearchableAttributesItem) addRuleContexts
(String ruleContextsItem) boolean
Whether this search will be included in Analytics.Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.Whether to obtain the coordinates from the request's IP address.Get aroundPrecisionGet aroundRadiusWhether to include a `queryID` attribute in the response.Whether to enable A/B testing for this search.Get facetFiltersWhether faceting should be applied after deduplication with `distinct`.Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.Filter expression to only include items that match the filter criteria in the response.Whether the search response should include detailed ranking information.Coordinates for a rectangular area in which to search.Coordinates of a polygon in which to search.Number of hits to retrieve (used in combination with `offset`).Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.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.Get numericFiltersPosition of the first hit to retrieve.Get optionalFiltersgetPage()
Page of search results to retrieve.Whether to include this search when calculating processing-time percentiles.Impact that Personalization should have on this search.Restricts a search to a subset of your searchable attributes.Assigns a rule context to the search query.Keywords to be used instead of the search query to conduct a more broader search.Whether to sum all filter scores.Whether to take into account an index's synonyms for this search.Get tagFiltersUnique pseudonymous or anonymous user identifier.int
hashCode()
setAnalytics
(Boolean analytics) setAnalyticsTags
(List<String> analyticsTags) setAroundLatLng
(String aroundLatLng) setAroundLatLngViaIP
(Boolean aroundLatLngViaIP) setAroundPrecision
(AroundPrecision aroundPrecision) setAroundRadius
(AroundRadius aroundRadius) setClickAnalytics
(Boolean clickAnalytics) setEnableABTest
(Boolean enableABTest) setFacetFilters
(FacetFilters facetFilters) setFacetingAfterDistinct
(Boolean facetingAfterDistinct) setFilters
(String filters) setGetRankingInfo
(Boolean getRankingInfo) setInsideBoundingBox
(List<List<Double>> insideBoundingBox) setInsidePolygon
(List<List<Double>> insidePolygon) setMinimumAroundRadius
(Integer minimumAroundRadius) setNaturalLanguages
(List<SupportedLanguage> naturalLanguages) setNumericFilters
(NumericFilters numericFilters) setOptionalFilters
(OptionalFilters optionalFilters) setPercentileComputation
(Boolean percentileComputation) setPersonalizationImpact
(Integer personalizationImpact) setRestrictSearchableAttributes
(List<String> restrictSearchableAttributes) setRuleContexts
(List<String> ruleContexts) setSimilarQuery
(String similarQuery) setSumOrFiltersScores
(Boolean sumOrFiltersScores) setSynonyms
(Boolean synonyms) setTagFilters
(TagFilters tagFilters) setUserToken
(String userToken) toString()
-
Constructor Details
-
BaseSearchParamsWithoutQuery
public BaseSearchParamsWithoutQuery()
-
-
Method Details
-
setSimilarQuery
-
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
-
getFilters
Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **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
-
getFacetFilters
Get facetFilters -
setOptionalFilters
-
getOptionalFilters
Get optionalFilters -
setNumericFilters
-
getNumericFilters
Get numericFilters -
setTagFilters
-
getTagFilters
Get tagFilters -
setSumOrFiltersScores
-
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 BaseSearchParamsWithoutQuery setRestrictSearchableAttributes(List<String> restrictSearchableAttributes) -
addRestrictSearchableAttributes
public BaseSearchParamsWithoutQuery addRestrictSearchableAttributes(String restrictSearchableAttributesItem) -
getRestrictSearchableAttributes
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive. -
setFacets
-
addFacets
-
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
-
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
-
getPage
Page of search results to retrieve. minimum: 0 -
setOffset
-
getOffset
Position of the first hit to retrieve. -
setLength
-
getLength
Number of hits to retrieve (used in combination with `offset`). minimum: 1 maximum: 1000 -
setAroundLatLng
-
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
-
getAroundLatLngViaIP
Whether to obtain the coordinates from the request's IP address. -
setAroundRadius
-
getAroundRadius
Get aroundRadius -
setAroundPrecision
-
getAroundPrecision
Get aroundPrecision -
setMinimumAroundRadius
-
getMinimumAroundRadius
Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set. minimum: 1 -
setInsideBoundingBox
-
addInsideBoundingBox
-
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
-
addInsidePolygon
-
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
-
addNaturalLanguages
-
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
-
addRuleContexts
-
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
-
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
-
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
-
getGetRankingInfo
Whether the search response should include detailed ranking information. -
setSynonyms
-
getSynonyms
Whether to take into account an index's synonyms for this search. -
setClickAnalytics
-
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
-
getAnalytics
Whether this search will be included in Analytics. -
setAnalyticsTags
-
addAnalyticsTags
-
getAnalyticsTags
Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). -
setPercentileComputation
-
getPercentileComputation
Whether to include this search when calculating processing-time percentiles. -
setEnableABTest
-
getEnableABTest
Whether to enable A/B testing for this search. -
equals
-
hashCode
public int hashCode() -
toString
-