Search Results for

    Show / Hide Table of Contents

    Class MultiTermVectorOperationDescriptor<T>

    An operation to define the calculation of term vectors when using Multi termvectors API

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

    Methods

    | Edit this page View Source

    Document(T)

    A document not indexed in OpenSearch, to generate term vectors for

    Declaration
    public MultiTermVectorOperationDescriptor<T> Document(T document)
    Parameters
    Type Name Description
    T document
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    FieldStatistics(bool?)

    Whether to include field statistics. When set to false,

    - document count (how many documents contain this field)

    - sum of document frequencies (the sum of document frequencies for all terms in this field)

    - sum of total term frequencies (the sum of total term frequencies of each term in this field)

    will be omitted. Default is true.
    Declaration
    public MultiTermVectorOperationDescriptor<T> FieldStatistics(bool? fieldStatistics = true)
    Parameters
    Type Name Description
    bool? fieldStatistics
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Fields(Fields)

    The document field to generate term vectors for

    Declaration
    public MultiTermVectorOperationDescriptor<T> Fields(Fields fields)
    Parameters
    Type Name Description
    Fields fields
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Fields(Func<FieldsDescriptor<T>, IPromise<Fields>>)

    The document field to generate term vectors for

    Declaration
    public MultiTermVectorOperationDescriptor<T> Fields(Func<FieldsDescriptor<T>, IPromise<Fields>> fields)
    Parameters
    Type Name Description
    Func<FieldsDescriptor<T>, IPromise<Fields>> fields
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Filter(Func<TermVectorFilterDescriptor, ITermVectorFilter>)

    Filter terms based on their tf-idf scores. This can be useful in order find out a good characteristic vector of a document.

    Declaration
    public MultiTermVectorOperationDescriptor<T> Filter(Func<TermVectorFilterDescriptor, ITermVectorFilter> filterSelector)
    Parameters
    Type Name Description
    Func<TermVectorFilterDescriptor, ITermVectorFilter> filterSelector
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Id(Id)

    The id of the document

    Declaration
    public MultiTermVectorOperationDescriptor<T> Id(Id id)
    Parameters
    Type Name Description
    Id id
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Index(IndexName)

    The index in which the document resides

    Declaration
    public MultiTermVectorOperationDescriptor<T> Index(IndexName index)
    Parameters
    Type Name Description
    IndexName index
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Offsets(bool?)

    Whether to include the start and end offsets. Default is true.

    Declaration
    public MultiTermVectorOperationDescriptor<T> Offsets(bool? offsets = true)
    Parameters
    Type Name Description
    bool? offsets
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Payloads(bool?)

    Whether to include the term payloads as base64 encoded bytes. Default is true

    Declaration
    public MultiTermVectorOperationDescriptor<T> Payloads(bool? payloads = true)
    Parameters
    Type Name Description
    bool? payloads
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Positions(bool?)

    Whether to include the term positions. Default is true

    Declaration
    public MultiTermVectorOperationDescriptor<T> Positions(bool? positions = true)
    Parameters
    Type Name Description
    bool? positions
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Routing(Routing)

    When requesting term vectors for Document, a shard to get the statistics from is randomly selected. Use Routing only to hit a particular shard.

    Declaration
    public MultiTermVectorOperationDescriptor<T> Routing(Routing routing)
    Parameters
    Type Name Description
    Routing routing
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    TermStatistics(bool?)

    Whether to include term statistics. When set to true,

    - total term frequency (how often a term occurs in all documents)

    - document frequency (the number of documents containing the current term)

    will be returned. Default is false since term statistics can have a large performance impact.
    Declaration
    public MultiTermVectorOperationDescriptor<T> TermStatistics(bool? termStatistics = true)
    Parameters
    Type Name Description
    bool? termStatistics
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    Version(long?)

    The version number

    Declaration
    public MultiTermVectorOperationDescriptor<T> Version(long? version)
    Parameters
    Type Name Description
    long? version
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>
    | Edit this page View Source

    VersionType(VersionType?)

    The type of version

    Declaration
    public MultiTermVectorOperationDescriptor<T> VersionType(VersionType? versionType)
    Parameters
    Type Name Description
    VersionType? versionType
    Returns
    Type Description
    MultiTermVectorOperationDescriptor<T>

    Implements

    IDescriptor
    IMultiTermVectorOperation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • Document(T)
      • FieldStatistics(bool?)
      • Fields(Fields)
      • Fields(Func<FieldsDescriptor<T>, IPromise<Fields>>)
      • Filter(Func<TermVectorFilterDescriptor, ITermVectorFilter>)
      • Id(Id)
      • Index(IndexName)
      • Offsets(bool?)
      • Payloads(bool?)
      • Positions(bool?)
      • Routing(Routing)
      • TermStatistics(bool?)
      • Version(long?)
      • VersionType(VersionType?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX