FacetConfig

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

FacetConfig function

<p><div class="r6-fields"></div></p><dl>
<dt><code>field</code></dt>
<dd><p>Field name to facet on</p></dd><p></p><p>
<dt><code>limit</code></dt>
<dd><p>Max values to return</p></dd></p><p>
<dt><code>min_count</code></dt>
<dd><p>Minimum count to include</p></dd></p><p>
<dt><code>sort_by</code></dt>
<dd><p>Sort by "count" or "value"</p></dd></p><p>
<dt><code>include_zero</code></dt>
<dd><p>Include zero-count values</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/FacetConfig%24new()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::FacetConfig$new()"><code>FacetConfig$new()</code></a></p></li>
<li><p><a href="/link/FacetConfig%24clone()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::FacetConfig$clone()"><code>FacetConfig$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-FacetConfig-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new FacetConfig</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>FacetConfig$new(
  field,
  limit = 10,
  min_count = 1,
  sort_by = "count",
  include_zero = 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>field</code></dt>
<dd><p>Field name</p></dd></dl></div></p><p>
<dt><code>limit</code></dt>
<dd><p>Max values (default: 10)</p></dd></p><p>
<dt><code>min_count</code></dt>
<dd><p>Min count (default: 1)</p></dd></p><p>
<dt><code>sort_by</code></dt>
<dd><p>Sort method (default: "count")</p></dd></p><p>
<dt><code>include_zero</code></dt>
<dd><p>Include zeros (default: FALSE)</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-FacetConfig-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>FacetConfig$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

Facet Configuration — FacetConfig

<p><div class="r6-fields"></p><dl>
<dt><code>field</code></dt>
<dd><p>Field name to facet on</p></dd>


<dt><code>limit</code></dt>
<dd><p>Max values to return</p></dd>


<dt><code>min_count</code></dt>
<dd><p>Minimum count to include</p></dd>


<dt><code>sort_by</code></dt>
<dd><p>Sort by "count" or "value"</p></dd>


<dt><code>include_zero</code></dt>
<dd><p>Include zero-count values</p></dd>


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


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

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

</div><p><hr>
<a id="method-FacetConfig-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new FacetConfig</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>FacetConfig$new(
  field,
  limit = 10,
  min_count = 1,
  sort_by = "count",
  include_zero = FALSE
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>field</code></dt>
<dd><p>Field name</p></dd>


<dt><code>limit</code></dt>
<dd><p>Max values (default: 10)</p></dd>


<dt><code>min_count</code></dt>
<dd><p>Min count (default: 1)</p></dd>


<dt><code>sort_by</code></dt>
<dd><p>Sort method (default: "count")</p></dd>


<dt><code>include_zero</code></dt>
<dd><p>Include zeros (default: FALSE)</p></dd>


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

</div><p><hr>
<a id="method-FacetConfig-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>FacetConfig$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>


FacetConfig: Facet Configuration

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `clone()`

Usage

Arguments

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method clone()

Usage

Arguments

Method `new()`

Method `clone()`