Package com.azure.search.documents.models

Class SuggestOptions

  • public final class SuggestOptions
extends Object
    Parameter group.

    • Constructor Detail

      • SuggestOptions

        public SuggestOptions()

    • Method Detail

      • getFilter

        public String getFilter()
        Get the filter property: An OData expression that filters the documents considered for suggestions.
        Returns:
        the filter value.

      • setFilter

        public SuggestOptions setFilter​(String filter)
        Set the filter property: An OData expression that filters the documents considered for suggestions.
        Parameters:
        filter - the filter value to set.
        Returns:
        the SuggestOptions object itself.

      • useFuzzyMatching

        public Boolean useFuzzyMatching()
        Get the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the suggestions 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 suggestions queries are slower and consume more resources.
        Returns:
        the useFuzzyMatching value.

      • setUseFuzzyMatching

        public SuggestOptions setUseFuzzyMatching​(Boolean useFuzzyMatching)
        Set the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the suggestions 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 suggestions queries are slower and consume more resources.
        Parameters:
        useFuzzyMatching - the useFuzzyMatching value to set.
        Returns:
        the SuggestOptions 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 of suggestions is disabled.
        Returns:
        the highlightPostTag value.

      • setHighlightPostTag

        public SuggestOptions 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 of suggestions is disabled.
        Parameters:
        highlightPostTag - the highlightPostTag value to set.
        Returns:
        the SuggestOptions 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 of suggestions is disabled.
        Returns:
        the highlightPreTag value.

      • setHighlightPreTag

        public SuggestOptions 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 of suggestions is disabled.
        Parameters:
        highlightPreTag - the highlightPreTag value to set.
        Returns:
        the SuggestOptions 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 a suggestions 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 SuggestOptions setMinimumCoverage​(Double minimumCoverage)
        Set the minimumCoverage property: A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions 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 SuggestOptions object itself.

      • getOrderBy

        public List<String> getOrderBy()
        Get the orderBy property: The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
        Returns:
        the orderBy value.

      • setOrderBy

        public SuggestOptions setOrderBy​(String... orderBy)
        Set the orderBy property: The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.
        Parameters:
        orderBy - the orderBy value to set.
        Returns:
        the SuggestOptions object itself.

      • getSearchFields

        public List<String> getSearchFields()
        Get the searchFields property: The list of field names to search for the specified search text. Target fields must be included in the specified suggester.
        Returns:
        the searchFields value.

      • setSearchFields

        public SuggestOptions setSearchFields​(String... searchFields)
        Set the searchFields property: The list of field names to search for the specified search text. Target fields must be included in the specified suggester.
        Parameters:
        searchFields - the searchFields value to set.
        Returns:
        the SuggestOptions object itself.

      • getSelect

        public List<String> getSelect()
        Get the select property: The list of fields to retrieve. If unspecified, only the key field will be included in the results.
        Returns:
        the select value.

      • setSelect

        public SuggestOptions setSelect​(String... select)
        Set the select property: The list of fields to retrieve. If unspecified, only the key field will be included in the results.
        Parameters:
        select - the select value to set.
        Returns:
        the SuggestOptions object itself.

      • getTop

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

      • setTop

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