BaseSearchParams class
final
Constructors
BaseSearchParams ({String ?query , String ?similarQuery , String ?filters , dynamic facetFilters , dynamic optionalFilters , dynamic numericFilters , dynamic tagFilters , List <String ?restrictSearchableAttributes , List <String ?facets , bool ?facetingAfterDistinct , int ?page , int ?offset , int ?length , String ?aroundLatLng , bool ?aroundLatLngViaIP , dynamic aroundRadius , dynamic aroundPrecision , int ?minimumAroundRadius , List <List <double ?insideBoundingBox , List <List <double ?insidePolygon , List <String ?naturalLanguages , List <String ?ruleContexts , int ?personalizationImpact , String ?userToken , bool ?getRankingInfo , List <String ?explain , bool ?synonyms , bool ?clickAnalytics , bool ?analytics , List <String ?analyticsTags , bool ?percentileComputation , bool ?enableABTest
Returns a new BaseSearchParams instance.
const
BaseSearchParams.fromJson (Map <String dynamic > json
factory
Properties
analytics → bool ?
Indicates whether this query will be included in analytics .
final
analyticsTags → List <String ?
Tags to apply to the query for segmenting analytics data .
final
aroundLatLng → String ?
Search for entries around a central location , enabling a geographical search within a circular area.
final
aroundLatLngViaIP → bool ?
Search for entries around a location. The location is automatically computed from the requester's IP address.
final
aroundPrecision → dynamic
One of types:
final
aroundRadius → dynamic
One of types:
final
clickAnalytics → bool ?
Indicates whether a query ID parameter is included in the search response. This is required for tracking click and conversion events .
final
enableABTest → bool ?
Incidates whether this search will be considered in A/B testing.
final
explain → List <String ?
Enriches the API's response with information about how the query was processed.
final
facetFilters → dynamic
One of types:
final
facetingAfterDistinct → bool ?
Forces faceting to be applied after de-duplication (with the distinct feature). Alternatively, the afterDistinct modifier of attributesForFaceting allows for more granular control.
final
facets → List <String ?
Returns facets , their facet values, and the number of matching facet values.
final
filters → String ?
Filter the query with numeric, facet, or tag filters.
final
getRankingInfo → bool ?
Incidates whether the search response includes detailed ranking information .
final
hashCode → int
The hash code for this object.
no setter override
insideBoundingBox → List <List <double ?
Search inside a rectangular area (in geographical coordinates).
final
insidePolygon → List <List <double ?
Search inside a polygon (in geographical coordinates).
final
length → int ?
Sets the number of hits to retrieve (for use with offset). > Note : Using page and hitsPerPage is the recommended method for paging results . However, you can use offset and length to implement an alternative approach to paging .
final
minimumAroundRadius → int ?
Minimum radius (in meters) used for a geographical search when aroundRadius isn't set.
final
naturalLanguages → List <String ?
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.
final
numericFilters → dynamic
One of types:
final
offset → int ?
Specifies the offset of the first hit to return. > Note : Using page and hitsPerPage is the recommended method for paging results . However, you can use offset and length to implement an alternative approach to paging .
final
optionalFilters → dynamic
One of types:
final
page → int ?
Page to retrieve (the first page is 0, not 1).
final
percentileComputation → bool ?
Whether to include or exclude a query from the processing-time percentile computation.
final
personalizationImpact → int ?
Defines how much Personalization affects results .
final
query → String ?
Text to search for in an index.
final
restrictSearchableAttributes → List <String ?
Restricts a query to only look at a subset of your searchable attributes .
final
ruleContexts → List <String ?
Assigns rule contexts to search queries.
final
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
similarQuery → String ?
Overrides the query parameter and performs a more generic search.
final
Determines how to calculate filter scores . If false, maximum score is kept. If true, score is summed.
final
synonyms → bool ?
Whether to take into account an index's synonyms for a particular search.
final
tagFilters → dynamic
One of types:
final
userToken → String ?
Associates a user token with the current search.
final
