你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SuggestOptions Class
- java.
lang. Object - com.
azure. search. documents. models. SuggestOptions
- com.
Implements
public final class SuggestOptions
implements JsonSerializable<SuggestOptions>
Parameter group.
Constructor Summary
Constructor | Description |
---|---|
SuggestOptions() |
Creates an instance of Suggest |
Method Summary
Modifier and Type | Method and Description |
---|---|
static
Suggest |
fromJson(JsonReader jsonReader)
Reads an instance of Suggest |
String |
getFilter()
Get the filter property: An OData expression that filters the documents considered for suggestions. |
String |
getHighlightPostTag()
Get the highlight |
String |
getHighlightPreTag()
Get the highlight |
Double |
getMinimumCoverage()
Get the minimum |
List<String> |
getOrderBy()
Get the order |
List<String> |
getSearchFields()
Get the search |
List<String> |
getSelect()
Get the select property: The list of fields to retrieve. |
Integer |
getTop()
Get the top property: The number of suggestions to retrieve. |
Suggest |
setFilter(String filter)
Set the filter property: An OData expression that filters the documents considered for suggestions. |
Suggest |
setHighlightPostTag(String highlightPostTag)
Set the highlight |
Suggest |
setHighlightPreTag(String highlightPreTag)
Set the highlight |
Suggest |
setMinimumCoverage(Double minimumCoverage)
Set the minimum |
Suggest |
setOrderBy(String[] orderBy)
Set the order |
Suggest |
setOrderBy(List<String> orderBy)
Set the order |
Suggest |
setSearchFields(String[] searchFields)
Set the search |
Suggest |
setSearchFields(List<String> searchFields)
Set the search |
Suggest |
setSelect(String[] select)
Set the select property: The list of fields to retrieve. |
Suggest |
setSelect(List<String> select)
Set the select property: The list of fields to retrieve. |
Suggest |
setTop(Integer top)
Set the top property: The number of suggestions to retrieve. |
Suggest |
setUseFuzzyMatching(Boolean useFuzzyMatching)
Set the use |
Json |
toJson(JsonWriter jsonWriter) |
Boolean |
useFuzzyMatching()
Get the use |
Methods inherited from java.lang.Object
Constructor Details
SuggestOptions
public SuggestOptions()
Creates an instance of SuggestOptions class.
Method Details
fromJson
public static SuggestOptions fromJson(JsonReader jsonReader)
Reads an instance of SuggestOptions from the JsonReader.
Parameters:
Returns:
Throws:
getFilter
public String getFilter()
Get the filter property: An OData expression that filters the documents considered for suggestions.
Returns:
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:
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:
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:
getOrderBy
public List
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:
getSearchFields
public List
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:
getSelect
public List
Get the select property: The list of fields to retrieve. If unspecified, only the key field will be included in the results.
Returns:
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:
setFilter
public SuggestOptions setFilter(String filter)
Set the filter property: An OData expression that filters the documents considered for suggestions.
Parameters:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
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:
Returns:
setOrderBy
public SuggestOptions setOrderBy(List
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:
Returns:
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:
Returns:
setSearchFields
public SuggestOptions setSearchFields(List
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:
Returns:
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:
Returns:
setSelect
public SuggestOptions setSelect(List
Set the select property: The list of fields to retrieve. If unspecified, only the key field will be included in the results.
Parameters:
Returns:
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:
Returns:
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:
Returns:
toJson
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: