Package com.algolia.model.search
Class IndexSettings
java.lang.Object
com.algolia.model.search.IndexSettings
Algolia index settings.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdvancedSyntaxFeatures(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem) addAlternativesAsExact(AlternativesAsExact alternativesAsExactItem) addAttributesForFaceting(String attributesForFacetingItem) addAttributesToHighlight(String attributesToHighlightItem) addAttributesToRetrieve(String attributesToRetrieveItem) addAttributesToSnippet(String attributesToSnippetItem) addAttributesToTransliterate(String attributesToTransliterateItem) addCamelCaseAttributes(String camelCaseAttributesItem) addCustomRanking(String customRankingItem) addDisableExactOnAttributes(String disableExactOnAttributesItem) addDisablePrefixOnAttributes(String disablePrefixOnAttributesItem) addDisableTypoToleranceOnAttributes(String disableTypoToleranceOnAttributesItem) addDisableTypoToleranceOnWords(String disableTypoToleranceOnWordsItem) addIndexLanguages(String indexLanguagesItem) addNumericAttributesForFiltering(String numericAttributesForFilteringItem) addOptionalWords(String optionalWordsItem) addQueryLanguages(String queryLanguagesItem) addRanking(String rankingItem) addReplicas(String replicasItem) addResponseFields(String responseFieldsItem) addSearchableAttributes(String searchableAttributesItem) addUnretrievableAttributes(String unretrievableAttributesItem) booleanEnables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.Incidates whether the engine compresses arrays with exclusively non-negative integers.Whether to allow typos on numbers (\"numeric tokens\") in the query string.Alternatives that should be considered an exact match by [the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.Name of the deduplication attribute to be used with Algolia's [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.Attributes to highlight.Attributes to include in the API response.Attributes to _snippet_.Attributes in your index to which [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead) applies.Attributes on which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.A list of characters and their normalized replacements to override Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).Attributes in your index to which [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding) applies.[Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.Attributes for which you want to [turn off the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).Attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).Get distinctIncidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.Get exactOnSingleWordQueryHTML string to insert after the highlighted parts in all highlight and snippet results.HTML string to insert before the highlighted parts in all highlight and snippet results.Number of hits per page.Get ignorePluralsSet the languages of your index, for language-specific processing steps such as [tokenization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/tokenization/) and [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).Characters that the engine shouldn't automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).Maximum number of facet values to return for each facet.Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).Minimum number of characters a word in the query string must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).Minimum number of characters a word in the query string must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).getMode()Get modeNumeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).Words which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.Maximum number of hits accessible through pagination.Sets your user's search language.Get queryTypeDetermines the order in which Algolia [returns your results](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).Relevancy threshold below which less relevant results aren't included in the results.Get removeStopWordsGet removeWordsIfNoResultsGet renderingContentWhether to highlight and snippet the original word that matches the synonym or the synonym itself.Creates [replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/), which are copies of a primary index with the same records but different settings.Get reRankingApplyFilterAttributes to include in the API response for search and browse queries.Restrict highlighting and snippeting to items that matched the query.[Attributes used for searching](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/), including determining [if matches at the beginning of a word are important (ordered) or not (unordered)](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/how-to/configuring-searchable-attributes-the-right-way/#understanding-word-position).Get semanticSearchControls which separators are added to an Algolia index as part of [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean).String used as an ellipsis indicator when a snippet is truncated.Controls how facet values are fetched.Get typoToleranceAttributes that can't be retrieved at query time.Lets you store custom data in your indices.inthashCode()putCustomNormalization(String key, Map<String, String> customNormalizationItem) setAdvancedSyntax(Boolean advancedSyntax) setAdvancedSyntaxFeatures(List<AdvancedSyntaxFeatures> advancedSyntaxFeatures) setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray) setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens) setAlternativesAsExact(List<AlternativesAsExact> alternativesAsExact) setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity) setAttributeForDistinct(String attributeForDistinct) setAttributesForFaceting(List<String> attributesForFaceting) setAttributesToHighlight(List<String> attributesToHighlight) setAttributesToRetrieve(List<String> attributesToRetrieve) setAttributesToSnippet(List<String> attributesToSnippet) setAttributesToTransliterate(List<String> attributesToTransliterate) setCamelCaseAttributes(List<String> camelCaseAttributes) setCustomRanking(List<String> customRanking) setDecompoundedAttributes(Object decompoundedAttributes) setDecompoundQuery(Boolean decompoundQuery) setDisableExactOnAttributes(List<String> disableExactOnAttributes) setDisablePrefixOnAttributes(List<String> disablePrefixOnAttributes) setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes) setDisableTypoToleranceOnWords(List<String> disableTypoToleranceOnWords) setDistinct(Distinct distinct) setEnablePersonalization(Boolean enablePersonalization) setEnableReRanking(Boolean enableReRanking) setEnableRules(Boolean enableRules) setExactOnSingleWordQuery(ExactOnSingleWordQuery exactOnSingleWordQuery) setHighlightPostTag(String highlightPostTag) setHighlightPreTag(String highlightPreTag) setHitsPerPage(Integer hitsPerPage) setIgnorePlurals(IgnorePlurals ignorePlurals) setIndexLanguages(List<String> indexLanguages) setKeepDiacriticsOnCharacters(String keepDiacriticsOnCharacters) setMaxFacetHits(Integer maxFacetHits) setMaxValuesPerFacet(Integer maxValuesPerFacet) setMinProximity(Integer minProximity) setMinWordSizefor1Typo(Integer minWordSizefor1Typo) setMinWordSizefor2Typos(Integer minWordSizefor2Typos) setNumericAttributesForFiltering(List<String> numericAttributesForFiltering) setOptionalWords(List<String> optionalWords) setPaginationLimitedTo(Integer paginationLimitedTo) setQueryLanguages(List<String> queryLanguages) setQueryType(QueryType queryType) setRanking(List<String> ranking) setRelevancyStrictness(Integer relevancyStrictness) setRemoveStopWords(RemoveStopWords removeStopWords) setRemoveWordsIfNoResults(RemoveWordsIfNoResults removeWordsIfNoResults) setRenderingContent(RenderingContent renderingContent) setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight) setReplicas(List<String> replicas) setReRankingApplyFilter(ReRankingApplyFilter reRankingApplyFilter) setResponseFields(List<String> responseFields) setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays) setSearchableAttributes(List<String> searchableAttributes) setSemanticSearch(SemanticSearch semanticSearch) setSeparatorsToIndex(String separatorsToIndex) setSnippetEllipsisText(String snippetEllipsisText) setSortFacetValuesBy(String sortFacetValuesBy) setTypoTolerance(TypoTolerance typoTolerance) setUnretrievableAttributes(List<String> unretrievableAttributes) setUserData(Object userData) toString()
-
Constructor Details
-
IndexSettings
public IndexSettings()
-
-
Method Details
-
setReplicas
-
addReplicas
-
getReplicas
Creates [replicas](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/), which are copies of a primary index with the same records but different settings.- Returns:
- replicas
-
setPaginationLimitedTo
-
getPaginationLimitedTo
Maximum number of hits accessible through pagination.- Returns:
- paginationLimitedTo
-
setUnretrievableAttributes
-
addUnretrievableAttributes
-
getUnretrievableAttributes
Attributes that can't be retrieved at query time.- Returns:
- unretrievableAttributes
-
setDisableTypoToleranceOnWords
-
addDisableTypoToleranceOnWords
-
getDisableTypoToleranceOnWords
Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).- Returns:
- disableTypoToleranceOnWords
-
setAttributesToTransliterate
-
addAttributesToTransliterate
-
getAttributesToTransliterate
Attributes in your index to which [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead) applies. This will ensure that words indexed in Katakana or Kanji can also be searched in Hiragana.- Returns:
- attributesToTransliterate
-
setCamelCaseAttributes
-
addCamelCaseAttributes
-
getCamelCaseAttributes
Attributes on which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.- Returns:
- camelCaseAttributes
-
setDecompoundedAttributes
-
getDecompoundedAttributes
Attributes in your index to which [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding) applies.- Returns:
- decompoundedAttributes
-
setIndexLanguages
-
addIndexLanguages
-
getIndexLanguages
Set the languages of your index, for language-specific processing steps such as [tokenization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/tokenization/) and [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).- Returns:
- indexLanguages
-
setDisablePrefixOnAttributes
-
addDisablePrefixOnAttributes
-
getDisablePrefixOnAttributes
Attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).- Returns:
- disablePrefixOnAttributes
-
setAllowCompressionOfIntegerArray
-
getAllowCompressionOfIntegerArray
Incidates whether the engine compresses arrays with exclusively non-negative integers. When enabled, the compressed arrays may be reordered.- Returns:
- allowCompressionOfIntegerArray
-
setNumericAttributesForFiltering
-
addNumericAttributesForFiltering
-
getNumericAttributesForFiltering
Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).- Returns:
- numericAttributesForFiltering
-
setSeparatorsToIndex
-
getSeparatorsToIndex
Controls which separators are added to an Algolia index as part of [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean). Separators are all non-letter characters except spaces and currency characters, such as $€£¥.- Returns:
- separatorsToIndex
-
setSearchableAttributes
-
addSearchableAttributes
-
getSearchableAttributes
[Attributes used for searching](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/), including determining [if matches at the beginning of a word are important (ordered) or not (unordered)](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/how-to/configuring-searchable-attributes-the-right-way/#understanding-word-position).- Returns:
- searchableAttributes
-
setUserData
-
getUserData
Lets you store custom data in your indices.- Returns:
- userData
-
setCustomNormalization
-
putCustomNormalization
-
getCustomNormalization
A list of characters and their normalized replacements to override Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).- Returns:
- customNormalization
-
setAttributesForFaceting
-
addAttributesForFaceting
-
getAttributesForFaceting
Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.- Returns:
- attributesForFaceting
-
setAttributesToRetrieve
-
addAttributesToRetrieve
-
getAttributesToRetrieve
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.- Returns:
- attributesToRetrieve
-
setRanking
-
addRanking
-
getRanking
Determines the order in which Algolia [returns your results](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).- Returns:
- ranking
-
setCustomRanking
-
addCustomRanking
-
getCustomRanking
Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Use the `asc` and `desc` modifiers to specify the ranking order: ascending or descending.- Returns:
- customRanking
-
setRelevancyStrictness
-
getRelevancyStrictness
Relevancy threshold below which less relevant results aren't included in the results.- Returns:
- relevancyStrictness
-
setAttributesToHighlight
-
addAttributesToHighlight
-
getAttributesToHighlight
Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (`highlightPreTag` and `highlightPostTag`).- Returns:
- attributesToHighlight
-
setAttributesToSnippet
-
addAttributesToSnippet
-
getAttributesToSnippet
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`.- Returns:
- attributesToSnippet
-
setHighlightPreTag
-
getHighlightPreTag
HTML string to insert before the highlighted parts in all highlight and snippet results.- Returns:
- highlightPreTag
-
setHighlightPostTag
-
getHighlightPostTag
HTML string to insert after the highlighted parts in all highlight and snippet results.- Returns:
- highlightPostTag
-
setSnippetEllipsisText
-
getSnippetEllipsisText
String used as an ellipsis indicator when a snippet is truncated.- Returns:
- snippetEllipsisText
-
setRestrictHighlightAndSnippetArrays
public IndexSettings setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays) -
getRestrictHighlightAndSnippetArrays
Restrict highlighting and snippeting to items that matched the query.- Returns:
- restrictHighlightAndSnippetArrays
-
setHitsPerPage
-
getHitsPerPage
Number of hits per page. minimum: 1 maximum: 1000- Returns:
- hitsPerPage
-
setMinWordSizefor1Typo
-
getMinWordSizefor1Typo
Minimum number of characters a word in the query string must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).- Returns:
- minWordSizefor1Typo
-
setMinWordSizefor2Typos
-
getMinWordSizefor2Typos
Minimum number of characters a word in the query string must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).- Returns:
- minWordSizefor2Typos
-
setTypoTolerance
-
getTypoTolerance
Get typoTolerance- Returns:
- typoTolerance
-
setAllowTyposOnNumericTokens
-
getAllowTyposOnNumericTokens
Whether to allow typos on numbers (\"numeric tokens\") in the query string.- Returns:
- allowTyposOnNumericTokens
-
setDisableTypoToleranceOnAttributes
public IndexSettings setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes) -
addDisableTypoToleranceOnAttributes
public IndexSettings addDisableTypoToleranceOnAttributes(String disableTypoToleranceOnAttributesItem) -
getDisableTypoToleranceOnAttributes
Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).- Returns:
- disableTypoToleranceOnAttributes
-
setIgnorePlurals
-
getIgnorePlurals
Get ignorePlurals- Returns:
- ignorePlurals
-
setRemoveStopWords
-
getRemoveStopWords
Get removeStopWords- Returns:
- removeStopWords
-
setKeepDiacriticsOnCharacters
-
getKeepDiacriticsOnCharacters
Characters that the engine shouldn't automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).- Returns:
- keepDiacriticsOnCharacters
-
setQueryLanguages
-
addQueryLanguages
-
getQueryLanguages
Sets your user's search language. This adjusts language-specific settings and features such as `ignorePlurals`, `removeStopWords`, and [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) word detection.- Returns:
- queryLanguages
-
setDecompoundQuery
-
getDecompoundQuery
[Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.- Returns:
- decompoundQuery
-
setEnableRules
-
getEnableRules
Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.- Returns:
- enableRules
-
setEnablePersonalization
-
getEnablePersonalization
Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.- Returns:
- enablePersonalization
-
setQueryType
-
getQueryType
Get queryType- Returns:
- queryType
-
setRemoveWordsIfNoResults
-
getRemoveWordsIfNoResults
Get removeWordsIfNoResults- Returns:
- removeWordsIfNoResults
-
setMode
-
getMode
Get mode- Returns:
- mode
-
setSemanticSearch
-
getSemanticSearch
Get semanticSearch- Returns:
- semanticSearch
-
setAdvancedSyntax
-
getAdvancedSyntax
Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).- Returns:
- advancedSyntax
-
setOptionalWords
-
addOptionalWords
-
getOptionalWords
Words which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.- Returns:
- optionalWords
-
setDisableExactOnAttributes
-
addDisableExactOnAttributes
-
getDisableExactOnAttributes
Attributes for which you want to [turn off the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).- Returns:
- disableExactOnAttributes
-
setExactOnSingleWordQuery
-
getExactOnSingleWordQuery
Get exactOnSingleWordQuery- Returns:
- exactOnSingleWordQuery
-
setAlternativesAsExact
-
addAlternativesAsExact
-
getAlternativesAsExact
Alternatives that should be considered an exact match by [the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).- Returns:
- alternativesAsExact
-
setAdvancedSyntaxFeatures
-
addAdvancedSyntaxFeatures
-
getAdvancedSyntaxFeatures
Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.- Returns:
- advancedSyntaxFeatures
-
setDistinct
-
getDistinct
Get distinct- Returns:
- distinct
-
setAttributeForDistinct
-
getAttributeForDistinct
Name of the deduplication attribute to be used with Algolia's [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).- Returns:
- attributeForDistinct
-
setReplaceSynonymsInHighlight
-
getReplaceSynonymsInHighlight
Whether to highlight and snippet the original word that matches the synonym or the synonym itself.- Returns:
- replaceSynonymsInHighlight
-
setMinProximity
-
getMinProximity
Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity). minimum: 1 maximum: 7- Returns:
- minProximity
-
setResponseFields
-
addResponseFields
-
getResponseFields
Attributes to include in the API response for search and browse queries.- Returns:
- responseFields
-
setMaxFacetHits
-
getMaxFacetHits
Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). maximum: 100- Returns:
- maxFacetHits
-
setMaxValuesPerFacet
-
getMaxValuesPerFacet
Maximum number of facet values to return for each facet.- Returns:
- maxValuesPerFacet
-
setSortFacetValuesBy
-
getSortFacetValuesBy
Controls how facet values are fetched.- Returns:
- sortFacetValuesBy
-
setAttributeCriteriaComputedByMinProximity
public IndexSettings setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity) -
getAttributeCriteriaComputedByMinProximity
When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.- Returns:
- attributeCriteriaComputedByMinProximity
-
setRenderingContent
-
getRenderingContent
Get renderingContent- Returns:
- renderingContent
-
setEnableReRanking
-
getEnableReRanking
Indicates whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).- Returns:
- enableReRanking
-
setReRankingApplyFilter
-
getReRankingApplyFilter
Get reRankingApplyFilter- Returns:
- reRankingApplyFilter
-
equals
-
hashCode
public int hashCode() -
toString
-