Search Results for

    Show / Hide Table of Contents

    Class PhraseSuggestCollateDescriptor<T>

    Checks each suggestion against the specified query to prune suggestions for which no matching docs exist in the index.

    Inheritance
    object
    DescriptorBase<PhraseSuggestCollateDescriptor<T>, IPhraseSuggestCollate>
    PhraseSuggestCollateDescriptor<T>
    Implements
    IDescriptor
    IPhraseSuggestCollate
    Inherited Members
    DescriptorBase<PhraseSuggestCollateDescriptor<T>, IPhraseSuggestCollate>.Self
    DescriptorBase<PhraseSuggestCollateDescriptor<T>, IPhraseSuggestCollate>.Assign<TValue>(TValue, Action<IPhraseSuggestCollate, 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 PhraseSuggestCollateDescriptor<T> : DescriptorBase<PhraseSuggestCollateDescriptor<T>, IPhraseSuggestCollate>, IDescriptor, IPhraseSuggestCollate where T : class
    Type Parameters
    Name Description
    T

    Methods

    | Edit this page View Source

    Params(IDictionary<string, object>)

    The parameters for the query. the suggestion value will be added to the variables you specify.

    Declaration
    public PhraseSuggestCollateDescriptor<T> Params(IDictionary<string, object> paramsDictionary)
    Parameters
    Type Name Description
    IDictionary<string, object> paramsDictionary
    Returns
    Type Description
    PhraseSuggestCollateDescriptor<T>
    | Edit this page View Source

    Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

    The parameters for the query. the suggestion value will be added to the variables you specify.

    Declaration
    public PhraseSuggestCollateDescriptor<T> Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> paramsDictionary)
    Parameters
    Type Name Description
    Func<FluentDictionary<string, object>, FluentDictionary<string, object>> paramsDictionary
    Returns
    Type Description
    PhraseSuggestCollateDescriptor<T>
    | Edit this page View Source

    Prune(bool?)

    Controls if all phrase suggestions will be returned. When set to true, the suggestions will have an additional option collate_match, which will be true if matching documents for the phrase was found, false otherwise. The default value for Prune is false.

    Declaration
    public PhraseSuggestCollateDescriptor<T> Prune(bool? prune = true)
    Parameters
    Type Name Description
    bool? prune
    Returns
    Type Description
    PhraseSuggestCollateDescriptor<T>
    | Edit this page View Source

    Query(Func<PhraseSuggestCollateQueryDescriptor, IPhraseSuggestCollateQuery>)

    The collate query to run.

    Declaration
    public PhraseSuggestCollateDescriptor<T> Query(Func<PhraseSuggestCollateQueryDescriptor, IPhraseSuggestCollateQuery> selector)
    Parameters
    Type Name Description
    Func<PhraseSuggestCollateQueryDescriptor, IPhraseSuggestCollateQuery> selector
    Returns
    Type Description
    PhraseSuggestCollateDescriptor<T>

    Implements

    IDescriptor
    IPhraseSuggestCollate

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • Params(IDictionary<string, object>)
      • Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)
      • Prune(bool?)
      • Query(Func<PhraseSuggestCollateQueryDescriptor, IPhraseSuggestCollateQuery>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX