IndexSettings class
final
Constructors
IndexSettings ({List <String > ? replicas , List <String > ? unretrievableAttributes , List <String > ? disableTypoToleranceOnWords , List <String > ? attributesToTransliterate , List <String > ? camelCaseAttributes , Object ? decompoundedAttributes , List <String > ? indexLanguages , List <String > ? disablePrefixOnAttributes , bool ? allowCompressionOfIntegerArray , List <String > ? numericAttributesForFiltering , String ? separatorsToIndex , List <String > ? searchableAttributes , Object ? userData , Map <String , Map <String , String > > ? customNormalization , String ? attributeForDistinct , 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 IndexSettings instance.
const
IndexSettings.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
allowCompressionOfIntegerArray
→ bool ?
Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.
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
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
attributeForDistinct
→ String ?
Name of the deduplication attribute to be used with Algolia's distinct feature .
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
attributesToTransliterate
→ List <String > ?
Attributes in your index to which Japanese transliteration applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.
final
camelCaseAttributes
→ List <String > ?
Attributes on which to split camel case words.
final
customNormalization
→ Map <String , Map <String , String > > ?
A list of characters and their normalized replacements to override Algolia's default normalization .
final
customRanking
→ List <String > ?
Specifies the Custom ranking criterion . Use the asc
and desc
modifiers to specify the ranking order: ascending or descending.
final
decompoundedAttributes
→ Object ?
Attributes in your index to which word segmentation (decompounding) applies.
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
disablePrefixOnAttributes
→ List <String > ?
Attributes for which you want to turn off prefix matching .
final
disableTypoToleranceOnAttributes
→ List <String > ?
Attributes for which you want to turn off typo tolerance .
final
disableTypoToleranceOnWords
→ List <String > ?
Words for which you want to turn off typo tolerance .
final
distinct
→ dynamic
One of types:
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
hashCode
→ int
The hash code for this object.
no setter override
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
indexLanguages
→ List <String > ?
Set the languages of your index, for language-specific processing steps such as tokenization and normalization .
final
keepDiacriticsOnCharacters
→ String ?
Characters that the engine shouldn't automatically normalize .
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
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
numericAttributesForFiltering
→ List <String > ?
Numeric attributes that can be used as numerical filters .
final
optionalWords
→ List <String > ?
Words which should be considered optional when found in a query.
final
Maximum number of hits accessible through pagination.
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
replicas
→ List <String > ?
Creates replicas , which are copies of a primary index with the same records but different settings.
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
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
searchableAttributes
→ List <String > ?
Attributes used for searching , including determining if matches at the beginning of a word are important (ordered) or not (unordered) .
final
semanticSearch
→ SemanticSearch ?
final
separatorsToIndex
→ String ?
Controls which separators are added to an Algolia index as part of normalization . Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
final
snippetEllipsisText
→ String ?
String used as an ellipsis indicator when a snippet is truncated.
final
sortFacetValuesBy
→ String ?
Controls how facet values are fetched.
final
typoTolerance
→ dynamic
One of types:
final
unretrievableAttributes
→ List <String > ?
Attributes that can't be retrieved at query time.
final
userData
→ Object ?
Lets you store custom data in your indices.
final