azure-docs-sdk-java/legacy/docs-ref-autogen/com.azure.search.models.SuggestOptions.yml

### YamlMime:JavaType
uid: "com.azure.search.models.SuggestOptions"
fullName: "com.azure.search.models.SuggestOptions"
name: "SuggestOptions"
nameWithType: "SuggestOptions"
summary: "Additional parameters for suggest<wbr>Get operation."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SuggestOptions**"
constructors:
- uid: "com.azure.search.models.SuggestOptions.SuggestOptions()"
  fullName: "com.azure.search.models.SuggestOptions.SuggestOptions()"
  name: "SuggestOptions()"
  nameWithType: "SuggestOptions.SuggestOptions()"
  syntax: "public SuggestOptions()"
methods:
- uid: "com.azure.search.models.SuggestOptions.getFilter()"
  fullName: "com.azure.search.models.SuggestOptions.getFilter()"
  name: "getFilter()"
  nameWithType: "SuggestOptions.getFilter()"
  summary: "Get the filter property: An OData expression that filters the documents considered for suggestions."
  syntax: "public String getFilter()"
  desc: "Get the filter property: An OData expression that filters the documents considered for suggestions."
  returns:
    description: "the filter value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestOptions.getHighlightPostTag()"
  fullName: "com.azure.search.models.SuggestOptions.getHighlightPostTag()"
  name: "getHighlightPostTag()"
  nameWithType: "SuggestOptions.getHighlightPostTag()"
  summary: "Get the highlight<wbr>Post<wbr>Tag property: A string tag that is appended to hit highlights."
  syntax: "public String getHighlightPostTag()"
  desc: "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:
    description: "the highlightPostTag value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestOptions.getHighlightPreTag()"
  fullName: "com.azure.search.models.SuggestOptions.getHighlightPreTag()"
  name: "getHighlightPreTag()"
  nameWithType: "SuggestOptions.getHighlightPreTag()"
  summary: "Get the highlight<wbr>Pre<wbr>Tag property: A string tag that is prepended to hit highlights."
  syntax: "public String getHighlightPreTag()"
  desc: "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:
    description: "the highlightPreTag value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestOptions.getMinimumCoverage()"
  fullName: "com.azure.search.models.SuggestOptions.getMinimumCoverage()"
  name: "getMinimumCoverage()"
  nameWithType: "SuggestOptions.getMinimumCoverage()"
  summary: "Get the minimum<wbr>Coverage 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."
  syntax: "public Double getMinimumCoverage()"
  desc: "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:
    description: "the minimumCoverage value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
- uid: "com.azure.search.models.SuggestOptions.getOrderBy()"
  fullName: "com.azure.search.models.SuggestOptions.getOrderBy()"
  name: "getOrderBy()"
  nameWithType: "SuggestOptions.getOrderBy()"
  summary: "Get the order<wbr>By property: The list of OData $orderby expressions by which to sort the results."
  syntax: "public List<String> getOrderBy()"
  desc: "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:
    description: "the orderBy value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.search.models.SuggestOptions.getSearchFields()"
  fullName: "com.azure.search.models.SuggestOptions.getSearchFields()"
  name: "getSearchFields()"
  nameWithType: "SuggestOptions.getSearchFields()"
  summary: "Get the search<wbr>Fields property: The list of field names to search for the specified search text."
  syntax: "public List<String> getSearchFields()"
  desc: "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:
    description: "the searchFields value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.search.models.SuggestOptions.getSelect()"
  fullName: "com.azure.search.models.SuggestOptions.getSelect()"
  name: "getSelect()"
  nameWithType: "SuggestOptions.getSelect()"
  summary: "Get the select property: The list of fields to retrieve."
  syntax: "public List<String> getSelect()"
  desc: "Get the select property: The list of fields to retrieve. If unspecified, only the key field will be included in the results."
  returns:
    description: "the select value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.search.models.SuggestOptions.getTop()"
  fullName: "com.azure.search.models.SuggestOptions.getTop()"
  name: "getTop()"
  nameWithType: "SuggestOptions.getTop()"
  summary: "Get the top property: The number of suggestions to retrieve."
  syntax: "public Integer getTop()"
  desc: "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:
    description: "the top value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.models.SuggestOptions.isUseFuzzyMatching()"
  fullName: "com.azure.search.models.SuggestOptions.isUseFuzzyMatching()"
  name: "isUseFuzzyMatching()"
  nameWithType: "SuggestOptions.isUseFuzzyMatching()"
  summary: "Get the use<wbr>Fuzzy<wbr>Matching property: A value indicating whether to use fuzzy matching for the suggestions query."
  syntax: "public Boolean isUseFuzzyMatching()"
  desc: "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:
    description: "the useFuzzyMatching value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.models.SuggestOptions.setFilter(java.lang.String)"
  fullName: "com.azure.search.models.SuggestOptions.setFilter(String filter)"
  name: "setFilter(String filter)"
  nameWithType: "SuggestOptions.setFilter(String filter)"
  summary: "Set the filter property: An OData expression that filters the documents considered for suggestions."
  parameters:
  - description: "the filter value to set."
    name: "filter"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SuggestOptions setFilter(String filter)"
  desc: "Set the filter property: An OData expression that filters the documents considered for suggestions."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setHighlightPostTag(java.lang.String)"
  fullName: "com.azure.search.models.SuggestOptions.setHighlightPostTag(String highlightPostTag)"
  name: "setHighlightPostTag(String highlightPostTag)"
  nameWithType: "SuggestOptions.setHighlightPostTag(String highlightPostTag)"
  summary: "Set the highlight<wbr>Post<wbr>Tag property: A string tag that is appended to hit highlights."
  parameters:
  - description: "the highlightPostTag value to set."
    name: "highlightPostTag"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SuggestOptions setHighlightPostTag(String highlightPostTag)"
  desc: "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."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setHighlightPreTag(java.lang.String)"
  fullName: "com.azure.search.models.SuggestOptions.setHighlightPreTag(String highlightPreTag)"
  name: "setHighlightPreTag(String highlightPreTag)"
  nameWithType: "SuggestOptions.setHighlightPreTag(String highlightPreTag)"
  summary: "Set the highlight<wbr>Pre<wbr>Tag property: A string tag that is prepended to hit highlights."
  parameters:
  - description: "the highlightPreTag value to set."
    name: "highlightPreTag"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SuggestOptions setHighlightPreTag(String highlightPreTag)"
  desc: "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."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setMinimumCoverage(java.lang.Double)"
  fullName: "com.azure.search.models.SuggestOptions.setMinimumCoverage(Double minimumCoverage)"
  name: "setMinimumCoverage(Double minimumCoverage)"
  nameWithType: "SuggestOptions.setMinimumCoverage(Double minimumCoverage)"
  summary: "Set the minimum<wbr>Coverage 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."
  parameters:
  - description: "the minimumCoverage value to set."
    name: "minimumCoverage"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
  syntax: "public SuggestOptions setMinimumCoverage(Double minimumCoverage)"
  desc: "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."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setOrderBy(java.lang.String...)"
  fullName: "com.azure.search.models.SuggestOptions.setOrderBy(String[] orderBy)"
  name: "setOrderBy(String[] orderBy)"
  nameWithType: "SuggestOptions.setOrderBy(String[] orderBy)"
  summary: "Set the order<wbr>By property: The list of OData $orderby expressions by which to sort the results."
  parameters:
  - description: "the orderBy value to set."
    name: "orderBy"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]"
  syntax: "public SuggestOptions setOrderBy(String[] orderBy)"
  desc: "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."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setSearchFields(java.lang.String...)"
  fullName: "com.azure.search.models.SuggestOptions.setSearchFields(String[] searchFields)"
  name: "setSearchFields(String[] searchFields)"
  nameWithType: "SuggestOptions.setSearchFields(String[] searchFields)"
  summary: "Set the search<wbr>Fields property: The list of field names to search for the specified search text."
  parameters:
  - description: "the searchFields value to set."
    name: "searchFields"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]"
  syntax: "public SuggestOptions setSearchFields(String[] searchFields)"
  desc: "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."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setSelect(java.lang.String...)"
  fullName: "com.azure.search.models.SuggestOptions.setSelect(String[] select)"
  name: "setSelect(String[] select)"
  nameWithType: "SuggestOptions.setSelect(String[] select)"
  summary: "Set the select property: The list of fields to retrieve."
  parameters:
  - description: "the select value to set."
    name: "select"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]"
  syntax: "public SuggestOptions setSelect(String[] select)"
  desc: "Set the select property: The list of fields to retrieve. If unspecified, only the key field will be included in the results."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setTop(java.lang.Integer)"
  fullName: "com.azure.search.models.SuggestOptions.setTop(Integer top)"
  name: "setTop(Integer top)"
  nameWithType: "SuggestOptions.setTop(Integer top)"
  summary: "Set the top property: The number of suggestions to retrieve."
  parameters:
  - description: "the top value to set."
    name: "top"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public SuggestOptions setTop(Integer top)"
  desc: "Set the top property: The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestOptions.setUseFuzzyMatching(java.lang.Boolean)"
  fullName: "com.azure.search.models.SuggestOptions.setUseFuzzyMatching(Boolean useFuzzyMatching)"
  name: "setUseFuzzyMatching(Boolean useFuzzyMatching)"
  nameWithType: "SuggestOptions.setUseFuzzyMatching(Boolean useFuzzyMatching)"
  summary: "Set the use<wbr>Fuzzy<wbr>Matching property: A value indicating whether to use fuzzy matching for the suggestions query."
  parameters:
  - description: "the useFuzzyMatching value to set."
    name: "useFuzzyMatching"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public SuggestOptions setUseFuzzyMatching(Boolean useFuzzyMatching)"
  desc: "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."
  returns:
    description: "the SuggestOptions object itself."
    type: "<xref href=\"com.azure.search.models.SuggestOptions?alt=com.azure.search.models.SuggestOptions&text=SuggestOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Additional parameters for suggestGet operation."
metadata: {}
package: "com.azure.search.models"
artifact: com.azure:azure-search:11.0.0-beta.1