BaseIndexSettings class final

Annotations
  • @JsonSerializable()

Constructors

BaseIndexSettings({List<String>? attributesForFaceting, List<String>? replicas, int? paginationLimitedTo, List<String>? unretrievableAttributes, List<String>? disableTypoToleranceOnWords, List<String>? attributesToTransliterate, List<String>? camelCaseAttributes, Object? decompoundedAttributes, List<SupportedLanguage>? indexLanguages, List<String>? disablePrefixOnAttributes, bool? allowCompressionOfIntegerArray, List<String>? numericAttributesForFiltering, String? separatorsToIndex, List<String>? searchableAttributes, Object? userData, Map<String, Map<String, String>>? customNormalization, String? attributeForDistinct, int? maxFacetHits})
Returns a new BaseIndexSettings instance.
const
BaseIndexSettings.fromJson(Map<String, dynamic> json)
factory

Properties

allowCompressionOfIntegerArray bool?
Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.
final
attributeForDistinct String?
Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine attributeForDistinct with the distinct search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the afterDistinct modifier of the attributesForFaceting setting. This applies faceting after deduplication, which will result in accurate facet counts.
final
attributesForFaceting List<String>?
Attributes used for faceting. Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. Modifiers - filterOnly(\"ATTRIBUTE\"). Allows the attribute to be used as a filter but doesn't evaluate the facet values. - searchable(\"ATTRIBUTE\"). Allows searching for facet values. - afterDistinct(\"ATTRIBUTE\"). Evaluates the facet count after deduplication with distinct. This ensures accurate facet counts. You can apply this modifier to searchable facets: afterDistinct(searchable(ATTRIBUTE)).
final
attributesToTransliterate List<String>?
Attributes, for which you want to support Japanese transliteration. Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
final
camelCaseAttributes List<String>?
Attributes for which to split camel case words. Attribute names are case-sensitive.
final
customNormalization Map<String, Map<String, String>>?
Characters and their normalized replacements. This overrides Algolia's default normalization.
final
decompoundedAttributes Object?
Searchable attributes to which Algolia should apply word segmentation (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, "firefighter". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (nl), German (de), Finnish (fi), Danish (da), Swedish (sv), and Norwegian (no). Decompounding doesn't work for words with non-spacing mark Unicode characters. For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).
final
disablePrefixOnAttributes List<String>?
Searchable attributes for which you want to turn off prefix matching. Attribute names are case-sensitive.
final
disableTypoToleranceOnWords List<String>?
Creates a list of words which require exact matches. This also turns off word splitting and concatenation for the specified words.
final
hashCode int
The hash code for this object.
no setteroverride
indexLanguages List<SupportedLanguage>?
Languages for language-specific processing steps, such as word detection and dictionary settings. You should always specify an indexing language. If you don't specify an indexing language, the search engine uses all supported languages, or the languages you specified with the ignorePlurals or removeStopWords parameters. This can lead to unexpected search results. For more information, see Language-specific configuration.
final
maxFacetHits int?
Maximum number of facet values to return when searching for facet values.
final
numericAttributesForFiltering List<String>?
Numeric attributes that can be used as numerical filters. Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as NO_NUMERIC_FILTERING. Modifier - equalOnly(\"ATTRIBUTE\"). Support only filtering based on equality comparisons = and !=.
final
paginationLimitedTo int?
Maximum number of search results that can be obtained through pagination. Higher pagination limits might slow down your search. For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
final
replicas List<String>?
Creates replica indices. Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you'll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index. Modifier - virtual(\"REPLICA\"). Create a virtual replica, Virtual replicas don't increase the number of records and are optimized for Relevant sorting.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchableAttributes List<String>?
Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the Attribute ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of searchableAttributes rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as \"title,alternate_title\". Attributes with the same priority are always unordered. For more information, see Searchable attributes. Modifier - unordered(\"ATTRIBUTE\"). Ignore the position of a match within the attribute. Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
final
separatorsToIndex String?
Control which non-alphanumeric characters are indexed. By default, Algolia ignores non-alphanumeric characters like hyphen (-), plus (+), and parentheses ((,)). To include such characters, define them with separatorsToIndex. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. With separatorsToIndex, Algolia treats separator characters as separate words. For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words.
final
unretrievableAttributes List<String>?
Attributes that can't be retrieved at query time. This can be useful if you want to use an attribute for ranking or to restrict access, but don't want to include it in the search results. Attribute names are case-sensitive.
final
userData Object?
An object with custom data. You can store up to 32kB as custom data.
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