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

300 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.models.SuggestRequest"
fullName: "com.azure.search.models.SuggestRequest"
name: "SuggestRequest"
nameWithType: "SuggestRequest"
summary: "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors."
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 **SuggestRequest**"
constructors:
- uid: "com.azure.search.models.SuggestRequest.SuggestRequest()"
fullName: "com.azure.search.models.SuggestRequest.SuggestRequest()"
name: "SuggestRequest()"
nameWithType: "SuggestRequest.SuggestRequest()"
syntax: "public SuggestRequest()"
methods:
- uid: "com.azure.search.models.SuggestRequest.getFilter()"
fullName: "com.azure.search.models.SuggestRequest.getFilter()"
name: "getFilter()"
nameWithType: "SuggestRequest.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.SuggestRequest.getHighlightPostTag()"
fullName: "com.azure.search.models.SuggestRequest.getHighlightPostTag()"
name: "getHighlightPostTag()"
nameWithType: "SuggestRequest.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.SuggestRequest.getHighlightPreTag()"
fullName: "com.azure.search.models.SuggestRequest.getHighlightPreTag()"
name: "getHighlightPreTag()"
nameWithType: "SuggestRequest.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.SuggestRequest.getMinimumCoverage()"
fullName: "com.azure.search.models.SuggestRequest.getMinimumCoverage()"
name: "getMinimumCoverage()"
nameWithType: "SuggestRequest.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 suggestion 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 suggestion 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.SuggestRequest.getOrderBy()"
fullName: "com.azure.search.models.SuggestRequest.getOrderBy()"
name: "getOrderBy()"
nameWithType: "SuggestRequest.getOrderBy()"
summary: "Get the order<wbr>By property: The comma-separated list of OData $orderby expressions by which to sort the results."
syntax: "public String getOrderBy()"
desc: "Get the orderBy property: The comma-separated 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/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestRequest.getSearchFields()"
fullName: "com.azure.search.models.SuggestRequest.getSearchFields()"
name: "getSearchFields()"
nameWithType: "SuggestRequest.getSearchFields()"
summary: "Get the search<wbr>Fields property: The comma-separated list of field names to search for the specified search text."
syntax: "public String getSearchFields()"
desc: "Get the searchFields property: The comma-separated 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/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestRequest.getSearchText()"
fullName: "com.azure.search.models.SuggestRequest.getSearchText()"
name: "getSearchText()"
nameWithType: "SuggestRequest.getSearchText()"
summary: "Get the search<wbr>Text property: The search text to use to suggest documents."
syntax: "public String getSearchText()"
desc: "Get the searchText property: The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters."
returns:
description: "the searchText value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestRequest.getSelect()"
fullName: "com.azure.search.models.SuggestRequest.getSelect()"
name: "getSelect()"
nameWithType: "SuggestRequest.getSelect()"
summary: "Get the select property: The comma-separated list of fields to retrieve."
syntax: "public String getSelect()"
desc: "Get the select property: The comma-separated 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/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestRequest.getSuggesterName()"
fullName: "com.azure.search.models.SuggestRequest.getSuggesterName()"
name: "getSuggesterName()"
nameWithType: "SuggestRequest.getSuggesterName()"
summary: "Get the suggester<wbr>Name property: The name of the suggester as specified in the suggesters collection that's part of the index definition."
syntax: "public String getSuggesterName()"
desc: "Get the suggesterName property: The name of the suggester as specified in the suggesters collection that's part of the index definition."
returns:
description: "the suggesterName value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.models.SuggestRequest.getTop()"
fullName: "com.azure.search.models.SuggestRequest.getTop()"
name: "getTop()"
nameWithType: "SuggestRequest.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. 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.models.SuggestRequest.isUseFuzzyMatching()"
fullName: "com.azure.search.models.SuggestRequest.isUseFuzzyMatching()"
name: "isUseFuzzyMatching()"
nameWithType: "SuggestRequest.isUseFuzzyMatching()"
summary: "Get the use<wbr>Fuzzy<wbr>Matching property: A value indicating whether to use fuzzy matching for the suggestion query."
syntax: "public Boolean isUseFuzzyMatching()"
desc: "Get the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions 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 suggestion searches 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.SuggestRequest.setFilter(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setFilter(String filter)"
name: "setFilter(String filter)"
nameWithType: "SuggestRequest.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 SuggestRequest setFilter(String filter)"
desc: "Set the filter property: An OData expression that filters the documents considered for suggestions."
returns:
description: "the SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setHighlightPostTag(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setHighlightPostTag(String highlightPostTag)"
name: "setHighlightPostTag(String highlightPostTag)"
nameWithType: "SuggestRequest.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 SuggestRequest 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 SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setHighlightPreTag(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setHighlightPreTag(String highlightPreTag)"
name: "setHighlightPreTag(String highlightPreTag)"
nameWithType: "SuggestRequest.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 SuggestRequest 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 SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setMinimumCoverage(java.lang.Double)"
fullName: "com.azure.search.models.SuggestRequest.setMinimumCoverage(Double minimumCoverage)"
name: "setMinimumCoverage(Double minimumCoverage)"
nameWithType: "SuggestRequest.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 suggestion 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 SuggestRequest 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 suggestion 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 SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setOrderBy(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setOrderBy(String orderBy)"
name: "setOrderBy(String orderBy)"
nameWithType: "SuggestRequest.setOrderBy(String orderBy)"
summary: "Set the order<wbr>By property: The comma-separated 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 SuggestRequest setOrderBy(String orderBy)"
desc: "Set the orderBy property: The comma-separated 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 SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setSearchFields(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setSearchFields(String searchFields)"
name: "setSearchFields(String searchFields)"
nameWithType: "SuggestRequest.setSearchFields(String searchFields)"
summary: "Set the search<wbr>Fields property: The comma-separated 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 SuggestRequest setSearchFields(String searchFields)"
desc: "Set the searchFields property: The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester."
returns:
description: "the SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setSearchText(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setSearchText(String searchText)"
name: "setSearchText(String searchText)"
nameWithType: "SuggestRequest.setSearchText(String searchText)"
summary: "Set the search<wbr>Text property: The search text to use to suggest documents."
parameters:
- description: "the searchText value to set."
name: "searchText"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SuggestRequest setSearchText(String searchText)"
desc: "Set the searchText property: The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters."
returns:
description: "the SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setSelect(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setSelect(String select)"
name: "setSelect(String select)"
nameWithType: "SuggestRequest.setSelect(String select)"
summary: "Set the select property: The comma-separated 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 SuggestRequest setSelect(String select)"
desc: "Set the select property: The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results."
returns:
description: "the SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setSuggesterName(java.lang.String)"
fullName: "com.azure.search.models.SuggestRequest.setSuggesterName(String suggesterName)"
name: "setSuggesterName(String suggesterName)"
nameWithType: "SuggestRequest.setSuggesterName(String suggesterName)"
summary: "Set the suggester<wbr>Name property: The name of the suggester as specified in the suggesters collection that's part of the index definition."
parameters:
- description: "the suggesterName value to set."
name: "suggesterName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SuggestRequest setSuggesterName(String suggesterName)"
desc: "Set the suggesterName property: The name of the suggester as specified in the suggesters collection that's part of the index definition."
returns:
description: "the SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setTop(java.lang.Integer)"
fullName: "com.azure.search.models.SuggestRequest.setTop(Integer top)"
name: "setTop(Integer top)"
nameWithType: "SuggestRequest.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 SuggestRequest setTop(Integer top)"
desc: "Set the top property: The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5."
returns:
description: "the SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.SuggestRequest.setUseFuzzyMatching(java.lang.Boolean)"
fullName: "com.azure.search.models.SuggestRequest.setUseFuzzyMatching(Boolean useFuzzyMatching)"
name: "setUseFuzzyMatching(Boolean useFuzzyMatching)"
nameWithType: "SuggestRequest.setUseFuzzyMatching(Boolean useFuzzyMatching)"
summary: "Set the use<wbr>Fuzzy<wbr>Matching property: A value indicating whether to use fuzzy matching for the suggestion 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 SuggestRequest setUseFuzzyMatching(Boolean useFuzzyMatching)"
desc: "Set the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions 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 suggestion searches are slower and consume more resources."
returns:
description: "the SuggestRequest object itself."
type: "<xref href=\"com.azure.search.models.SuggestRequest?alt=com.azure.search.models.SuggestRequest&text=SuggestRequest\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors."
metadata: {}
package: "com.azure.search.models"
artifact: com.azure:azure-search:11.0.0-beta.1