public final class SuggestRequest extends Object
Constructor and Description |
---|
SuggestRequest() |
Modifier and Type | Method and Description |
---|---|
String |
getFilter()
Get the filter property: An OData expression that filters the documents
considered for suggestions.
|
String |
getHighlightPostTag()
Get the highlightPostTag property: A string tag that is appended to hit
highlights.
|
String |
getHighlightPreTag()
Get the highlightPreTag property: A string tag that is prepended to hit
highlights.
|
Double |
getMinimumCoverage()
Get the minimumCoverage property: A number between 0 and 100 indicating
the percentage of the index that must be covered by a suggestion query
in order for the query to be reported as a success.
|
String |
getOrderBy()
Get the orderBy property: The comma-separated list of OData $orderby
expressions by which to sort the results.
|
String |
getSearchFields()
Get the searchFields property: The comma-separated list of field names
to search for the specified search text.
|
String |
getSearchText()
Get the searchText property: The search text to use to suggest
documents.
|
String |
getSelect()
Get the select property: The comma-separated list of fields to retrieve.
|
String |
getSuggesterName()
Get the suggesterName property: The name of the suggester as specified
in the suggesters collection that's part of the index definition.
|
Integer |
getTop()
Get the top property: The number of suggestions to retrieve.
|
SuggestRequest |
setFilter(String filter)
Set the filter property: An OData expression that filters the documents
considered for suggestions.
|
SuggestRequest |
setHighlightPostTag(String highlightPostTag)
Set the highlightPostTag property: A string tag that is appended to hit
highlights.
|
SuggestRequest |
setHighlightPreTag(String highlightPreTag)
Set the highlightPreTag property: A string tag that is prepended to hit
highlights.
|
SuggestRequest |
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 suggestion query
in order for the query to be reported as a success.
|
SuggestRequest |
setOrderBy(String orderBy)
Set the orderBy property: The comma-separated list of OData $orderby
expressions by which to sort the results.
|
SuggestRequest |
setSearchFields(String searchFields)
Set the searchFields property: The comma-separated list of field names
to search for the specified search text.
|
SuggestRequest |
setSearchText(String searchText)
Set the searchText property: The search text to use to suggest
documents.
|
SuggestRequest |
setSelect(String select)
Set the select property: The comma-separated list of fields to retrieve.
|
SuggestRequest |
setSuggesterName(String suggesterName)
Set the suggesterName property: The name of the suggester as specified
in the suggesters collection that's part of the index definition.
|
SuggestRequest |
setTop(Integer top)
Set the top property: The number of suggestions to retrieve.
|
SuggestRequest |
setUseFuzzyMatching(Boolean useFuzzyMatching)
Set the useFuzzyMatching property: A value indicating whether to use
fuzzy matching for the suggestion query.
|
Boolean |
useFuzzyMatching()
Get the useFuzzyMatching property: A value indicating whether to use
fuzzy matching for the suggestion query.
|
public String getFilter()
public SuggestRequest setFilter(String filter)
filter
- the filter value to set.public Boolean useFuzzyMatching()
public SuggestRequest setUseFuzzyMatching(Boolean useFuzzyMatching)
useFuzzyMatching
- the useFuzzyMatching value to set.public String getHighlightPostTag()
public SuggestRequest setHighlightPostTag(String highlightPostTag)
highlightPostTag
- the highlightPostTag value to set.public String getHighlightPreTag()
public SuggestRequest setHighlightPreTag(String highlightPreTag)
highlightPreTag
- the highlightPreTag value to set.public Double getMinimumCoverage()
public SuggestRequest setMinimumCoverage(Double minimumCoverage)
minimumCoverage
- the minimumCoverage value to set.public String getOrderBy()
public SuggestRequest setOrderBy(String orderBy)
orderBy
- the orderBy value to set.public String getSearchText()
public SuggestRequest setSearchText(String searchText)
searchText
- the searchText value to set.public String getSearchFields()
public SuggestRequest setSearchFields(String searchFields)
searchFields
- the searchFields value to set.public String getSelect()
public SuggestRequest setSelect(String select)
select
- the select value to set.public String getSuggesterName()
public SuggestRequest setSuggesterName(String suggesterName)
suggesterName
- the suggesterName value to set.public Integer getTop()
public SuggestRequest setTop(Integer top)
top
- the top value to set.Copyright © 2020 Microsoft Corporation. All rights reserved.