Search Results for

    Show / Hide Table of Contents

    Class MultiTermVectorOperation<T>

    Inheritance
    object
    MultiTermVectorOperation<T>
    Implements
    IMultiTermVectorOperation
    Inherited Members
    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 MultiTermVectorOperation<T> : IMultiTermVectorOperation where T : class
    Type Parameters
    Name Description
    T

    Constructors

    | Edit this page View Source

    MultiTermVectorOperation(Id)

    Declaration
    public MultiTermVectorOperation(Id id)
    Parameters
    Type Name Description
    Id id

    Properties

    | Edit this page View Source

    Document

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

    Declaration
    public object Document { get; set; }
    Property Value
    Type Description
    object
    | Edit this page View Source

    FieldStatistics

    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 bool? FieldStatistics { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Fields

    The document field to generate term vectors for

    Declaration
    public Fields Fields { get; set; }
    Property Value
    Type Description
    Fields
    | Edit this page View Source

    Filter

    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 ITermVectorFilter Filter { get; set; }
    Property Value
    Type Description
    ITermVectorFilter
    | Edit this page View Source

    Id

    The id of the document

    Declaration
    public Id Id { get; set; }
    Property Value
    Type Description
    Id
    | Edit this page View Source

    Index

    The index in which the document resides

    Declaration
    public IndexName Index { get; set; }
    Property Value
    Type Description
    IndexName
    | Edit this page View Source

    Offsets

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

    Declaration
    public bool? Offsets { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Payloads

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

    Declaration
    public bool? Payloads { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Positions

    Whether to include the term positions. Default is true

    Declaration
    public bool? Positions { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    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 Routing Routing { get; set; }
    Property Value
    Type Description
    Routing
    | Edit this page View Source

    TermStatistics

    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 bool? TermStatistics { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Version

    The version number

    Declaration
    public long? Version { get; set; }
    Property Value
    Type Description
    long?
    | Edit this page View Source

    VersionType

    The type of version

    Declaration
    public VersionType? VersionType { get; set; }
    Property Value
    Type Description
    VersionType?

    Implements

    IMultiTermVectorOperation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • MultiTermVectorOperation(Id)
    • Properties
      • Document
      • FieldStatistics
      • Fields
      • Filter
      • Id
      • Index
      • Offsets
      • Payloads
      • Positions
      • Routing
      • TermStatistics
      • Version
      • VersionType
    • Implements
    • Extension Methods
    Back to top Generated by DocFX