SuggestParameters Constructors

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Overloads

SuggestParameters()	Initializes a new instance of the SuggestParameters class.
SuggestParameters(String, Boolean, String, String, Nullable<Double>, IList<String>, IList<String>, IList<String>, Nullable<Int32>)	Initializes a new instance of the SuggestParameters class.

SuggestParameters()

Source:

SuggestParameters.cs

Initializes a new instance of the SuggestParameters class.

public SuggestParameters ();

Public Sub New ()

SuggestParameters(String, Boolean, String, String, Nullable<Double>, IList<String>, IList<String>, IList<String>, Nullable<Int32>)

Source:

SuggestParameters.cs

Initializes a new instance of the SuggestParameters class.

public SuggestParameters (string filter = default, bool useFuzzyMatching = false, string highlightPostTag = default, string highlightPreTag = default, double? minimumCoverage = default, System.Collections.Generic.IList<string> orderBy = default, System.Collections.Generic.IList<string> searchFields = default, System.Collections.Generic.IList<string> select = default, int? top = default);

new Microsoft.Azure.Search.Models.SuggestParameters : string * bool * string * string * Nullable<double> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> -> Microsoft.Azure.Search.Models.SuggestParameters

Public Sub New (Optional filter As String = Nothing, Optional useFuzzyMatching As Boolean = false, Optional highlightPostTag As String = Nothing, Optional highlightPreTag As String = Nothing, Optional minimumCoverage As Nullable(Of Double) = Nothing, Optional orderBy As IList(Of String) = Nothing, Optional searchFields As IList(Of String) = Nothing, Optional select As IList(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing)

Parameters

filter

String

An OData expression that filters the documents considered for suggestions.

useFuzzyMatching

Boolean

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.

highlightPostTag

String

A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.

highlightPreTag

String

A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.

minimumCoverage

Nullable<Double>

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.

orderBy

IList<String>

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.

searchFields

IList<String>

The list of field names to search for the specified search text. Target fields must be included in the specified suggester.

select

IList<String>

The list of fields to retrieve. If unspecified, only the key field will be included in the results.

top

Nullable<Int32>

The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.