Package com.algolia.model.search
Class IndexSettingsAsSearchParams
java.lang.Object
com.algolia.model.search.IndexSettingsAsSearchParams
IndexSettingsAsSearchParams
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAdvancedSyntaxFeatures
(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem) addAlternativesAsExact
(AlternativesAsExact alternativesAsExactItem) addAttributesToHighlight
(String attributesToHighlightItem) addAttributesToRetrieve
(String attributesToRetrieveItem) addAttributesToSnippet
(String attributesToSnippetItem) addCustomRanking
(String customRankingItem) addDisableExactOnAttributes
(String disableExactOnAttributesItem) addDisableTypoToleranceOnAttributes
(String disableTypoToleranceOnAttributesItem) addOptionalWords
(String optionalWordsItem) addQueryLanguages
(SupportedLanguage queryLanguagesItem) addRanking
(String rankingItem) addResponseFields
(String responseFieldsItem) boolean
Whether to support phrase matching and excluding words from search queries.Advanced search syntax features you want to support.Whether to allow typos on numbers in the search query.Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.Whether the best matching attribute should be determined by minimum proximity.Attributes to highlight.Attributes to include in the API response.Attributes for which to enable snippets.Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).Whether to split compound words into their building blocks.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).Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).Get distinctWhether to enable Personalization.Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).Whether to enable rules.Get exactOnSingleWordQueryHTML tag to insert after the highlighted parts in all highlighted results and snippets.HTML tag to insert before the highlighted parts in all highlighted results and snippets.Number of hits per page.Get ignorePluralsCharacters for which diacritics should be preserved.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 number of facet values to return for each facet.Minimum proximity score for two matching words.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).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).getMode()
Get modeWords that should be considered optional when found in the query.Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.Get queryTypeDetermines the order in which Algolia returns your results.Relevancy threshold below which less relevant results aren't included in the results.Get removeStopWordsGet removeWordsIfNoResultsGet renderingContentWhether to replace a highlighted word with the matched synonym.Get reRankingApplyFilterProperties to include in the API response of `search` and `browse` requests.Whether to restrict highlighting and snippeting to items that at least partially matched the search query.Get semanticSearchString used as an ellipsis indicator when a snippet is truncated.Order in which to retrieve facet values.Get typoToleranceint
hashCode()
setAdvancedSyntax
(Boolean advancedSyntax) setAdvancedSyntaxFeatures
(List<AdvancedSyntaxFeatures> advancedSyntaxFeatures) setAllowTyposOnNumericTokens
(Boolean allowTyposOnNumericTokens) setAlternativesAsExact
(List<AlternativesAsExact> alternativesAsExact) setAttributeCriteriaComputedByMinProximity
(Boolean attributeCriteriaComputedByMinProximity) setAttributesToHighlight
(List<String> attributesToHighlight) setAttributesToRetrieve
(List<String> attributesToRetrieve) setAttributesToSnippet
(List<String> attributesToSnippet) setCustomRanking
(List<String> customRanking) setDecompoundQuery
(Boolean decompoundQuery) setDisableExactOnAttributes
(List<String> disableExactOnAttributes) setDisableTypoToleranceOnAttributes
(List<String> disableTypoToleranceOnAttributes) 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) setKeepDiacriticsOnCharacters
(String keepDiacriticsOnCharacters) setMaxFacetHits
(Integer maxFacetHits) setMaxValuesPerFacet
(Integer maxValuesPerFacet) setMinProximity
(Integer minProximity) setMinWordSizefor1Typo
(Integer minWordSizefor1Typo) setMinWordSizefor2Typos
(Integer minWordSizefor2Typos) setOptionalWords
(List<String> optionalWords) setQueryLanguages
(List<SupportedLanguage> queryLanguages) setQueryType
(QueryType queryType) setRanking
(List<String> ranking) setRelevancyStrictness
(Integer relevancyStrictness) setRemoveStopWords
(RemoveStopWords removeStopWords) setRemoveWordsIfNoResults
(RemoveWordsIfNoResults removeWordsIfNoResults) setRenderingContent
(RenderingContent renderingContent) setReplaceSynonymsInHighlight
(Boolean replaceSynonymsInHighlight) setReRankingApplyFilter
(ReRankingApplyFilter reRankingApplyFilter) setResponseFields
(List<String> responseFields) setRestrictHighlightAndSnippetArrays
(Boolean restrictHighlightAndSnippetArrays) setSemanticSearch
(SemanticSearch semanticSearch) setSnippetEllipsisText
(String snippetEllipsisText) setSortFacetValuesBy
(String sortFacetValuesBy) setTypoTolerance
(TypoTolerance typoTolerance) toString()
-
Constructor Details
-
IndexSettingsAsSearchParams
public IndexSettingsAsSearchParams()
-
-
Method Details
-
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. - `*` 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
-
addRanking
-
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.
-
setCustomRanking
-
addCustomRanking
-
getCustomRanking
Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). 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.
-
setRelevancyStrictness
-
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
-
addAttributesToHighlight
-
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. 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
-
addAttributesToSnippet
-
getAttributesToSnippet
Attributes for which to enable snippets. 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
-
getHighlightPreTag
HTML tag to insert before the highlighted parts in all highlighted results and snippets. -
setHighlightPostTag
-
getHighlightPostTag
HTML tag to insert after the highlighted parts in all highlighted results and snippets. -
setSnippetEllipsisText
-
getSnippetEllipsisText
String used as an ellipsis indicator when a snippet is truncated. -
setRestrictHighlightAndSnippetArrays
public IndexSettingsAsSearchParams setRestrictHighlightAndSnippetArrays(Boolean restrictHighlightAndSnippetArrays) -
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
-
getHitsPerPage
Number of hits per page. minimum: 1 maximum: 1000 -
setMinWordSizefor1Typo
-
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
-
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
-
getTypoTolerance
Get typoTolerance -
setAllowTyposOnNumericTokens
-
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 IndexSettingsAsSearchParams setDisableTypoToleranceOnAttributes(List<String> disableTypoToleranceOnAttributes) -
addDisableTypoToleranceOnAttributes
public IndexSettingsAsSearchParams 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/). 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
-
getIgnorePlurals
Get ignorePlurals -
setRemoveStopWords
-
getRemoveStopWords
Get removeStopWords -
setKeepDiacriticsOnCharacters
-
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
-
addQueryLanguages
-
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
-
getDecompoundQuery
Whether to split compound words 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. -
setEnableRules
-
getEnableRules
Whether to enable rules. -
setEnablePersonalization
-
getEnablePersonalization
Whether to enable Personalization. -
setQueryType
-
getQueryType
Get queryType -
setRemoveWordsIfNoResults
public IndexSettingsAsSearchParams setRemoveWordsIfNoResults(RemoveWordsIfNoResults removeWordsIfNoResults) -
getRemoveWordsIfNoResults
Get removeWordsIfNoResults -
setMode
-
getMode
Get mode -
setSemanticSearch
-
getSemanticSearch
Get semanticSearch -
setAdvancedSyntax
-
getAdvancedSyntax
Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported. -
setOptionalWords
-
addOptionalWords
-
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 IndexSettingsAsSearchParams setDisableExactOnAttributes(List<String> disableExactOnAttributes) -
addDisableExactOnAttributes
-
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). 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 IndexSettingsAsSearchParams setExactOnSingleWordQuery(ExactOnSingleWordQuery exactOnSingleWordQuery) -
getExactOnSingleWordQuery
Get exactOnSingleWordQuery -
setAlternativesAsExact
public IndexSettingsAsSearchParams setAlternativesAsExact(List<AlternativesAsExact> alternativesAsExact) -
addAlternativesAsExact
public IndexSettingsAsSearchParams addAlternativesAsExact(AlternativesAsExact alternativesAsExactItem) -
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 IndexSettingsAsSearchParams setAdvancedSyntaxFeatures(List<AdvancedSyntaxFeatures> advancedSyntaxFeatures) -
addAdvancedSyntaxFeatures
public IndexSettingsAsSearchParams addAdvancedSyntaxFeatures(AdvancedSyntaxFeatures advancedSyntaxFeaturesItem) -
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\".
-
setDistinct
-
getDistinct
Get distinct -
setReplaceSynonymsInHighlight
public IndexSettingsAsSearchParams setReplaceSynonymsInHighlight(Boolean replaceSynonymsInHighlight) -
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
-
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
-
addResponseFields
-
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
-
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
-
getMaxValuesPerFacet
Maximum number of facet values to return for each facet. maximum: 1000 -
setSortFacetValuesBy
-
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.
-
setAttributeCriteriaComputedByMinProximity
public IndexSettingsAsSearchParams setAttributeCriteriaComputedByMinProximity(Boolean attributeCriteriaComputedByMinProximity) -
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
-
getRenderingContent
Get renderingContent -
setEnableReRanking
-
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 IndexSettingsAsSearchParams setReRankingApplyFilter(ReRankingApplyFilter reRankingApplyFilter) -
getReRankingApplyFilter
Get reRankingApplyFilter -
equals
-
hashCode
public int hashCode() -
toString
-