EnhancedSearchResults

<p>Search results with enterprise features</p>

A lightweight vector database for text retrieval in R with embedded
machine learning models and no external API (Application Programming
Interface) keys. Supports dense and hybrid search, optional HNSW
(Hierarchical Navigable Small World) approximate nearest-neighbor indexing,
faceted filters with ACL (Access Control List) metadata, command-line
tools, and a local dashboard built with 'shiny'. The HNSW method is
described by Malkov and Yashunin (2018) <doi:10.1109/TPAMI.2018.2889473>.

Kwadwo Daddy Nyame Owusu Boakye

VectrixDB

Lightweight Vector Database with Embedded Machine Learning
Models

EnhancedSearchResults function

<p><div class="r6-fields"></div></p><dl>
<dt><code>results</code></dt>
<dd><p>List of result items</p></dd><p></p><p>
<dt><code>facets</code></dt>
<dd><p>Named list of FacetResult objects</p></dd></p><p>
<dt><code>total_count</code></dt>
<dd><p>Total results before filtering</p></dd></p><p>
<dt><code>filtered_count</code></dt>
<dd><p>Results after ACL filtering</p></dd></p><p>
<dt><code>query_time_ms</code></dt>
<dd><p>Query time in milliseconds</p></dd></p><p>
<dt><code>rerank_time_ms</code></dt>
<dd><p>Rerank time in milliseconds</p></dd></p><p>
<dt><code>facet_time_ms</code></dt>
<dd><p>Facet time in milliseconds</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/EnhancedSearchResults%24new()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::EnhancedSearchResults$new()"><code>EnhancedSearchResults$new()</code></a></p></li>
<li><p><a href="/link/EnhancedSearchResults%24to_list()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::EnhancedSearchResults$to_list()"><code>EnhancedSearchResults$to_list()</code></a></p></li>
<li><p><a href="/link/EnhancedSearchResults%24clone()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::EnhancedSearchResults$clone()"><code>EnhancedSearchResults$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-EnhancedSearchResults-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create new EnhancedSearchResults</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>EnhancedSearchResults$new(
  results,
  facets = list(),
  total_count = 0,
  filtered_count = 0,
  query_time_ms = 0,
  rerank_time_ms = 0,
  facet_time_ms = 0
)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>results</code></dt>
<dd><p>List of results</p></dd></dl></div></p><p>
<dt><code>facets</code></dt>
<dd><p>Named list of FacetResult</p></dd></p><p>
<dt><code>total_count</code></dt>
<dd><p>Total count</p></dd></p><p>
<dt><code>filtered_count</code></dt>
<dd><p>Filtered count</p></dd></p><p>
<dt><code>query_time_ms</code></dt>
<dd><p>Query time</p></dd></p><p>
<dt><code>rerank_time_ms</code></dt>
<dd><p>Rerank time</p></dd></p><p>
<dt><code>facet_time_ms</code></dt>
<dd><p>Facet time</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-EnhancedSearchResults-to_list"></a></p><div class="section" id="method-to-list-">
<h3>Method <code>to_list()</code></h3>
<p>Convert to list</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>EnhancedSearchResults$to_list()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>List representation</p>
</div></p><p></p><p><hr>
<a id="method-EnhancedSearchResults-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>EnhancedSearchResults$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Enhanced Search Results — EnhancedSearchResults

<p><div class="r6-fields"></p><dl>
<dt><code>results</code></dt>
<dd><p>List of result items</p></dd>


<dt><code>facets</code></dt>
<dd><p>Named list of FacetResult objects</p></dd>


<dt><code>total_count</code></dt>
<dd><p>Total results before filtering</p></dd>


<dt><code>filtered_count</code></dt>
<dd><p>Results after ACL filtering</p></dd>


<dt><code>query_time_ms</code></dt>
<dd><p>Query time in milliseconds</p></dd>


<dt><code>rerank_time_ms</code></dt>
<dd><p>Rerank time in milliseconds</p></dd>


<dt><code>facet_time_ms</code></dt>
<dd><p>Facet time in milliseconds</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-EnhancedSearchResults-new'><code>EnhancedSearchResults$new()</code></a></p></li>
<li><p><a href='#method-EnhancedSearchResults-to_list'><code>EnhancedSearchResults$to_list()</code></a></p></li>
<li><p><a href='#method-EnhancedSearchResults-clone'><code>EnhancedSearchResults$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-EnhancedSearchResults-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create new EnhancedSearchResults</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>EnhancedSearchResults$new(
  results,
  facets = list(),
  total_count = 0,
  filtered_count = 0,
  query_time_ms = 0,
  rerank_time_ms = 0,
  facet_time_ms = 0
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>results</code></dt>
<dd><p>List of results</p></dd>


<dt><code>facets</code></dt>
<dd><p>Named list of FacetResult</p></dd>


<dt><code>total_count</code></dt>
<dd><p>Total count</p></dd>


<dt><code>filtered_count</code></dt>
<dd><p>Filtered count</p></dd>


<dt><code>query_time_ms</code></dt>
<dd><p>Query time</p></dd>


<dt><code>rerank_time_ms</code></dt>
<dd><p>Rerank time</p></dd>


<dt><code>facet_time_ms</code></dt>
<dd><p>Facet time</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-EnhancedSearchResults-to_list"></a></p><div class='section' id='method-to-list-'>
<h3>Method <code>to_list()</code></h3>
<p>Convert to list</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>EnhancedSearchResults$to_list()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>List representation</p>
</div>

</div><p><hr>
<a id="method-EnhancedSearchResults-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>EnhancedSearchResults$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


EnhancedSearchResults: Enhanced Search Results

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `to_list()`

Usage

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method to_list()

Usage

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `to_list()`

Method `clone()`