Package com.azure.search.documents.models

Class SearchOptions

  • public final class SearchOptions
extends Object
    Additional parameters for searchGet operation.

    • Constructor Detail

      • SearchOptions

        public SearchOptions()

    • Method Detail

      • isTotalCountIncluded

        public Boolean isTotalCountIncluded()
        Get the includeTotalCount property: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
        Returns:
        the includeTotalCount value.

      • setIncludeTotalCount

        public SearchOptions setIncludeTotalCount​(Boolean includeTotalCount)
        Set the includeTotalCount property: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.
        Parameters:
        includeTotalCount - the includeTotalCount value to set.
        Returns:
        the SearchOptions object itself.

      • getFacets

        public List<String> getFacets()
        Get the facets property: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.
        Returns:
        the facets value.

      • setFacets

        public SearchOptions setFacets​(String... facets)
        Set the facets property: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.
        Parameters:
        facets - the facets value to set.
        Returns:
        the SearchOptions object itself.

      • getFilter

        public String getFilter()
        Get the filter property: The OData $filter expression to apply to the search query.
        Returns:
        the filter value.

      • setFilter

        public SearchOptions setFilter​(String filter)
        Set the filter property: The OData $filter expression to apply to the search query.
        Parameters:
        filter - the filter value to set.
        Returns:
        the SearchOptions object itself.

      • getHighlightFields

        public List<String> getHighlightFields()
        Get the highlightFields property: The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.
        Returns:
        the highlightFields value.

      • setHighlightFields

        public SearchOptions setHighlightFields​(String... highlightFields)
        Set the highlightFields property: The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.
        Parameters:
        highlightFields - the highlightFields value to set.
        Returns:
        the SearchOptions object itself.

      • getHighlightPostTag

        public String getHighlightPostTag()
        Get the highlightPostTag property: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is &lt;/em&gt;.
        Returns:
        the highlightPostTag value.

      • setHighlightPostTag

        public SearchOptions setHighlightPostTag​(String highlightPostTag)
        Set the highlightPostTag property: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is &lt;/em&gt;.
        Parameters:
        highlightPostTag - the highlightPostTag value to set.
        Returns:
        the SearchOptions object itself.

      • getHighlightPreTag

        public String getHighlightPreTag()
        Get the highlightPreTag property: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is &lt;em&gt;.
        Returns:
        the highlightPreTag value.

      • setHighlightPreTag

        public SearchOptions setHighlightPreTag​(String highlightPreTag)
        Set the highlightPreTag property: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is &lt;em&gt;.
        Parameters:
        highlightPreTag - the highlightPreTag value to set.
        Returns:
        the SearchOptions 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 search 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 100.
        Returns:
        the minimumCoverage value.

      • setMinimumCoverage

        public 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. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.
        Parameters:
        minimumCoverage - the minimumCoverage value to set.
        Returns:
        the SearchOptions 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, and 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 SearchOptions 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, and 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 SearchOptions object itself.

      • getQueryType

        public QueryType getQueryType()
        Get the queryType property: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.
        Returns:
        the queryType value.

      • setQueryType

        public SearchOptions setQueryType​(QueryType queryType)
        Set the queryType property: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.
        Parameters:
        queryType - the queryType value to set.
        Returns:
        the SearchOptions object itself.

      • getScoringParameters

        public 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. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
        Returns:
        the scoringParameters value.

      • setScoringParameters

        public 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. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes).
        Parameters:
        scoringParameters - the scoringParameters value to set.
        Returns:
        the SearchOptions object itself.

      • getScoringProfile

        public 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.
        Returns:
        the scoringProfile value.

      • setScoringProfile

        public 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.
        Parameters:
        scoringProfile - the scoringProfile value to set.
        Returns:
        the SearchOptions object itself.

      • getSearchFields

        public List<String> getSearchFields()
        Get the searchFields property: The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.
        Returns:
        the searchFields value.

      • setSearchFields

        public SearchOptions setSearchFields​(String... searchFields)
        Set the searchFields property: The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.
        Parameters:
        searchFields - the searchFields value to set.
        Returns:
        the SearchOptions object itself.

      • getQueryLanguage

        public QueryLanguage getQueryLanguage()
        Get the queryLanguage property: The language of the query.
        Returns:
        the queryLanguage value.

      • setQueryLanguage

        public SearchOptions setQueryLanguage​(QueryLanguage queryLanguage)
        Set the queryLanguage property: The language of the query.
        Parameters:
        queryLanguage - the queryLanguage value to set.
        Returns:
        the SearchOptions object itself.

      • getSpeller

        public QuerySpellerType getSpeller()
        Get the speller property: Improve search recall by spell-correcting individual search query terms.
        Returns:
        the speller value.

      • setSpeller

        public SearchOptions setSpeller​(QuerySpellerType speller)
        Set the speller property: Improve search recall by spell-correcting individual search query terms.
        Parameters:
        speller - the speller value to set.
        Returns:
        the SearchOptions object itself.

      • getAnswers

        public QueryAnswerType getAnswers()
        Get the answers property: This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1.
        Returns:
        the answers value.

      • setAnswers

        public SearchOptions setAnswers​(QueryAnswerType answers)
        Set the answers property: This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1.
        Parameters:
        answers - the answers value to set.
        Returns:
        the SearchOptions object itself.

      • getAnswersCount

        public Integer getAnswersCount()
        Get the answers count property: This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1.
        Returns:
        the answers count value.

      • setAnswersCount

        public SearchOptions setAnswersCount​(Integer answersCount)
        Set the answers count property: This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1.
        Parameters:
        answersCount - the answers count value to set.
        Returns:
        the SearchOptions object itself.

      • getSearchMode

        public 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.
        Returns:
        the searchMode value.

      • setSearchMode

        public 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.
        Parameters:
        searchMode - the searchMode value to set.
        Returns:
        the SearchOptions object itself.

      • getScoringStatistics

        public 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.
        Returns:
        the scoringStatistics value.

      • setScoringStatistics

        public 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.
        Parameters:
        scoringStatistics - the scoringStatistics value to set.
        Returns:
        the SearchOptions object itself.

      • getSessionId

        public String getSessionId()
        Get the sessionId property: A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character.
        Returns:
        the sessionId value.

      • setSessionId

        public 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. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character.
        Parameters:
        sessionId - the sessionId value to set.
        Returns:
        the SearchOptions object itself.

      • getSelect

        public List<String> getSelect()
        Get the select property: The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.
        Returns:
        the select value.

      • setSelect

        public SearchOptions setSelect​(String... select)
        Set the select property: The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.
        Parameters:
        select - the select value to set.
        Returns:
        the SearchOptions object itself.

      • getSkip

        public Integer getSkip()
        Get the skip property: The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.
        Returns:
        the skip value.

      • setSkip

        public SearchOptions setSkip​(Integer skip)
        Set the skip property: The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.
        Parameters:
        skip - the skip value to set.
        Returns:
        the SearchOptions object itself.

      • getTop

        public Integer getTop()
        Get the top property: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.
        Returns:
        the top value.

      • setTop

        public SearchOptions setTop​(Integer top)
        Set the top property: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.
        Parameters:
        top - the top value to set.
        Returns:
        the SearchOptions object itself.

      • getQueryCaption

        public QueryCaptionType getQueryCaption()
        Get the query caption property: This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'.
        Returns:
        the query caption value.

      • setQueryCaption

        public SearchOptions setQueryCaption​(QueryCaptionType queryCaption)
        Set the query caption property: This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'.
        Parameters:
        queryCaption - the query caption value to set.
        Returns:
        the SearchOptions object itself.

      • getQueryCaptionHighlightEnabled

        public Boolean getQueryCaptionHighlightEnabled()
        Get the query caption highlight property: This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'.
        Returns:
        the query caption highlight value.

      • setQueryCaptionHighlightEnabled

        public SearchOptions setQueryCaptionHighlightEnabled​(Boolean queryCaptionHighlightEnabled)
        Set the query caption highlight property: This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'.
        Parameters:
        queryCaptionHighlightEnabled - the query caption highlight value to set.
        Returns:
        the SearchOptions object itself.

      • getSemanticFields

        public List<String> getSemanticFields()
        Get the semanticFields property: The list of field names used for semantic search.
        Returns:
        the semanticFields value.

      • setSemanticFields

        public SearchOptions setSemanticFields​(List<String> semanticFields)
        Set the semanticFields property: The list of field names used for semantic search.
        Parameters:
        semanticFields - the semanticFields value to set.
        Returns:
        the SearchOptions object itself.