Skip to content

Commit 77d5430

Browse files
committed
polish
1 parent e3f0553 commit 77d5430

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

public/API.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -551,8 +551,14 @@ <h3 id="text-search">Text Search</h3>
551551
<li>A <code class="language-plaintext highlighter-rouge">__rerum.score</code> property is added to each result indicating match quality</li>
552552
</ul>
553553
<p>
554-
The <code class="language-plaintext highlighter-rouge">limit</code> and <code class="language-plaintext highlighter-rouge">skip</code> URL parameters can be used for pagination. By default, <code class="language-plaintext highlighter-rouge">limit=100</code> and <code class="language-plaintext highlighter-rouge">skip=0</code>. It is recommended to use a limit of 100 or less for optimal performance.
554+
Use cases:
555555
</p>
556+
<ul>
557+
<li>General full-text search across annotation content</li>
558+
<li>Finding all annotations containing specific keywords or concepts</li>
559+
<li>Broad discovery when exact word order doesn't matter</li>
560+
<li>Best for single-word searches or when all search terms should appear anywhere in the document</li>
561+
</ul>
556562
<p>
557563
<div class="exHeading">Javascript Example (JSON Object)</div>
558564
<pre><code class="jsExample">

0 commit comments

Comments
 (0)