Package com.azure.search.documents.models

Class AutocompleteOptions

  • public final class AutocompleteOptions
extends Object
    Parameter group.

    • Constructor Detail

      • AutocompleteOptions

        public AutocompleteOptions()

    • Method Detail

      • getAutocompleteMode

        public AutocompleteMode getAutocompleteMode()
        Get the autocompleteMode property: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.
        Returns:
        the autocompleteMode value.

      • setAutocompleteMode

        public AutocompleteOptions setAutocompleteMode​(AutocompleteMode autocompleteMode)
        Set the autocompleteMode property: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.
        Parameters:
        autocompleteMode - the autocompleteMode value to set.
        Returns:
        the AutocompleteOptions object itself.

      • getFilter

        public String getFilter()
        Get the filter property: An OData expression that filters the documents used to produce completed terms for the Autocomplete result.
        Returns:
        the filter value.

      • setFilter

        public AutocompleteOptions setFilter​(String filter)
        Set the filter property: An OData expression that filters the documents used to produce completed terms for the Autocomplete result.
        Parameters:
        filter - the filter value to set.
        Returns:
        the AutocompleteOptions object itself.

      • useFuzzyMatching

        public Boolean useFuzzyMatching()
        Get the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
        Returns:
        the useFuzzyMatching value.

      • setUseFuzzyMatching

        public AutocompleteOptions setUseFuzzyMatching​(Boolean useFuzzyMatching)
        Set the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.
        Parameters:
        useFuzzyMatching - the useFuzzyMatching value to set.
        Returns:
        the AutocompleteOptions object itself.

      • getHighlightPostTag

        public String getHighlightPostTag()
        Get the highlightPostTag property: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.
        Returns:
        the highlightPostTag value.

      • setHighlightPostTag

        public AutocompleteOptions setHighlightPostTag​(String highlightPostTag)
        Set the highlightPostTag property: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.
        Parameters:
        highlightPostTag - the highlightPostTag value to set.
        Returns:
        the AutocompleteOptions object itself.

      • getHighlightPreTag

        public String getHighlightPreTag()
        Get the highlightPreTag property: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
        Returns:
        the highlightPreTag value.

      • setHighlightPreTag

        public AutocompleteOptions setHighlightPreTag​(String highlightPreTag)
        Set the highlightPreTag property: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.
        Parameters:
        highlightPreTag - the highlightPreTag value to set.
        Returns:
        the AutocompleteOptions object itself.

      • getMinimumCoverage

        public Double getMinimumCoverage()
        Get the minimumCoverage property: A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.
        Returns:
        the minimumCoverage value.

      • setMinimumCoverage

        public AutocompleteOptions setMinimumCoverage​(Double minimumCoverage)
        Set the minimumCoverage property: A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.
        Parameters:
        minimumCoverage - the minimumCoverage value to set.
        Returns:
        the AutocompleteOptions object itself.

      • getSearchFields

        public List<String> getSearchFields()
        Get the searchFields property: The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
        Returns:
        the searchFields value.

      • setSearchFields

        public AutocompleteOptions setSearchFields​(String... searchFields)
        Set the searchFields property: The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.
        Parameters:
        searchFields - the searchFields value to set.
        Returns:
        the AutocompleteOptions object itself.

      • getTop

        public Integer getTop()
        Get the top property: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.
        Returns:
        the top value.

      • setTop

        public AutocompleteOptions setTop​(Integer top)
        Set the top property: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.
        Parameters:
        top - the top value to set.
        Returns:
        the AutocompleteOptions object itself.