Search Results for

    Show / Hide Table of Contents

    Class CompletionSuggesterDescriptor<T>

    The completion suggester provides auto-complete/search-as-you-type functionality. This is a navigational feature to guide users to relevant results as they are typing, improving search precision. It is not meant for spell correction or did-you-mean functionality like the term or phrase suggesters.

    Inheritance
    object
    DescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester>
    SuggestDescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester, T>
    CompletionSuggesterDescriptor<T>
    Implements
    IDescriptor
    ICompletionSuggester
    ISuggester
    Inherited Members
    SuggestDescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester, T>.Size(int?)
    SuggestDescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester, T>.Analyzer(string)
    SuggestDescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester, T>.Field(Field)
    SuggestDescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester, T>.Field<TValue>(Expression<Func<T, TValue>>)
    DescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester>.Self
    DescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester>.Assign<TValue>(TValue, Action<ICompletionSuggester, TValue>)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class CompletionSuggesterDescriptor<T> : SuggestDescriptorBase<CompletionSuggesterDescriptor<T>, ICompletionSuggester, T>, IDescriptor, ICompletionSuggester, ISuggester where T : class
    Type Parameters
    Name Description
    T

    Methods

    | Edit this page View Source

    Contexts(Func<SuggestContextQueriesDescriptor<T>, IPromise<IDictionary<string, IList<ISuggestContextQuery>>>>)

    Context mappings used to filter and/or boost suggestions

    Declaration
    public CompletionSuggesterDescriptor<T> Contexts(Func<SuggestContextQueriesDescriptor<T>, IPromise<IDictionary<string, IList<ISuggestContextQuery>>>> contexts)
    Parameters
    Type Name Description
    Func<SuggestContextQueriesDescriptor<T>, IPromise<IDictionary<string, IList<ISuggestContextQuery>>>> contexts
    Returns
    Type Description
    CompletionSuggesterDescriptor<T>
    | Edit this page View Source

    Fuzzy(Func<SuggestFuzzinessDescriptor<T>, ISuggestFuzziness>)

    Support fuzziness for the suggestions

    Declaration
    public CompletionSuggesterDescriptor<T> Fuzzy(Func<SuggestFuzzinessDescriptor<T>, ISuggestFuzziness> selector = null)
    Parameters
    Type Name Description
    Func<SuggestFuzzinessDescriptor<T>, ISuggestFuzziness> selector
    Returns
    Type Description
    CompletionSuggesterDescriptor<T>
    | Edit this page View Source

    Prefix(string)

    Prefix used to search for suggestions

    Declaration
    public CompletionSuggesterDescriptor<T> Prefix(string prefix)
    Parameters
    Type Name Description
    string prefix
    Returns
    Type Description
    CompletionSuggesterDescriptor<T>
    | Edit this page View Source

    Regex(string)

    Prefix as a regular expression used to search for suggestions

    Declaration
    public CompletionSuggesterDescriptor<T> Regex(string regex)
    Parameters
    Type Name Description
    string regex
    Returns
    Type Description
    CompletionSuggesterDescriptor<T>
    | Edit this page View Source

    SkipDuplicates(bool?)

    Whether duplicate suggestions should be filtered out. Defaults to false

    Declaration
    public CompletionSuggesterDescriptor<T> SkipDuplicates(bool? skipDuplicates = true)
    Parameters
    Type Name Description
    bool? skipDuplicates
    Returns
    Type Description
    CompletionSuggesterDescriptor<T>

    Implements

    IDescriptor
    ICompletionSuggester
    ISuggester

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • Contexts(Func<SuggestContextQueriesDescriptor<T>, IPromise<IDictionary<string, IList<ISuggestContextQuery>>>>)
      • Fuzzy(Func<SuggestFuzzinessDescriptor<T>, ISuggestFuzziness>)
      • Prefix(string)
      • Regex(string)
      • SkipDuplicates(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX