Interface ISuggestOption<TDocument>

Suggest option

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface ISuggestOption<out TDocument> where TDocument : class
Type Parameters
Name Description
TDocument

Properties

| Edit this page View Source

CollateMatch

Phrase suggestions only, true if matching documents for the collate query were found,

Declaration
[DataMember(Name = "collate_match")]
bool CollateMatch { get; }
Property Value
Type Description
bool
| Edit this page View Source

Contexts

Completion suggester only, the contexts associated with the completed document

Declaration
[DataMember(Name = "contexts")]
IDictionary<string, IEnumerable<Context>> Contexts { get; }
Property Value
Type Description
IDictionary<string, IEnumerable<Context>>
| Edit this page View Source

DocumentScore

Declaration
[DataMember(Name = "_score")]
double? DocumentScore { get; }
Property Value
Type Description
double?
| Edit this page View Source

Fields

Declaration
[DataMember(Name = "fields")]
FieldValues Fields { get; }
Property Value
Type Description
FieldValues
| Edit this page View Source

Frequency

Term suggester only

Declaration
[DataMember(Name = "freq")]
long Frequency { get; set; }
Property Value
Type Description
long
| Edit this page View Source

Highlighted

Phrase suggester only, highlighted version of text

Declaration
[DataMember(Name = "highlighted")]
string Highlighted { get; }
Property Value
Type Description
string
| Edit this page View Source

Id

Completion suggester only, the id of the completed document

Declaration
[DataMember(Name = "_id")]
string Id { get; }
Property Value
Type Description
string
| Edit this page View Source

Index

Completion suggester only, the index of the completed document

Declaration
[DataMember(Name = "_index")]
IndexName Index { get; }
Property Value
Type Description
IndexName
| Edit this page View Source

Score

Either the DocumentScore or the SuggestScore

Declaration
[IgnoreDataMember]
double Score { get; }
Property Value
Type Description
double
| Edit this page View Source

Source

Completion suggester only, the source of the completed document

Declaration
[DataMember(Name = "_source")]
TDocument Source { get; }
Property Value
Type Description
TDocument
| Edit this page View Source

SuggestScore

Declaration
[DataMember(Name = "score")]
double? SuggestScore { get; }
Property Value
Type Description
double?
| Edit this page View Source

Text

Declaration
[DataMember(Name = "text")]
string Text { get; }
Property Value
Type Description
string

Extension Methods