Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeDocumentRankingOptions

OfficeIMO.Reader

Namespace
OfficeIMO.Reader
Assembly
OfficeIMO.Reader.Core
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

Ranking, query and resource settings for ranked document and chunk search.

Inheritance

  • object
  • OfficeDocumentRankingOptions

Usage

Explore 2 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.

Returned or exposed by 1

Accepted by parameters 1

Constructors

public OfficeDocumentRankingOptions() #

Properties

public double K1 { get; set; } #

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

public double B { get; set; } #

BM25 length normalization, from 0 to 1. Default: 0.75.

public double HeadingWeight { get; set; } #

Weight of words found in the heading path. Default: 2.

public double BodyWeight { get; set; } #

Weight of words found in the block or chunk text. Default: 1.

public bool AccentFolding { get; set; } #

When true, "resume" also matches "résumé". Default: false.

public OfficeDocumentQueryOperator DefaultOperator { get; set; } #

Operator between adjacent words. Default: OfficeDocumentQueryOperator.And.

public int MaximumClauses { get; set; } #

Maximum word, phrase and prefix clauses in one query. Default: 64.

public int MaximumPrefixExpansions { get; set; } #

Maximum index terms one prefix expands to, in ordinal order. Default: 128.

public long MaximumPostingsVisited { get; set; } #

Maximum postings read for one query. Default: 10,000,000.

public long MaximumIndexedTokens { get; set; } #

Maximum tokens indexed across the searched text; text beyond it is not searchable. Default: 20,000,000.