com.azure.search.documents.models.AutocompleteOptions.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.models.AutocompleteOptions"
fullName: "com.azure.search.documents.models.AutocompleteOptions"
name: "AutocompleteOptions"
nameWithType: "AutocompleteOptions"
summary: "Parameter group."
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 **AutocompleteOptions**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.models.AutocompleteOptions.AutocompleteOptions()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.AutocompleteOptions()"
  name: "AutocompleteOptions()"
  nameWithType: "AutocompleteOptions.AutocompleteOptions()"
  summary: "Creates an instance of Autocomplete<wbr>Options class."
  syntax: "public AutocompleteOptions()"
  desc: "Creates an instance of AutocompleteOptions class."
methods:
- uid: "com.azure.search.documents.models.AutocompleteOptions.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "AutocompleteOptions.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Autocomplete<wbr>Options from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static AutocompleteOptions fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the AutocompleteOptions."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of AutocompleteOptions from the JsonReader."
  returns:
    description: "An instance of AutocompleteOptions if the JsonReader was pointing to an instance of it, or null if it was\n     pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.getAutocompleteMode()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.getAutocompleteMode()"
  name: "getAutocompleteMode()"
  nameWithType: "AutocompleteOptions.getAutocompleteMode()"
  summary: "Get the autocomplete<wbr>Mode property: Specifies the mode for Autocomplete."
  syntax: "public AutocompleteMode getAutocompleteMode()"
  desc: "Get the autocompleteMode property: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms."
  returns:
    description: "the autocompleteMode value."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteMode?alt=com.azure.search.documents.models.AutocompleteMode&text=AutocompleteMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.getFilter()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.getFilter()"
  name: "getFilter()"
  nameWithType: "AutocompleteOptions.getFilter()"
  summary: "Get the filter property: An OData expression that filters the documents used to produce completed terms for the Autocomplete result."
  syntax: "public String getFilter()"
  desc: "Get the filter property: An OData expression that filters the documents used to produce completed terms for the Autocomplete result."
  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.documents.models.AutocompleteOptions.getHighlightPostTag()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.getHighlightPostTag()"
  name: "getHighlightPostTag()"
  nameWithType: "AutocompleteOptions.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 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.documents.models.AutocompleteOptions.getHighlightPreTag()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.getHighlightPreTag()"
  name: "getHighlightPreTag()"
  nameWithType: "AutocompleteOptions.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 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.documents.models.AutocompleteOptions.getMinimumCoverage()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.getMinimumCoverage()"
  name: "getMinimumCoverage()"
  nameWithType: "AutocompleteOptions.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 an autocomplete 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 an autocomplete 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.documents.models.AutocompleteOptions.getSearchFields()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.getSearchFields()"
  name: "getSearchFields()"
  nameWithType: "AutocompleteOptions.getSearchFields()"
  summary: "Get the search<wbr>Fields property: The list of field names to consider when querying for auto-completed terms."
  syntax: "public List<String> getSearchFields()"
  desc: "Get the searchFields property: The list of field names to consider when querying for auto-completed terms. 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.documents.models.AutocompleteOptions.getTop()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.getTop()"
  name: "getTop()"
  nameWithType: "AutocompleteOptions.getTop()"
  summary: "Get the top property: The number of auto-completed terms to retrieve."
  syntax: "public Integer getTop()"
  desc: "Get the top property: The number of auto-completed terms to retrieve. This must be a value 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.documents.models.AutocompleteOptions.setAutocompleteMode(com.azure.search.documents.models.AutocompleteMode)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setAutocompleteMode(AutocompleteMode autocompleteMode)"
  name: "setAutocompleteMode(AutocompleteMode autocompleteMode)"
  nameWithType: "AutocompleteOptions.setAutocompleteMode(AutocompleteMode autocompleteMode)"
  summary: "Set the autocomplete<wbr>Mode property: Specifies the mode for Autocomplete."
  parameters:
  - description: "the autocompleteMode value to set."
    name: "autocompleteMode"
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteMode?alt=com.azure.search.documents.models.AutocompleteMode&text=AutocompleteMode\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AutocompleteOptions setAutocompleteMode(AutocompleteMode autocompleteMode)"
  desc: "Set the autocompleteMode property: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setFilter(java.lang.String)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setFilter(String filter)"
  name: "setFilter(String filter)"
  nameWithType: "AutocompleteOptions.setFilter(String filter)"
  summary: "Set the filter property: An OData expression that filters the documents used to produce completed terms for the Autocomplete result."
  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 AutocompleteOptions setFilter(String filter)"
  desc: "Set the filter property: An OData expression that filters the documents used to produce completed terms for the Autocomplete result."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setHighlightPostTag(java.lang.String)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setHighlightPostTag(String highlightPostTag)"
  name: "setHighlightPostTag(String highlightPostTag)"
  nameWithType: "AutocompleteOptions.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 AutocompleteOptions 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 is disabled."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setHighlightPreTag(java.lang.String)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setHighlightPreTag(String highlightPreTag)"
  name: "setHighlightPreTag(String highlightPreTag)"
  nameWithType: "AutocompleteOptions.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 AutocompleteOptions 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 is disabled."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setMinimumCoverage(java.lang.Double)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setMinimumCoverage(Double minimumCoverage)"
  name: "setMinimumCoverage(Double minimumCoverage)"
  nameWithType: "AutocompleteOptions.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 an autocomplete 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 AutocompleteOptions 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 an autocomplete 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 AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setSearchFields(java.lang.String...)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setSearchFields(String[] searchFields)"
  name: "setSearchFields(String[] searchFields)"
  nameWithType: "AutocompleteOptions.setSearchFields(String[] searchFields)"
  summary: "Set the search<wbr>Fields property: The list of field names to consider when querying for auto-completed terms."
  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 AutocompleteOptions setSearchFields(String[] searchFields)"
  desc: "Set the searchFields property: The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setSearchFields(java.util.List<java.lang.String>)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setSearchFields(List<String> searchFields)"
  name: "setSearchFields(List<String> searchFields)"
  nameWithType: "AutocompleteOptions.setSearchFields(List<String> searchFields)"
  summary: "Set the search<wbr>Fields property: The list of field names to consider when querying for auto-completed terms."
  parameters:
  - description: "the searchFields value to set."
    name: "searchFields"
    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;"
  syntax: "public AutocompleteOptions setSearchFields(List<String> searchFields)"
  desc: "Set the searchFields property: The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setTop(java.lang.Integer)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setTop(Integer top)"
  name: "setTop(Integer top)"
  nameWithType: "AutocompleteOptions.setTop(Integer top)"
  summary: "Set the top property: The number of auto-completed terms 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 AutocompleteOptions setTop(Integer top)"
  desc: "Set the top property: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.setUseFuzzyMatching(java.lang.Boolean)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.setUseFuzzyMatching(Boolean useFuzzyMatching)"
  name: "setUseFuzzyMatching(Boolean useFuzzyMatching)"
  nameWithType: "AutocompleteOptions.setUseFuzzyMatching(Boolean useFuzzyMatching)"
  summary: "Set the use<wbr>Fuzzy<wbr>Matching property: A value indicating whether to use fuzzy matching for the autocomplete 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 AutocompleteOptions setUseFuzzyMatching(Boolean useFuzzyMatching)"
  desc: "Set the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the autocomplete 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 autocomplete queries are slower and consume more resources."
  returns:
    description: "the AutocompleteOptions object itself."
    type: "<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "AutocompleteOptions.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.AutocompleteOptions.useFuzzyMatching()"
  fullName: "com.azure.search.documents.models.AutocompleteOptions.useFuzzyMatching()"
  name: "useFuzzyMatching()"
  nameWithType: "AutocompleteOptions.useFuzzyMatching()"
  summary: "Get the use<wbr>Fuzzy<wbr>Matching property: A value indicating whether to use fuzzy matching for the autocomplete query."
  syntax: "public Boolean useFuzzyMatching()"
  desc: "Get the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the autocomplete 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 autocomplete 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>"
type: "class"
desc: "Parameter group."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.models.AutocompleteOptions?alt=com.azure.search.documents.models.AutocompleteOptions&text=AutocompleteOptions\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.models"
artifact: com.azure:azure-search-documents:11.6.5