Search Results for

    Show / Hide Table of Contents

    Class SuggestContainerDescriptor<T>

    Inheritance
    object
    DescriptorPromiseBase<SuggestContainerDescriptor<T>, ISuggestContainer>
    IsADictionaryDescriptorBase<SuggestContainerDescriptor<T>, ISuggestContainer, string, ISuggestBucket>
    SuggestContainerDescriptor<T>
    Implements
    IDescriptor
    IPromise<ISuggestContainer>
    Inherited Members
    IsADictionaryDescriptorBase<SuggestContainerDescriptor<T>, ISuggestContainer, string, ISuggestBucket>.Assign(string, ISuggestBucket)
    DescriptorPromiseBase<SuggestContainerDescriptor<T>, ISuggestContainer>.Self
    DescriptorPromiseBase<SuggestContainerDescriptor<T>, ISuggestContainer>.Assign(Action<ISuggestContainer>)
    DescriptorPromiseBase<SuggestContainerDescriptor<T>, ISuggestContainer>.Assign<TNewValue>(TNewValue, Action<ISuggestContainer, TNewValue>)
    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 SuggestContainerDescriptor<T> : IsADictionaryDescriptorBase<SuggestContainerDescriptor<T>, ISuggestContainer, string, ISuggestBucket>, IDescriptor, IPromise<ISuggestContainer> where T : class
    Type Parameters
    Name Description
    T

    Constructors

    | Edit this page View Source

    SuggestContainerDescriptor()

    Declaration
    public SuggestContainerDescriptor()

    Methods

    | Edit this page View Source

    Completion(string, Func<CompletionSuggesterDescriptor<T>, ICompletionSuggester>)

    The completion suggester is a so-called prefix suggester. It does not do spell correction like the term or phrase suggesters but allows basic auto-complete functionality.

    Declaration
    public SuggestContainerDescriptor<T> Completion(string name, Func<CompletionSuggesterDescriptor<T>, ICompletionSuggester> suggest)
    Parameters
    Type Name Description
    string name
    Func<CompletionSuggesterDescriptor<T>, ICompletionSuggester> suggest
    Returns
    Type Description
    SuggestContainerDescriptor<T>
    | Edit this page View Source

    Phrase(string, Func<PhraseSuggesterDescriptor<T>, IPhraseSuggester>)

    The phrase suggester adds additional logic on top of the term suggester to select entire corrected phrases instead of individual tokens weighted based on ngram-language models. In practice this suggester will be able to make better decisions about which tokens to pick based on co-occurrence and frequencies.

    Declaration
    public SuggestContainerDescriptor<T> Phrase(string name, Func<PhraseSuggesterDescriptor<T>, IPhraseSuggester> suggest)
    Parameters
    Type Name Description
    string name
    Func<PhraseSuggesterDescriptor<T>, IPhraseSuggester> suggest
    Returns
    Type Description
    SuggestContainerDescriptor<T>
    | Edit this page View Source

    Term(string, Func<TermSuggesterDescriptor<T>, ITermSuggester>)

    The term suggester suggests terms based on edit distance. The provided suggest text is analyzed before terms are suggested. The suggested terms are provided per analyzed suggest text token. The term suggester doesn’t take the query into account that is part of request.

    Declaration
    public SuggestContainerDescriptor<T> Term(string name, Func<TermSuggesterDescriptor<T>, ITermSuggester> suggest)
    Parameters
    Type Name Description
    string name
    Func<TermSuggesterDescriptor<T>, ITermSuggester> suggest
    Returns
    Type Description
    SuggestContainerDescriptor<T>

    Implements

    IDescriptor
    IPromise<TValue>

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • SuggestContainerDescriptor()
    • Methods
      • Completion(string, Func<CompletionSuggesterDescriptor<T>, ICompletionSuggester>)
      • Phrase(string, Func<PhraseSuggesterDescriptor<T>, IPhraseSuggester>)
      • Term(string, Func<TermSuggesterDescriptor<T>, ITermSuggester>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX