SearchForFacets constructor
const
SearchForFacets({
- String? params,
- 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,
- dynamic insideBoundingBox,
- List<
List< ? insidePolygon,double> > - List<
SupportedLanguage> ? naturalLanguages, - List<
String> ? ruleContexts, - int? personalizationImpact,
- String? userToken,
- bool? getRankingInfo,
- bool? synonyms,
- bool? clickAnalytics,
- bool? analytics,
- List<
String> ? analyticsTags, - bool? percentileComputation,
- bool? enableABTest,
- 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<
SupportedLanguage> ? queryLanguages, - bool? decompoundQuery,
- bool? enableRules,
- bool? enablePersonalization,
- QueryType? queryType,
- RemoveWordsIfNoResults? removeWordsIfNoResults,
- Mode? mode,
- SemanticSearch? semanticSearch,
- bool? advancedSyntax,
- dynamic optionalWords,
- List<
String> ? disableExactOnAttributes, - ExactOnSingleWordQuery? exactOnSingleWordQuery,
- List<
AlternativesAsExact> ? alternativesAsExact, - List<
AdvancedSyntaxFeatures> ? advancedSyntaxFeatures, - dynamic distinct,
- bool? replaceSynonymsInHighlight,
- int? minProximity,
- List<
String> ? responseFields, - int? maxValuesPerFacet,
- String? sortFacetValuesBy,
- bool? attributeCriteriaComputedByMinProximity,
- RenderingContent? renderingContent,
- bool? enableReRanking,
- dynamic reRankingApplyFilter,
- required String facet,
- required String indexName,
- String? facetQuery,
- int? maxFacetHits,
- required SearchTypeFacet type,
Returns a new SearchForFacets instance.
Implementation
const SearchForFacets({
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.synonyms,
this.clickAnalytics,
this.analytics,
this.analyticsTags,
this.percentileComputation,
this.enableABTest,
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.maxValuesPerFacet,
this.sortFacetValuesBy,
this.attributeCriteriaComputedByMinProximity,
this.renderingContent,
this.enableReRanking,
this.reRankingApplyFilter,
required this.facet,
required this.indexName,
this.facetQuery,
this.maxFacetHits,
required this.type,
});