Uses of Class
com.azure.search.documents.models.SearchOptions

Packages that use SearchOptions

Package	Description
com.azure.search.documents	Package containing classes for creating SearchClient or SearchAsyncClient used to perform document management, autocomplete, search, or suggestion operations using an Azure Cognitive Search service index.
com.azure.search.documents.models	Package containing classes for SearchIndexClient.

Uses of SearchOptions in com.azure.search.documents

Methods in com.azure.search.documents with parameters of type SearchOptions

Modifier and Type	Method	Description
SearchPagedFlux	SearchAsyncClient.search(String searchText, SearchOptions searchOptions)	Searches for documents in the Azure Cognitive Search index.
SearchPagedIterable	SearchClient.search(String searchText, SearchOptions searchOptions, com.azure.core.util.Context context)	Searches for documents in the Azure Cognitive Search index.

Uses of SearchOptions in com.azure.search.documents.models

Methods in com.azure.search.documents.models that return SearchOptions

Modifier and Type	Method	Description
SearchOptions	SearchOptions.setAnswers(QueryAnswerType answers)	Set the answers property: This parameter is only valid if the query type is 'semantic'.
SearchOptions	SearchOptions.setAnswersCount(Integer answersCount)	Set the answers count property: This parameter is only valid if the query type is 'semantic'.
SearchOptions	SearchOptions.setFacets(String... facets)	Set the facets property: The list of facet expressions to apply to the search query.
SearchOptions	SearchOptions.setFilter(String filter)	Set the filter property: The OData $filter expression to apply to the search query.
SearchOptions	SearchOptions.setHighlightFields(String... highlightFields)	Set the highlightFields property: The list of field names to use for hit highlights.
SearchOptions	SearchOptions.setHighlightPostTag(String highlightPostTag)	Set the highlightPostTag property: A string tag that is appended to hit highlights.
SearchOptions	SearchOptions.setHighlightPreTag(String highlightPreTag)	Set the highlightPreTag property: A string tag that is prepended to hit highlights.
SearchOptions	SearchOptions.setIncludeTotalCount(Boolean includeTotalCount)	Set the includeTotalCount property: A value that specifies whether to fetch the total count of results.
SearchOptions	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	SearchOptions.setOrderBy(String... orderBy)	Set the orderBy property: The list of OData $orderby expressions by which to sort the results.
SearchOptions	SearchOptions.setQueryCaption(QueryCaptionType queryCaption)	Set the query caption property: This parameter is only valid if the query type is 'semantic'.
SearchOptions	SearchOptions.setQueryCaptionHighlightEnabled(Boolean queryCaptionHighlightEnabled)	Set the query caption highlight property: This parameter is only valid if the query type is 'semantic'.
SearchOptions	SearchOptions.setQueryLanguage(QueryLanguage queryLanguage)	Set the queryLanguage property: The language of the query.
SearchOptions	SearchOptions.setQueryType(QueryType queryType)	Set the queryType property: A value that specifies the syntax of the search query.
SearchOptions	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	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	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	SearchOptions.setSearchFields(String... searchFields)	Set the searchFields property: The list of field names to which to scope the full-text search.
SearchOptions	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	SearchOptions.setSelect(String... select)	Set the select property: The list of fields to retrieve.
SearchOptions	SearchOptions.setSemanticConfigurationName(String semanticConfigurationName)	Set the semanticConfigurationName property: The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers.
SearchOptions	SearchOptions.setSemanticFields(List<String> semanticFields)	Set the semanticFields property: The list of field names used for semantic search.
SearchOptions	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	SearchOptions.setSkip(Integer skip)	Set the skip property: The number of search results to skip.
SearchOptions	SearchOptions.setSpeller(QuerySpellerType speller)	Set the speller property: Improve search recall by spell-correcting individual search query terms.
SearchOptions	SearchOptions.setTop(Integer top)	Set the top property: The number of search results to retrieve.