SearchForHits constructor

const SearchForHits({
  1. String? params,
  2. String? query,
  3. String? similarQuery,
  4. String? filters,
  5. dynamic facetFilters,
  6. dynamic optionalFilters,
  7. dynamic numericFilters,
  8. dynamic tagFilters,
  9. bool? sumOrFiltersScores,
  10. List<String>? restrictSearchableAttributes,
  11. List<String>? facets,
  12. bool? facetingAfterDistinct,
  13. int? page,
  14. int? offset,
  15. int? length,
  16. String? aroundLatLng,
  17. bool? aroundLatLngViaIP,
  18. dynamic aroundRadius,
  19. dynamic aroundPrecision,
  20. int? minimumAroundRadius,
  21. List<List<double>>? insideBoundingBox,
  22. List<List<double>>? insidePolygon,
  23. List<String>? naturalLanguages,
  24. List<String>? ruleContexts,
  25. int? personalizationImpact,
  26. String? userToken,
  27. bool? getRankingInfo,
  28. List<String>? explain,
  29. bool? synonyms,
  30. bool? clickAnalytics,
  31. bool? analytics,
  32. List<String>? analyticsTags,
  33. bool? percentileComputation,
  34. bool? enableABTest,
  35. List<String>? attributesForFaceting,
  36. List<String>? attributesToRetrieve,
  37. List<String>? ranking,
  38. List<String>? customRanking,
  39. int? relevancyStrictness,
  40. List<String>? attributesToHighlight,
  41. List<String>? attributesToSnippet,
  42. String? highlightPreTag,
  43. String? highlightPostTag,
  44. String? snippetEllipsisText,
  45. bool? restrictHighlightAndSnippetArrays,
  46. int? hitsPerPage,
  47. int? minWordSizefor1Typo,
  48. int? minWordSizefor2Typos,
  49. dynamic typoTolerance,
  50. bool? allowTyposOnNumericTokens,
  51. List<String>? disableTypoToleranceOnAttributes,
  52. dynamic ignorePlurals,
  53. dynamic removeStopWords,
  54. String? keepDiacriticsOnCharacters,
  55. List<String>? queryLanguages,
  56. bool? decompoundQuery,
  57. bool? enableRules,
  58. bool? enablePersonalization,
  59. QueryType? queryType,
  60. RemoveWordsIfNoResults? removeWordsIfNoResults,
  61. Mode? mode,
  62. SemanticSearch? semanticSearch,
  63. bool? advancedSyntax,
  64. List<String>? optionalWords,
  65. List<String>? disableExactOnAttributes,
  66. ExactOnSingleWordQuery? exactOnSingleWordQuery,
  67. List<AlternativesAsExact>? alternativesAsExact,
  68. List<AdvancedSyntaxFeatures>? advancedSyntaxFeatures,
  69. dynamic distinct,
  70. bool? replaceSynonymsInHighlight,
  71. int? minProximity,
  72. List<String>? responseFields,
  73. int? maxFacetHits,
  74. int? maxValuesPerFacet,
  75. String? sortFacetValuesBy,
  76. bool? attributeCriteriaComputedByMinProximity,
  77. RenderingContent? renderingContent,
  78. bool? enableReRanking,
  79. dynamic reRankingApplyFilter,
  80. required String indexName,
  81. SearchTypeDefault? type,
})

Returns a new SearchForHits instance.

Implementation

const SearchForHits({
  this.params,
  this.query,
  this.similarQuery,
  this.filters,
  this.facetFilters,
  this.optionalFilters,
  this.numericFilters,
  this.tagFilters,
  this.sumOrFiltersScores,
  this.restrictSearchableAttributes,
  this.facets,
  this.facetingAfterDistinct,
  this.page,
  this.offset,
  this.length,
  this.aroundLatLng,
  this.aroundLatLngViaIP,
  this.aroundRadius,
  this.aroundPrecision,
  this.minimumAroundRadius,
  this.insideBoundingBox,
  this.insidePolygon,
  this.naturalLanguages,
  this.ruleContexts,
  this.personalizationImpact,
  this.userToken,
  this.getRankingInfo,
  this.explain,
  this.synonyms,
  this.clickAnalytics,
  this.analytics,
  this.analyticsTags,
  this.percentileComputation,
  this.enableABTest,
  this.attributesForFaceting,
  this.attributesToRetrieve,
  this.ranking,
  this.customRanking,
  this.relevancyStrictness,
  this.attributesToHighlight,
  this.attributesToSnippet,
  this.highlightPreTag,
  this.highlightPostTag,
  this.snippetEllipsisText,
  this.restrictHighlightAndSnippetArrays,
  this.hitsPerPage,
  this.minWordSizefor1Typo,
  this.minWordSizefor2Typos,
  this.typoTolerance,
  this.allowTyposOnNumericTokens,
  this.disableTypoToleranceOnAttributes,
  this.ignorePlurals,
  this.removeStopWords,
  this.keepDiacriticsOnCharacters,
  this.queryLanguages,
  this.decompoundQuery,
  this.enableRules,
  this.enablePersonalization,
  this.queryType,
  this.removeWordsIfNoResults,
  this.mode,
  this.semanticSearch,
  this.advancedSyntax,
  this.optionalWords,
  this.disableExactOnAttributes,
  this.exactOnSingleWordQuery,
  this.alternativesAsExact,
  this.advancedSyntaxFeatures,
  this.distinct,
  this.replaceSynonymsInHighlight,
  this.minProximity,
  this.responseFields,
  this.maxFacetHits,
  this.maxValuesPerFacet,
  this.sortFacetValuesBy,
  this.attributeCriteriaComputedByMinProximity,
  this.renderingContent,
  this.enableReRanking,
  this.reRankingApplyFilter,
  required this.indexName,
  this.type,
});