Package com.algolia.model.search

Class SettingsResponse

java.lang.Object
com.algolia.model.search.SettingsResponse
public class SettingsResponse extends Object
SettingsResponse

  • Constructor Details

    • SettingsResponse

      public SettingsResponse()

  • Method Details

    • setAttributesForFaceting

      public SettingsResponse setAttributesForFaceting(List<String> attributesForFaceting)

    • addAttributesForFaceting

      public SettingsResponse addAttributesForFaceting(String attributesForFacetingItem)

    • getAttributesForFaceting

      @Nullable public List<String> getAttributesForFaceting()
      Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/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 using this attribute as a filter, but doesn't evalue 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))`.

    • setReplicas

      public SettingsResponse setReplicas(List<String> replicas)

    • addReplicas

      public SettingsResponse addReplicas(String replicasItem)

    • getReplicas

      @Nullable public List<String> getReplicas()
      Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). 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 by 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](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).

    • setPaginationLimitedTo

      public SettingsResponse setPaginationLimitedTo(Integer paginationLimitedTo)

    • getPaginationLimitedTo

      @Nullable public Integer getPaginationLimitedTo()
      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. maximum: 20000

    • setUnretrievableAttributes

      public SettingsResponse setUnretrievableAttributes(List<String> unretrievableAttributes)

    • addUnretrievableAttributes

      public SettingsResponse addUnretrievableAttributes(String unretrievableAttributesItem)

    • getUnretrievableAttributes

      @Nullable public List<String> getUnretrievableAttributes()
      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](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. Attribute names are case-sensitive.

    • setDisableTypoToleranceOnWords

      public SettingsResponse setDisableTypoToleranceOnWords(List<String> disableTypoToleranceOnWords)

    • addDisableTypoToleranceOnWords

      public SettingsResponse addDisableTypoToleranceOnWords(String disableTypoToleranceOnWordsItem)

    • getDisableTypoToleranceOnWords

      @Nullable public List<String> getDisableTypoToleranceOnWords()
      Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.

    • setAttributesToTransliterate

      public SettingsResponse setAttributesToTransliterate(List<String> attributesToTransliterate)

    • addAttributesToTransliterate

      public SettingsResponse addAttributesToTransliterate(String attributesToTransliterateItem)

    • getAttributesToTransliterate

      @Nullable public List<String> getAttributesToTransliterate()
      Attributes, for which you want to support [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). 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.

    • setCamelCaseAttributes

      public SettingsResponse setCamelCaseAttributes(List<String> camelCaseAttributes)

    • addCamelCaseAttributes

      public SettingsResponse addCamelCaseAttributes(String camelCaseAttributesItem)

    • getCamelCaseAttributes

      @Nullable public List<String> getCamelCaseAttributes()
      Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.

    • setDecompoundedAttributes

      public SettingsResponse setDecompoundedAttributes(Object decompoundedAttributes)

    • getDecompoundedAttributes

      @Nullable public Object getDecompoundedAttributes()
      Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-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](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).

    • setIndexLanguages

      public SettingsResponse setIndexLanguages(List<SupportedLanguage> indexLanguages)

    • addIndexLanguages

      public SettingsResponse addIndexLanguages(SupportedLanguage indexLanguagesItem)

    • getIndexLanguages

      @Nullable public List<SupportedLanguage> getIndexLanguages()
      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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).

    • setDisablePrefixOnAttributes

      public SettingsResponse setDisablePrefixOnAttributes(List<String> disablePrefixOnAttributes)

    • addDisablePrefixOnAttributes

      public SettingsResponse addDisablePrefixOnAttributes(String disablePrefixOnAttributesItem)

    • getDisablePrefixOnAttributes

      @Nullable public List<String> getDisablePrefixOnAttributes()
      Searchable 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). Attribute names are case-sensitive.

    • setAllowCompressionOfIntegerArray

      public SettingsResponse setAllowCompressionOfIntegerArray(Boolean allowCompressionOfIntegerArray)

    • getAllowCompressionOfIntegerArray

      @Nullable public Boolean getAllowCompressionOfIntegerArray()
      Whether arrays with exclusively non-negative integers should be compressed for better performance. If true, the compressed arrays may be reordered.

    • setNumericAttributesForFiltering

      public SettingsResponse setNumericAttributesForFiltering(List<String> numericAttributesForFiltering)

    • addNumericAttributesForFiltering

      public SettingsResponse addNumericAttributesForFiltering(String numericAttributesForFilteringItem)

    • getNumericAttributesForFiltering

      @Nullable public List<String> 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). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy 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 `!=`.

    • setSeparatorsToIndex

      public SettingsResponse setSeparatorsToIndex(String separatorsToIndex)

    • getSeparatorsToIndex

      @Nullable public String getSeparatorsToIndex()
      Controls which separators are indexed. Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.

    • setSearchableAttributes

      public SettingsResponse setSearchableAttributes(List<String> searchableAttributes)

    • addSearchableAttributes

      public SettingsResponse addSearchableAttributes(String searchableAttributesItem)

    • getSearchableAttributes

      @Nullable public List<String> getSearchableAttributes()
      Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#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](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end.

    • setUserData

      public SettingsResponse setUserData(Object userData)

    • getUserData

      @Nullable public Object getUserData()
      An object with custom data. You can store up to 32kB as custom data.

    • setCustomNormalization

      public SettingsResponse setCustomNormalization(Map<String,Map<String,String>> customNormalization)

    • putCustomNormalization

      public SettingsResponse putCustomNormalization(String key, Map<String,String> customNormalizationItem)

    • getCustomNormalization

      @Nullable public Map<String,Map<String,String>> getCustomNormalization()
      Characters and their normalized replacements. This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).

    • setAttributeForDistinct

      public SettingsResponse setAttributeForDistinct(String attributeForDistinct)

    • getAttributeForDistinct

      @Nullable public String getAttributeForDistinct()
      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.

    • setAttributesToRetrieve

      public SettingsResponse setAttributesToRetrieve(List<String> attributesToRetrieve)

    • addAttributesToRetrieve

      public SettingsResponse addAttributesToRetrieve(String attributesToRetrieveItem)

    • getAttributesToRetrieve

      @Nullable public List<String> getAttributesToRetrieve()
      Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.

    • setRanking

      public SettingsResponse setRanking(List<String> ranking)

    • addRanking

      public SettingsResponse addRanking(String rankingItem)

    • getRanking

      @Nullable public List<String> getRanking()
      Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).

    • setCustomRanking

      public SettingsResponse setCustomRanking(List<String> customRanking)

    • addCustomRanking

      public SettingsResponse addCustomRanking(String customRankingItem)

    • getCustomRanking

      @Nullable public List<String> getCustomRanking()
      Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.

    • setRelevancyStrictness

      public SettingsResponse setRelevancyStrictness(Integer relevancyStrictness)

    • getRelevancyStrictness

      @Nullable public Integer getRelevancyStrictness()
      Relevancy threshold below which less relevant results aren't included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.

    • setAttributesToHighlight

      public SettingsResponse setAttributesToHighlight(List<String> attributesToHighlight)

    • addAttributesToHighlight

      public SettingsResponse addAttributesToHighlight(String attributesToHighlightItem)

    • getAttributesToHighlight

      @Nullable public List<String> getAttributesToHighlight()
      Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).

    • setAttributesToSnippet

      public SettingsResponse setAttributesToSnippet(List<String> attributesToSnippet)

    • addAttributesToSnippet

      public SettingsResponse addAttributesToSnippet(String attributesToSnippetItem)

    • getAttributesToSnippet

      @Nullable public List<String> getAttributesToSnippet()
      Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.

    • setHighlightPreTag

      public SettingsResponse setHighlightPreTag(String highlightPreTag)

    • getHighlightPreTag

      @Nullable public String getHighlightPreTag()
      HTML tag to insert before the highlighted parts in all highlighted results and snippets.

    • setHighlightPostTag

      public SettingsResponse setHighlightPostTag(String highlightPostTag)

    • getHighlightPostTag

      @Nullable public String getHighlightPostTag()
      HTML tag to insert after the highlighted parts in all highlighted results and snippets.

    • setSnippetEllipsisText

      public SettingsResponse setSnippetEllipsisText(String snippetEllipsisText)

    • getSnippetEllipsisText

      @Nullable public String getSnippetEllipsisText()
      String used as an ellipsis indicator when a snippet is truncated.

    • setRestrictHighlightAndSnippetArrays

      public SettingsResponse setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays)

    • getRestrictHighlightAndSnippetArrays

      @Nullable public Boolean getRestrictHighlightAndSnippetArrays()
      Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.

    • setHitsPerPage

      public SettingsResponse setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

      @Nullable public Integer getHitsPerPage()
      Number of hits per page. minimum: 1 maximum: 1000

    • setMinWordSizefor1Typo

      public SettingsResponse setMinWordSizefor1Typo(Integer minWordSizefor1Typo)

    • getMinWordSizefor1Typo

      @Nullable public Integer getMinWordSizefor1Typo()
      Minimum number of characters a word in the search query 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).

    • setMinWordSizefor2Typos

      public SettingsResponse setMinWordSizefor2Typos(Integer minWordSizefor2Typos)

    • getMinWordSizefor2Typos

      @Nullable public Integer getMinWordSizefor2Typos()
      Minimum number of characters a word in the search query 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).

    • setTypoTolerance

      public SettingsResponse setTypoTolerance(TypoTolerance typoTolerance)

    • getTypoTolerance

      @Nullable public TypoTolerance getTypoTolerance()
      Get typoTolerance

    • setAllowTyposOnNumericTokens

      public SettingsResponse setAllowTyposOnNumericTokens(Boolean allowTyposOnNumericTokens)

    • getAllowTyposOnNumericTokens

      @Nullable public Boolean getAllowTyposOnNumericTokens()
      Whether to allow typos on numbers in the search query. Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.

    • setDisableTypoToleranceOnAttributes

      public SettingsResponse setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes)

    • addDisableTypoToleranceOnAttributes

      public SettingsResponse addDisableTypoToleranceOnAttributes(String disableTypoToleranceOnAttributesItem)

    • getDisableTypoToleranceOnAttributes

      @Nullable public List<String> getDisableTypoToleranceOnAttributes()
      Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.

    • setIgnorePlurals

      public SettingsResponse setIgnorePlurals(IgnorePlurals ignorePlurals)

    • getIgnorePlurals

      @Nullable public IgnorePlurals getIgnorePlurals()
      Get ignorePlurals

    • setRemoveStopWords

      public SettingsResponse setRemoveStopWords(RemoveStopWords removeStopWords)

    • getRemoveStopWords

      @Nullable public RemoveStopWords getRemoveStopWords()
      Get removeStopWords

    • setKeepDiacriticsOnCharacters

      public SettingsResponse setKeepDiacriticsOnCharacters(String keepDiacriticsOnCharacters)

    • getKeepDiacriticsOnCharacters

      @Nullable public String getKeepDiacriticsOnCharacters()
      Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.

    • setQueryLanguages

      public SettingsResponse setQueryLanguages(List<SupportedLanguage> queryLanguages)

    • addQueryLanguages

      public SettingsResponse addQueryLanguages(SupportedLanguage queryLanguagesItem)

    • getQueryLanguages

      @Nullable public List<SupportedLanguage> getQueryLanguages()
      Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [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) languages. To support this, you must place the CJK language **first**. **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).

    • setDecompoundQuery

      public SettingsResponse setDecompoundQuery(Boolean decompoundQuery)

    • getDecompoundQuery

      @Nullable public Boolean getDecompoundQuery()
      Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).

    • setEnableRules

      public SettingsResponse setEnableRules(Boolean enableRules)

    • getEnableRules

      @Nullable public Boolean getEnableRules()
      Whether to enable rules.

    • setEnablePersonalization

      public SettingsResponse setEnablePersonalization(Boolean enablePersonalization)

    • getEnablePersonalization

      @Nullable public Boolean getEnablePersonalization()
      Whether to enable Personalization.

    • setQueryType

      public SettingsResponse setQueryType(QueryType queryType)

    • getQueryType

      @Nullable public QueryType getQueryType()
      Get queryType

    • setRemoveWordsIfNoResults

      public SettingsResponse setRemoveWordsIfNoResults(RemoveWordsIfNoResults removeWordsIfNoResults)

    • getRemoveWordsIfNoResults

      @Nullable public RemoveWordsIfNoResults getRemoveWordsIfNoResults()
      Get removeWordsIfNoResults

    • setMode

      public SettingsResponse setMode(Mode mode)

    • getMode

      @Nullable public Mode getMode()
      Get mode

    • setSemanticSearch

      public SettingsResponse setSemanticSearch(SemanticSearch semanticSearch)

    • getSemanticSearch

      @Nullable public SemanticSearch getSemanticSearch()
      Get semanticSearch

    • setAdvancedSyntax

      public SettingsResponse setAdvancedSyntax(Boolean advancedSyntax)

    • getAdvancedSyntax

      @Nullable public Boolean getAdvancedSyntax()
      Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported.

    • setOptionalWords

      public SettingsResponse setOptionalWords(List<String> optionalWords)

    • addOptionalWords

      public SettingsResponse addOptionalWords(String optionalWordsItem)

    • getOptionalWords

      @Nullable public List<String> getOptionalWords()
      Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).

    • setDisableExactOnAttributes

      public SettingsResponse setDisableExactOnAttributes(List<String> disableExactOnAttributes)

    • addDisableExactOnAttributes

      public SettingsResponse addDisableExactOnAttributes(String disableExactOnAttributesItem)

    • getDisableExactOnAttributes

      @Nullable public List<String> getDisableExactOnAttributes()
      Searchable 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). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.

    • setExactOnSingleWordQuery

      public SettingsResponse setExactOnSingleWordQuery(ExactOnSingleWordQuery exactOnSingleWordQuery)

    • getExactOnSingleWordQuery

      @Nullable public ExactOnSingleWordQuery getExactOnSingleWordQuery()
      Get exactOnSingleWordQuery

    • setAlternativesAsExact

      public SettingsResponse setAlternativesAsExact(List<AlternativesAsExact> alternativesAsExact)

    • addAlternativesAsExact

      public SettingsResponse addAlternativesAsExact(AlternativesAsExact alternativesAsExactItem)

    • getAlternativesAsExact

      @Nullable public List<AlternativesAsExact> getAlternativesAsExact()
      Alternatives of query words that should be considered as exact matches by the Exact ranking criterion. - `ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.

    • setAdvancedSyntaxFeatures

      public SettingsResponse setAdvancedSyntaxFeatures(List<AdvancedSyntaxFeatures> advancedSyntaxFeatures)

    • addAdvancedSyntaxFeatures

      public SettingsResponse addAdvancedSyntaxFeatures(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem)

    • getAdvancedSyntaxFeatures

      @Nullable public List<AdvancedSyntaxFeatures> getAdvancedSyntaxFeatures()
      Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax` is true.

    • setDistinct

      public SettingsResponse setDistinct(Distinct distinct)

    • getDistinct

      @Nullable public Distinct getDistinct()
      Get distinct

    • setReplaceSynonymsInHighlight

      public SettingsResponse setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight)

    • getReplaceSynonymsInHighlight

      @Nullable public Boolean getReplaceSynonymsInHighlight()
      Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurences of \"house\" are replaced by \"home\" in the highlighted response.

    • setMinProximity

      public SettingsResponse setMinProximity(Integer minProximity)

    • getMinProximity

      @Nullable public Integer getMinProximity()
      Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score. minimum: 1 maximum: 7

    • setResponseFields

      public SettingsResponse setResponseFields(List<String> responseFields)

    • addResponseFields

      public SettingsResponse addResponseFields(String responseFieldsItem)

    • getResponseFields

      @Nullable public List<String> getResponseFields()
      Properties to include in the API response of `search` and `browse` requests. By default, all response properties are included. To reduce the response size, you can select, which attributes should be included. You can't exclude these properties: `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter. Don't exclude properties that you might need in your search UI.

    • setMaxFacetHits

      public SettingsResponse setMaxFacetHits(Integer maxFacetHits)

    • getMaxFacetHits

      @Nullable public Integer getMaxFacetHits()
      Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). maximum: 100

    • setMaxValuesPerFacet

      public SettingsResponse setMaxValuesPerFacet(Integer maxValuesPerFacet)

    • getMaxValuesPerFacet

      @Nullable public Integer getMaxValuesPerFacet()
      Maximum number of facet values to return for each facet. maximum: 1000

    • setSortFacetValuesBy

      public SettingsResponse setSortFacetValuesBy(String sortFacetValuesBy)

    • getSortFacetValuesBy

      @Nullable public String getSortFacetValuesBy()
      Order in which to retrieve facet values. - `count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Retrieve facet values alphabetically. This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).

    • setAttributeCriteriaComputedByMinProximity

      public SettingsResponse setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity)

    • getAttributeCriteriaComputedByMinProximity

      @Nullable public Boolean getAttributeCriteriaComputedByMinProximity()
      Whether the best matching attribute should be determined by minimum proximity. This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.

    • setRenderingContent

      public SettingsResponse setRenderingContent(RenderingContent renderingContent)

    • getRenderingContent

      @Nullable public RenderingContent getRenderingContent()
      Get renderingContent

    • setEnableReRanking

      public SettingsResponse setEnableReRanking(Boolean enableReRanking)

    • getEnableReRanking

      @Nullable public Boolean getEnableReRanking()
      Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

    • setReRankingApplyFilter

      public SettingsResponse setReRankingApplyFilter(ReRankingApplyFilter reRankingApplyFilter)

    • getReRankingApplyFilter

      @Nullable public ReRankingApplyFilter getReRankingApplyFilter()
      Get reRankingApplyFilter

    • setPrimary

      public SettingsResponse setPrimary(String primary)

    • getPrimary

      @Nullable public String getPrimary()
      Replica indices only: the name of the primary index for this replica.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object