SearchParamsObject class final

Annotations
  • @JsonSerializable()

Constructors

SearchParamsObject({String? query, String? similarQuery, String? filters, dynamic facetFilters, dynamic optionalFilters, dynamic numericFilters, dynamic tagFilters, bool? sumOrFiltersScores, 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, List<String>? attributesForFaceting, List<String>? attributesToRetrieve, List<String>? ranking, List<String>? customRanking, int? relevancyStrictness, List<String>? attributesToHighlight, List<String>? attributesToSnippet, String? highlightPreTag, String? highlightPostTag, String? snippetEllipsisText, bool? restrictHighlightAndSnippetArrays, int? hitsPerPage, int? minWordSizefor1Typo, int? minWordSizefor2Typos, dynamic typoTolerance, bool? allowTyposOnNumericTokens, List<String>? disableTypoToleranceOnAttributes, dynamic ignorePlurals, dynamic removeStopWords, String? keepDiacriticsOnCharacters, List<String>? queryLanguages, bool? decompoundQuery, bool? enableRules, bool? enablePersonalization, QueryType? queryType, RemoveWordsIfNoResults? removeWordsIfNoResults, Mode? mode, SemanticSearch? semanticSearch, bool? advancedSyntax, List<String>? optionalWords, List<String>? disableExactOnAttributes, ExactOnSingleWordQuery? exactOnSingleWordQuery, List<AlternativesAsExact>? alternativesAsExact, List<AdvancedSyntaxFeatures>? advancedSyntaxFeatures, dynamic distinct, bool? replaceSynonymsInHighlight, int? minProximity, List<String>? responseFields, int? maxFacetHits, int? maxValuesPerFacet, String? sortFacetValuesBy, bool? attributeCriteriaComputedByMinProximity, RenderingContent? renderingContent, bool? enableReRanking, dynamic reRankingApplyFilter})
Returns a new SearchParamsObject instance.
const
SearchParamsObject.fromJson(Map<String, dynamic> json)
factory

Properties

advancedSyntax → bool?
Enables the advanced query syntax.
final
advancedSyntaxFeatures → List<AdvancedSyntaxFeatures>?
Allows you to specify which advanced syntax features are active when advancedSyntax is enabled.
final
allowTyposOnNumericTokens → bool?
Whether to allow typos on numbers ("numeric tokens") in the query string.
final
alternativesAsExact → List<AlternativesAsExact>?
Alternatives that should be considered an exact match by the exact ranking criterion.
final
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
attributeCriteriaComputedByMinProximity → bool?
When the Attribute criterion is ranked above Proximity in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
final
attributesForFaceting → List<String>?
Attributes used for faceting and the modifiers that can be applied: filterOnly, searchable, and afterDistinct.
final
attributesToHighlight → List<String>?
Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (highlightPreTag and highlightPostTag).
final
attributesToRetrieve → List<String>?
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.
final
attributesToSnippet → List<String>?
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.
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
customRanking → List<String>?
Specifies the Custom ranking criterion. Use the asc and desc modifiers to specify the ranking order: ascending or descending.
final
decompoundQuery → bool?
Splits compound words into their component word parts in the query.
final
disableExactOnAttributes → List<String>?
Attributes for which you want to turn off the exact ranking criterion.
final
disableTypoToleranceOnAttributes → List<String>?
Attributes for which you want to turn off typo tolerance.
final
distinct → dynamic
One of types:
final
enableABTest → bool?
Incidates whether this search will be considered in A/B testing.
final
enablePersonalization → bool?
Incidates whether Personalization is enabled.
final
enableReRanking → bool?
Indicates whether this search will use Dynamic Re-Ranking.
final
enableRules → bool?
Incidates whether Rules are enabled.
final
exactOnSingleWordQuery → ExactOnSingleWordQuery?
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 setteroverride
highlightPostTag → String?
HTML string to insert after the highlighted parts in all highlight and snippet results.
final
highlightPreTag → String?
HTML string to insert before the highlighted parts in all highlight and snippet results.
final
hitsPerPage → int?
Number of hits per page.
final
ignorePlurals → dynamic
One of types:
final
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
keepDiacriticsOnCharacters → String?
Characters that the engine shouldn't automatically normalize.
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
maxFacetHits → int?
Maximum number of facet hits to return when searching for facet values.
final
maxValuesPerFacet → int?
Maximum number of facet values to return for each facet.
final
minimumAroundRadius → int?
Minimum radius (in meters) used for a geographical search when aroundRadius isn't set.
final
minProximity → int?
Precision of the proximity ranking criterion.
final
minWordSizefor1Typo → int?
Minimum number of characters a word in the query string must contain to accept matches with one typo.
final
minWordSizefor2Typos → int?
Minimum number of characters a word in the query string must contain to accept matches with two typos.
final
mode → Mode?
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
optionalWords → List<String>?
Words which should be considered optional when found in a query.
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
queryLanguages → List<String>?
Sets your user's search language. This adjusts language-specific settings and features such as ignorePlurals, removeStopWords, and CJK word detection.
final
queryType → QueryType?
final
ranking → List<String>?
Determines the order in which Algolia returns your results.
final
relevancyStrictness → int?
Relevancy threshold below which less relevant results aren't included in the results.
final
removeStopWords → dynamic
One of types:
final
removeWordsIfNoResults → RemoveWordsIfNoResults?
final
renderingContent → RenderingContent?
final
replaceSynonymsInHighlight → bool?
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
final
reRankingApplyFilter → dynamic
One of types:
final
responseFields → List<String>?
Attributes to include in the API response for search and browse queries.
final
restrictHighlightAndSnippetArrays → bool?
Restrict highlighting and snippeting to items that matched the query.
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 setterinherited
semanticSearch → SemanticSearch?
final
similarQuery → String?
Overrides the query parameter and performs a more generic search.
final
snippetEllipsisText → String?
String used as an ellipsis indicator when a snippet is truncated.
final
sortFacetValuesBy → String?
Controls how facet values are fetched.
final
sumOrFiltersScores → bool?
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
typoTolerance → dynamic
One of types:
final
userToken → String?
Associates a user token with the current search.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override