Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeTextIndexOptions

OfficeIMO.TextAnalysis

Namespace
OfficeIMO.TextAnalysis
Assembly
OfficeIMO.Core
Source revision
ac7e6e1bad8a with working tree changes
Modifiers
sealed

Ranking, analysis and resource limits for an OfficeTextIndex.

Inheritance

  • object
  • OfficeTextIndexOptions

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 1

Constructors

public OfficeTextIndexOptions() #

Properties

public double K1 { get; set; } #

BM25 term-frequency saturation. Must be zero or more. Default: 1.2.

public double B { get; set; } #

BM25 length normalization, from 0 (none) to 1 (full). Default: 0.75.

public IDictionary<string, double> FieldWeights { get; } #

Field weights by field name (ordinal). Fields not listed weigh 1. A typical setup weighs a title or heading field above the body.

public OfficeTextAnalyzerOptions Analyzer { get; set; } #

Analyser settings used for indexed text and query text.

public int MaximumDocuments { get; set; } #

Maximum number of documents. Further documents are rejected. Default: 1,000,000.

public long MaximumTokens { get; set; } #

Maximum number of tokens held across the index, which bounds postings memory. The document that reaches the limit is indexed up to it and further documents are rejected. Default: 20,000,000.

public int MaximumFieldCharacters { get; set; } #

Characters analysed per field; the rest of a longer field is not indexed. Default: 4,000,000.