public final class SearchOptions extends Object
Constructor and Description |
---|
SearchOptions() |
Modifier and Type | Method and Description |
---|---|
QueryAnswer |
getAnswers()
Get the answers property: This parameter is only valid if the query type is 'semantic'.
|
Integer |
getAnswersCount()
Get the answers count property: This parameter is only valid if the query type is 'semantic'.
|
List<String> |
getFacets()
Get the facets property: The list of facet expressions to apply to the search query.
|
String |
getFilter()
Get the filter property: The OData $filter expression to apply to the search query.
|
List<String> |
getHighlightFields()
Get the highlightFields property: The list of field names to use for hit highlights.
|
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 search query in order for the query to be reported as a success.
|
List<String> |
getOrderBy()
Get the orderBy property: The list of OData $orderby expressions by which to sort the results.
|
QueryCaption |
getQueryCaption()
Get the query caption property: This parameter is only valid if the query type is 'semantic'.
|
Boolean |
getQueryCaptionHighlight()
Get the query caption highlight property: This parameter is only valid if the query type is 'semantic'.
|
QueryLanguage |
getQueryLanguage()
Get the queryLanguage property: The language of the query.
|
QueryType |
getQueryType()
Get the queryType property: A value that specifies the syntax of the search query.
|
List<ScoringParameter> |
getScoringParameters()
Get the scoringParameters property: The list of parameter values to be used in scoring functions (for example,
referencePointParameter) using the format name-values.
|
String |
getScoringProfile()
Get the scoringProfile property: The name of a scoring profile to evaluate match scores for matching documents in
order to sort the results.
|
ScoringStatistics |
getScoringStatistics()
Get the scoringStatistics property: A value that specifies whether we want to calculate scoring statistics (such
as document frequency) globally for more consistent scoring, or locally, for lower latency.
|
List<String> |
getSearchFields()
Get the searchFields property: The list of field names to which to scope the full-text search.
|
SearchMode |
getSearchMode()
Get the searchMode property: A value that specifies whether any or all of the search terms must be matched in
order to count the document as a match.
|
List<String> |
getSelect()
Get the select property: The list of fields to retrieve.
|
List<String> |
getSemanticFields()
Get the semanticFields property: The list of field names used for semantic search.
|
String |
getSessionId()
Get the sessionId property: A value to be used to create a sticky session, which can help to get more consistent
results.
|
Integer |
getSkip()
Get the skip property: The number of search results to skip.
|
QuerySpeller |
getSpeller()
Get the speller property: Improve search recall by spell-correcting individual search query terms.
|
Integer |
getTop()
Get the top property: The number of search results to retrieve.
|
Boolean |
isTotalCountIncluded()
Get the includeTotalCount property: A value that specifies whether to fetch the total count of results.
|
SearchOptions |
setAnswers(QueryAnswer answers)
Set the answers property: This parameter is only valid if the query type is 'semantic'.
|
SearchOptions |
setAnswersCount(Integer answersCount)
Set the answers count property: This parameter is only valid if the query type is 'semantic'.
|
SearchOptions |
setFacets(String... facets)
Set the facets property: The list of facet expressions to apply to the search query.
|
SearchOptions |
setFilter(String filter)
Set the filter property: The OData $filter expression to apply to the search query.
|
SearchOptions |
setHighlightFields(String... highlightFields)
Set the highlightFields property: The list of field names to use for hit highlights.
|
SearchOptions |
setHighlightPostTag(String highlightPostTag)
Set the highlightPostTag property: A string tag that is appended to hit highlights.
|
SearchOptions |
setHighlightPreTag(String highlightPreTag)
Set the highlightPreTag property: A string tag that is prepended to hit highlights.
|
SearchOptions |
setIncludeTotalCount(Boolean includeTotalCount)
Set the includeTotalCount property: A value that specifies whether to fetch the total count of results.
|
SearchOptions |
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 search query in order for the query to be reported as a success.
|
SearchOptions |
setOrderBy(String... orderBy)
Set the orderBy property: The list of OData $orderby expressions by which to sort the results.
|
SearchOptions |
setQueryCaption(QueryCaption queryCaption)
Set the query caption property: This parameter is only valid if the query type is 'semantic'.
|
SearchOptions |
setQueryCaptionHighlight(Boolean queryCaptionHighlight)
Set the query caption highlight property: This parameter is only valid if the query type is 'semantic'.
|
SearchOptions |
setQueryLanguage(QueryLanguage queryLanguage)
Set the queryLanguage property: The language of the query.
|
SearchOptions |
setQueryType(QueryType queryType)
Set the queryType property: A value that specifies the syntax of the search query.
|
SearchOptions |
setScoringParameters(ScoringParameter... scoringParameters)
Set the scoringParameters property: The list of parameter values to be used in scoring functions (for example,
referencePointParameter) using the format name-values.
|
SearchOptions |
setScoringProfile(String scoringProfile)
Set the scoringProfile property: The name of a scoring profile to evaluate match scores for matching documents in
order to sort the results.
|
SearchOptions |
setScoringStatistics(ScoringStatistics scoringStatistics)
Set the scoringStatistics property: A value that specifies whether we want to calculate scoring statistics (such
as document frequency) globally for more consistent scoring, or locally, for lower latency.
|
SearchOptions |
setSearchFields(String... searchFields)
Set the searchFields property: The list of field names to which to scope the full-text search.
|
SearchOptions |
setSearchMode(SearchMode searchMode)
Set the searchMode property: A value that specifies whether any or all of the search terms must be matched in
order to count the document as a match.
|
SearchOptions |
setSelect(String... select)
Set the select property: The list of fields to retrieve.
|
SearchOptions |
setSemanticFields(List<String> semanticFields)
Set the semanticFields property: The list of field names used for semantic search.
|
SearchOptions |
setSessionId(String sessionId)
Set the sessionId property: A value to be used to create a sticky session, which can help to get more consistent
results.
|
SearchOptions |
setSkip(Integer skip)
Set the skip property: The number of search results to skip.
|
SearchOptions |
setSpeller(QuerySpeller speller)
Set the speller property: Improve search recall by spell-correcting individual search query terms.
|
SearchOptions |
setTop(Integer top)
Set the top property: The number of search results to retrieve.
|
public Boolean isTotalCountIncluded()
public SearchOptions setIncludeTotalCount(Boolean includeTotalCount)
includeTotalCount
- the includeTotalCount value to set.public List<String> getFacets()
public SearchOptions setFacets(String... facets)
facets
- the facets value to set.public String getFilter()
public SearchOptions setFilter(String filter)
filter
- the filter value to set.public List<String> getHighlightFields()
public SearchOptions setHighlightFields(String... highlightFields)
highlightFields
- the highlightFields value to set.public String getHighlightPostTag()
public SearchOptions setHighlightPostTag(String highlightPostTag)
highlightPostTag
- the highlightPostTag value to set.public String getHighlightPreTag()
public SearchOptions setHighlightPreTag(String highlightPreTag)
highlightPreTag
- the highlightPreTag value to set.public Double getMinimumCoverage()
public SearchOptions setMinimumCoverage(Double minimumCoverage)
minimumCoverage
- the minimumCoverage value to set.public List<String> getOrderBy()
public SearchOptions setOrderBy(String... orderBy)
orderBy
- the orderBy value to set.public QueryType getQueryType()
public SearchOptions setQueryType(QueryType queryType)
queryType
- the queryType value to set.public List<ScoringParameter> getScoringParameters()
public SearchOptions setScoringParameters(ScoringParameter... scoringParameters)
scoringParameters
- the scoringParameters value to set.public String getScoringProfile()
public SearchOptions setScoringProfile(String scoringProfile)
scoringProfile
- the scoringProfile value to set.public List<String> getSearchFields()
public SearchOptions setSearchFields(String... searchFields)
searchFields
- the searchFields value to set.public QueryLanguage getQueryLanguage()
public SearchOptions setQueryLanguage(QueryLanguage queryLanguage)
queryLanguage
- the queryLanguage value to set.public QuerySpeller getSpeller()
public SearchOptions setSpeller(QuerySpeller speller)
speller
- the speller value to set.public QueryAnswer getAnswers()
public SearchOptions setAnswers(QueryAnswer answers)
answers
- the answers value to set.public Integer getAnswersCount()
public SearchOptions setAnswersCount(Integer answersCount)
answersCount
- the answers count value to set.public SearchMode getSearchMode()
public SearchOptions setSearchMode(SearchMode searchMode)
searchMode
- the searchMode value to set.public ScoringStatistics getScoringStatistics()
public SearchOptions setScoringStatistics(ScoringStatistics scoringStatistics)
scoringStatistics
- the scoringStatistics value to set.public String getSessionId()
public SearchOptions setSessionId(String sessionId)
sessionId
- the sessionId value to set.public List<String> getSelect()
public SearchOptions setSelect(String... select)
select
- the select value to set.public Integer getSkip()
public SearchOptions setSkip(Integer skip)
skip
- the skip value to set.public Integer getTop()
public SearchOptions setTop(Integer top)
top
- the top value to set.public QueryCaption getQueryCaption()
public SearchOptions setQueryCaption(QueryCaption queryCaption)
queryCaption
- the query caption value to set.public Boolean getQueryCaptionHighlight()
public SearchOptions setQueryCaptionHighlight(Boolean queryCaptionHighlight)
queryCaptionHighlight
- the query caption highlight value to set.public List<String> getSemanticFields()
public SearchOptions setSemanticFields(List<String> semanticFields)
semanticFields
- the semanticFields value to set.Copyright © 2021 Microsoft Corporation. All rights reserved.