Deployed 7495136 to dev with MkDocs 1.6.0 and mike 2.1.3

argilla-io · Aug 30, 2024 · ec1f61c · ec1f61c
1 parent df2dcd7
commit ec1f61c
Show file tree

Hide file tree

Showing 6 changed files with 154 additions and 64 deletions.
diff --git a/dev/community/popular_issues/index.html b/dev/community/popular_issues/index.html
@@ -2139,54 +2139,54 @@ <h1>Issue dashboard</h1>
 <tbody>
 <tr>
 <td>1</td>
+<td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5442">5442 - [BUG-python/deployment]</a></td>
+<td style="text-align: center;">by <strong>nicolamassarenti</strong></td>
+</tr>
+<tr>
+<td>2</td>
 <td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5438">5438 - [FEATURE] Make text box size of TextQuestion adjustable</a></td>
 <td style="text-align: center;">by <strong>MoritzLaurer</strong></td>
 </tr>
 <tr>
-<td>2</td>
+<td>3</td>
 <td>🟣 <a href="https://github.com/argilla-io/argilla/issues/5424">5424 - [BUG-python/deployment]The status of all the dataset.records.to_dict(orient='index') records are pending</a></td>
 <td style="text-align: center;">by <strong>Huarong</strong></td>
 </tr>
 <tr>
-<td>3</td>
+<td>4</td>
 <td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5414">5414 - docker download failed</a></td>
 <td style="text-align: center;">by <strong>njhouse365</strong></td>
 </tr>
 <tr>
-<td>4</td>
+<td>5</td>
 <td>🟣 <a href="https://github.com/argilla-io/argilla/issues/5357">5357 - [BUG-python/deployment] Response sanity check not working due to variable renaming</a></td>
 <td style="text-align: center;">by <strong>maxserras</strong></td>
 </tr>
 <tr>
-<td>5</td>
+<td>6</td>
 <td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5348">5348 - [FEATURE] Ability to create new labels on-the-fly</a></td>
 <td style="text-align: center;">by <strong>uahmad235</strong></td>
 </tr>
 <tr>
-<td>6</td>
+<td>7</td>
 <td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5338">5338 - [BUG-UI/UX] CSS is being stripped from TextQuestion</a></td>
 <td style="text-align: center;">by <strong>paulbauriegel</strong></td>
 </tr>
 <tr>
-<td>7</td>
+<td>8</td>
 <td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5318">5318 - [BUG-python/deployment] filter_by returning unexpected results for response_status</a></td>
 <td style="text-align: center;">by <strong>bertozzivill</strong></td>
 </tr>
 <tr>
-<td>8</td>
+<td>9</td>
 <td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5302">5302 - [FEATURE]Auto-annotation of Repeated Tokens</a></td>
 <td style="text-align: center;">by <strong>bikash119</strong></td>
 </tr>
 <tr>
-<td>9</td>
+<td>10</td>
 <td>🟣 <a href="https://github.com/argilla-io/argilla/issues/5290">5290 - [BUG-python/deployment] Docker deployment issues</a></td>
 <td style="text-align: center;">by <strong>zhongze-fish</strong></td>
 </tr>
-<tr>
-<td>10</td>
-<td>🟣 <a href="https://github.com/argilla-io/argilla/issues/5281">5281 - [BUG-python/deployment] Error thrown by Argilla SDK : The reason of error thrown by Argilla SDK is different / ambigious from the cause of the error</a></td>
-<td style="text-align: center;">by <strong>bikash119</strong></td>
-</tr>
 </tbody>
 </table>
 </div>
@@ -2237,25 +2237,25 @@ <h1>Issue dashboard</h1>
 </tr>
 <tr>
 <td>8</td>
-<td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5278">5278 - [TASK] Check records using <code>ImageField</code> with URLs using <code>HTTP</code> protocol serving application from <code>HTTPS</code></a></td>
+<td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5361">5361 - [BUG-UI/UX] required/optional differentiation for<code>Fields</code> are not represented in the dataset settings</a></td>
 <td style="text-align: center;"><strong>v2.1.0</strong></td>
 </tr>
 <tr>
 <td>9</td>
-<td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5361">5361 - [BUG-UI/UX] required/optional differentiation for<code>Fields</code> are not represented in the dataset settings</a></td>
+<td>🟢 <a href="https://github.com/argilla-io/argilla/issues/3338">3338 - [FEATURE] Add conversation support to fields in Argilla dataset (ChatField)</a></td>
 <td style="text-align: center;"><strong>v2.1.0</strong></td>
 </tr>
 <tr>
 <td>10</td>
-<td>🟢 <a href="https://github.com/argilla-io/argilla/issues/3338">3338 - [FEATURE] Add conversation support to fields in Argilla dataset (ChatField)</a></td>
+<td>🟢 <a href="https://github.com/argilla-io/argilla/issues/5371">5371 - [UI/UX] Implement dark theme</a></td>
 <td style="text-align: center;"><strong>v2.1.0</strong></td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 </div>
-<p>Last update: 2024-08-29</p>
+<p>Last update: 2024-08-30</p>
 
 
 

diff --git a/dev/how_to_guides/annotate/index.html b/dev/how_to_guides/annotate/index.html
@@ -2553,6 +2553,14 @@ <h2 id="use-search-filters-and-sort">Use search, filters, and sort<a class="head
 </div>
 <h3 id="search">Search<a class="headerlink" href="#search" title="Permanent link">&para;</a></h3>
 <p>From the <strong>control panel</strong> at the top of the left pane, you can search by keyword across the entire dataset. If you have more than one field in your records, you may specify if the search is to be performed “All” fields or on a specific one. Matched results are highlighted in color.</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>If you introduce more than one keyword, the search will return results where <strong>all</strong> keywords have a match.</p>
+</div>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>For more advanced searches, take a look at the <a href="../query/#advanced-queries">advanced queries DSL</a>.</p>
+</div>
 <h3 id="order-by-record-semantic-similarity">Order by record semantic similarity<a class="headerlink" href="#order-by-record-semantic-similarity" title="Permanent link">&para;</a></h3>
 <p>You can retrieve records based on their similarity to another record if vectors have been added to the dataset.</p>
 <div class="admonition note">

diff --git a/dev/how_to_guides/query/index.html b/dev/how_to_guides/query/index.html
@@ -933,6 +933,21 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="Query with search terms">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#advanced-queries" class="md-nav__link">
+    <span class="md-ellipsis">
+      Advanced queries
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -2132,6 +2147,21 @@
     </span>
   </a>
 
+    <nav class="md-nav" aria-label="Query with search terms">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#advanced-queries" class="md-nav__link">
+    <span class="md-ellipsis">
+      Advanced queries
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
 </li>
 
         <li class="md-nav__item">
@@ -2217,7 +2247,7 @@ <h1 id="query-and-filter-records">Query and filter records<a class="headerlink"
 </div>
 <h2 id="query-with-search-terms">Query with search terms<a class="headerlink" href="#query-with-search-terms" title="Permanent link">&para;</a></h2>
 <p>To search for records with terms, you can use the <code>Dataset.records</code> attribute with a query string. The search terms are used to search for records that contain the terms in the text field. You can search a single term or various terms, in the latter, all of them should appear in the record to be retrieved.</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">Single search term</label><label for="__tabbed_2_2">Multiple search term</label></div>
+<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">Single term search</label><label for="__tabbed_2_2">Multiple terms search</label></div>
 <div class="tabbed-content">
 <div class="tabbed-block">
 <div class="language-python highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="kn">import</span> <span class="nn">argilla</span> <span class="k">as</span> <span class="nn">rg</span>
@@ -2245,6 +2275,58 @@ <h2 id="query-with-search-terms">Query with search terms<a class="headerlink" hr
 </div>
 </div>
 </div>
+<h3 id="advanced-queries">Advanced queries<a class="headerlink" href="#advanced-queries" title="Permanent link">&para;</a></h3>
+<p>If you need more complex searches, you can use <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html#simple-query-string-syntax">Elasticsearch's simple query string syntax</a>. Here is a summary of the different available operators:</p>
+<table>
+<thead>
+<tr>
+<th>operator</th>
+<th>description</th>
+<th>example</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>+</code> or <code>space</code></td>
+<td><strong>AND</strong>: search both terms</td>
+<td><code>argilla + distilabel</code> or <code>argilla distilabel</code></br> return records that include the terms "argilla" and "distilabel"</td>
+</tr>
+<tr>
+<td><code>|</code></td>
+<td><strong>OR</strong>: search either term</td>
+<td><code>argilla | distilabel</code> </br> returns records that include the term "argilla" or "distilabel"</td>
+</tr>
+<tr>
+<td><code>-</code></td>
+<td><strong>Negation</strong>: exclude a term</td>
+<td><code>argilla -distilabel</code> </br> returns records that contain the term "argilla" and don't have the term "distilabel"</td>
+</tr>
+<tr>
+<td><code>*</code></td>
+<td><strong>Prefix</strong>: search a prefix</td>
+<td><code>arg*</code></br> returns records with any words starting with "arg-"</td>
+</tr>
+<tr>
+<td><code>"</code></td>
+<td><strong>Phrase</strong>: search a phrase</td>
+<td><code>"argilla and distilabel"</code> </br> returns records that contain the phrase "argilla and distilabel"</td>
+</tr>
+<tr>
+<td><code>(</code> and <code>)</code></td>
+<td><strong>Precedence</strong>: group terms</td>
+<td><code>(argilla | distilabel) rules</code> </br> returns records that contain either "argilla" or "distilabel" and "rules"</td>
+</tr>
+<tr>
+<td><code>~N</code></td>
+<td><strong>Edit distance</strong>: search a term or phrase with an edit distance</td>
+<td><code>argilla~1</code> </br> returns records that contain the term "argilla" with an edit distance of 1, e.g. "argila"</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>To use one of these characters literally, escape it with a preceding backslash <code>\</code>, e.g. <code>"1 \+ 2"</code> would match records where the phrase "1 + 2" is found.</p>
+</div>
 <h2 id="filter-by-conditions">Filter by conditions<a class="headerlink" href="#filter-by-conditions" title="Permanent link">&para;</a></h2>
 <p>You can use the <code>Filter</code> class to define the conditions and pass them to the <code>Dataset.records</code> attribute to fetch records based on the conditions. Conditions include "==", "&gt;=", "&lt;=", or "in". Conditions can be combined with dot notation to filter records based on metadata, suggestions, or responses. You can use a single condition or multiple conditions to filter records.</p>
 <table>
@@ -2269,7 +2351,7 @@ <h2 id="filter-by-conditions">Filter by conditions<a class="headerlink" href="#f
 </tr>
 <tr>
 <td><code>in</code></td>
-<td>TThe <code>field</code> value is included in a list of values</td>
+<td>The <code>field</code> value is included in a list of values</td>
 </tr>
 </tbody>
 </table>

diff --git a/dev/search/search_index.json b/dev/search/search_index.json