Search Results for

    Show / Hide Table of Contents

    Class TermVectorsDescriptor<TDocument>

    Descriptor for TermVectors

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestBase<TermVectorsRequestParameters>
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>
    TermVectorsDescriptor<TDocument>
    Implements
    IDescriptor
    ITermVectorsRequest<TDocument>
    IRequest<TermVectorsRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.Self
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.Assign<TValue>(TValue, Action<ITermVectorsRequest<TDocument>, TValue>)
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.Qs(string, object)
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.ErrorTrace(bool?)
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.FilterPath(params string[])
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.Human(bool?)
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.Pretty(bool?)
    RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>.SourceQueryString(string)
    RequestBase<TermVectorsRequestParameters>.HttpMethod
    RequestBase<TermVectorsRequestParameters>.RequestState
    RequestBase<TermVectorsRequestParameters>.ContentType
    RequestBase<TermVectorsRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<TermVectorsRequestParameters>.RequestDefaults(TermVectorsRequestParameters)
    RequestBase<TermVectorsRequestParameters>.Q<TOut>(string)
    RequestBase<TermVectorsRequestParameters>.Q(string, object)
    RequestBase<TermVectorsRequestParameters>.SetAcceptHeader(string)
    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 TermVectorsDescriptor<TDocument> : RequestDescriptorBase<TermVectorsDescriptor<TDocument>, TermVectorsRequestParameters, ITermVectorsRequest<TDocument>>, IDescriptor, ITermVectorsRequest<TDocument>, IRequest<TermVectorsRequestParameters>, IRequest where TDocument : class
    Type Parameters
    Name Description
    TDocument

    Constructors

    | Edit this page View Source

    TermVectorsDescriptor()

    /{index}/_termvectors

    Declaration
    public TermVectorsDescriptor()
    | Edit this page View Source

    TermVectorsDescriptor(Id)

    /{index}/_termvectors/{id}

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

    Optional, accepts null

    | Edit this page View Source

    TermVectorsDescriptor(IndexName)

    /{index}/_termvectors

    Declaration
    public TermVectorsDescriptor(IndexName index)
    Parameters
    Type Name Description
    IndexName index

    this parameter is required

    | Edit this page View Source

    TermVectorsDescriptor(IndexName, Id)

    /{index}/_termvectors/{id}

    Declaration
    public TermVectorsDescriptor(IndexName index, Id id)
    Parameters
    Type Name Description
    IndexName index

    this parameter is required

    Id id

    Optional, accepts null

    | Edit this page View Source

    TermVectorsDescriptor(TDocument, IndexName, Id)

    /{index}/_termvectors/{id}

    Declaration
    public TermVectorsDescriptor(TDocument documentWithId, IndexName index = null, Id id = null)
    Parameters
    Type Name Description
    TDocument documentWithId
    IndexName index
    Id id

    The document used to resolve the path from

    Methods

    | Edit this page View Source

    Document(TDocument)

    An optional document to get term vectors for instead of using an already indexed document

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

    FieldStatistics(bool?)

    If true, the response includes the document count, sum of document frequencies, and sum of total term frequencies.

    Declaration
    public TermVectorsDescriptor<TDocument> FieldStatistics(bool? fieldstatistics = true)
    Parameters
    Type Name Description
    bool? fieldstatistics
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>
    | Edit this page View Source

    Fields(Fields)

    Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

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

    Fields(params Expression<Func<TDocument, object>>[])

    Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

    Declaration
    public TermVectorsDescriptor<TDocument> Fields(params Expression<Func<TDocument, object>>[] fields)
    Parameters
    Type Name Description
    Expression<Func<TDocument, object>>[] fields
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>
    | Edit this page View Source

    Filter(Func<TermVectorFilterDescriptor, ITermVectorFilter>)

    Filter the terms returned based on their TF-IDF scores. This can be useful in order find out a good characteristic vector of a document.

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

    Id(Id)

    Unique identifier of the document.

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

    Index(IndexName)

    Name of the index that contains the document.

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

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

    Declaration
    public TermVectorsDescriptor<TDocument> Index<TOther>() where TOther : class
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>
    Type Parameters
    Name Description
    TOther
    | Edit this page View Source

    Offsets(bool?)

    If true, the response includes term offsets.

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

    Payloads(bool?)

    If true, the response includes term payloads.

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

    PerFieldAnalyzer(Func<PerFieldAnalyzerDescriptor<TDocument>, IPromise<IPerFieldAnalyzer>>)

    Provide a different analyzer than the one at the field. This is useful in order to generate term vectors in any fashion, especially when using artificial documents.

    Declaration
    public TermVectorsDescriptor<TDocument> PerFieldAnalyzer(Func<PerFieldAnalyzerDescriptor<TDocument>, IPromise<IPerFieldAnalyzer>> analyzerSelector)
    Parameters
    Type Name Description
    Func<PerFieldAnalyzerDescriptor<TDocument>, IPromise<IPerFieldAnalyzer>> analyzerSelector
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>
    | Edit this page View Source

    Positions(bool?)

    If true, the response includes term positions.

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

    Preference(string)

    Specifies the node or shard the operation should be performed on. Random by default.

    Declaration
    public TermVectorsDescriptor<TDocument> Preference(string preference)
    Parameters
    Type Name Description
    string preference
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>
    | Edit this page View Source

    Realtime(bool?)

    If true, the request is real-time as opposed to near-real-time.

    Declaration
    public TermVectorsDescriptor<TDocument> Realtime(bool? realtime = true)
    Parameters
    Type Name Description
    bool? realtime
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>
    | Edit this page View Source

    Routing(Routing)

    A document is routed to a particular shard in an index using the following formula

    shard_num = hash(_routing) % num_primary_shards

    OpenSearch will use the document id if not provided.

    For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

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

    TermStatistics(bool?)

    If true, the response includes term frequency and document frequency.

    Declaration
    public TermVectorsDescriptor<TDocument> TermStatistics(bool? termstatistics = true)
    Parameters
    Type Name Description
    bool? termstatistics
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>
    | Edit this page View Source

    Version(long?)

    If true, returns the document version as part of a hit.

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

    VersionType(VersionType?)

    Specific version type.

    Declaration
    public TermVectorsDescriptor<TDocument> VersionType(VersionType? versiontype)
    Parameters
    Type Name Description
    VersionType? versiontype
    Returns
    Type Description
    TermVectorsDescriptor<TDocument>

    Implements

    IDescriptor
    ITermVectorsRequest<TDocument>
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • TermVectorsDescriptor()
      • TermVectorsDescriptor(Id)
      • TermVectorsDescriptor(IndexName)
      • TermVectorsDescriptor(IndexName, Id)
      • TermVectorsDescriptor(TDocument, IndexName, Id)
    • Methods
      • Document(TDocument)
      • FieldStatistics(bool?)
      • Fields(Fields)
      • Fields(params Expression<Func<TDocument, object>>[])
      • Filter(Func<TermVectorFilterDescriptor, ITermVectorFilter>)
      • Id(Id)
      • Index(IndexName)
      • Index<TOther>()
      • Offsets(bool?)
      • Payloads(bool?)
      • PerFieldAnalyzer(Func<PerFieldAnalyzerDescriptor<TDocument>, IPromise<IPerFieldAnalyzer>>)
      • Positions(bool?)
      • Preference(string)
      • Realtime(bool?)
      • Routing(Routing)
      • TermStatistics(bool?)
      • Version(long?)
      • VersionType(VersionType?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX