Skip to content

Commit c65adf9

Browse files
committed
document num_docs_indexed
1 parent 8024477 commit c65adf9

3 files changed

Lines changed: 19 additions & 1 deletion

File tree

en/performance/streaming-search.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ <h2 id="differences-in-streaming-search">Differences in streaming search</h2>
6060
<em>nativeRank</em>, <em>nativeFieldMatch</em>, <em>nativeProximity</em> and <em>fieldMatch</em>.</li>
6161
<li>If using <em>bm25</em>, adjust the
6262
<a href="../reference/ranking/rank-feature-configuration.html#properties">averageFieldLength</a>
63-
configuration for a more precise <em>bm25</em> score.</li>
63+
configuration for a more precise <em>bm25</em> score.
64+
The <a href="../reference/ranking/rank-features.html#num_docs_indexed">num_docs_indexed</a>
65+
rank feature returns 1 in streaming search.</li>
6466
</ul>
6567
</li>
6668
<li>Even without any indexes, fields must be specified as

en/ranking/bm25.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,9 @@ <h2 id="ranking-function">Ranking function</h2>
215215
</figure>
216216
<p>
217217
<em>N</em> is the total number of documents on the content node.
218+
The local value BM25 uses in this case is exposed as the
219+
<a href="../reference/ranking/rank-features.html#num_docs_indexed">num_docs_indexed</a>
220+
rank feature.
218221
<math xmlns="http://www.w3.org/1998/Math/MathML" display="inline">
219222
<semantics>
220223
<mrow>

en/reference/ranking/rank-features.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1386,6 +1386,19 @@ <h3 id="rank-scores">Rank scores</h3></td></tr>
13861386
<td>n/a</td>
13871387
<td><p id="now">Time at which the query is executed in unix-time (seconds since epoch)</p></td></tr>
13881388

1389+
<tr><td>num_docs_indexed</td>
1390+
<td>n/a</td>
1391+
<td>
1392+
<p id="num_docs_indexed">
1393+
The local document count used as <a href="../../ranking/bm25.html">BM25</a>'s total document count
1394+
when no per-term document-frequency override is present.
1395+
This is the <em>N</em> term used by the BM25 inverse document frequency calculation.
1396+
</p>
1397+
{% include note.html content="The value is a per-content-node statistic computed locally; it is
1398+
<em>not</em> cluster-wide and may differ between nodes. For
1399+
<a href='../../performance/streaming-search.html'>streaming search</a>, this feature returns 1." %}
1400+
</td></tr>
1401+
13891402
<tr><td>random</td>
13901403
<td>n/a</td>
13911404
<td>

0 commit comments

Comments
 (0)