Class SuggestionsRequest

Request object index for suggestions

Inheritance
object
SuggestionsRequest
Inherited Members
Namespace: Noxum.Nova.Index.Client
Assembly: Noxum.Nova.Index.Client.dll
Syntax
public class SuggestionsRequest

Properties

Analyze

If true, the search pattern is analyzed, otherwise it must occur as a prefix. Default: true.

Declaration
[JsonPropertyName("analyze")]
public bool Analyze { get; set; }
Property Value
Type Description
bool

Filter

The object filter condition

Declaration
[JsonPropertyName("filter")]
public ObjectFilterCondition Filter { get; set; }
Property Value
Type Description
ObjectFilterCondition

Fuzzy

If true, the last search term is used as a fuzzy pattern, not as a prefix.

Declaration
[JsonPropertyName("fuzzy")]
public bool Fuzzy { get; set; }
Property Value
Type Description
bool

FuzzyMinSimilarity

Minimum similarity for fuzzy search. The default value is 0.5. If fuzzy=false, this value is ignored

Declaration
[JsonPropertyName("fuzzyMinSimilarity")]
public float FuzzyMinSimilarity { get; set; }
Property Value
Type Description
float

FuzzyPrefixLength

The prefix length for fuzzy search. The default value is 0. If fuzzy=false, this value is ignored

Declaration
[JsonPropertyName("fuzzyPrefixLength")]
public int FuzzyPrefixLength { get; set; }
Property Value
Type Description
int

MaxWaitTime

The maximum time to wait for an object index update (defaults to IndexApiOptions.DefaultWaitTime)

Declaration
[JsonPropertyName("maxWaitTime")]
public TimeSpan? MaxWaitTime { get; set; }
Property Value
Type Description
TimeSpan?

MinChangeTrackingVersion

The minimum change tracking version of the object index

Declaration
[JsonPropertyName("minChangeTrackingVersion")]
public long? MinChangeTrackingVersion { get; set; }
Property Value
Type Description
long?

Pattern

The search pattern

Declaration
[JsonPropertyName("pattern")]
public string Pattern { get; set; }
Property Value
Type Description
string

SortByValue

If true, suggestions are sorted by value and not by count

Declaration
[JsonPropertyName("sortByValue")]
public bool SortByValue { get; set; }
Property Value
Type Description
bool

SuggestAttributes

The scoped attributes to create suggestions for

Declaration
[JsonPropertyName("suggestAttributes")]
public IList<SuggestionsScopedAttributeKey> SuggestAttributes { get; set; }
Property Value
Type Description
IList<SuggestionsScopedAttributeKey>

SuggestDisplayName

Create suggestions from the display name

Declaration
[JsonPropertyName("suggestDisplayName")]
public bool SuggestDisplayName { get; set; }
Property Value
Type Description
bool

SuggestFullText

Include OBJECT_FULL_TEXT in the suggestions.

Declaration
[JsonPropertyName("suggestFullText")]
public bool SuggestFullText { get; set; }
Property Value
Type Description
bool

Take

Take this number of items. Must be in the range 1..1000. Default: 10

Declaration
[JsonPropertyName("take")]
public int Take { get; set; }
Property Value
Type Description
int