Entity

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

Entity function

<p><div class="r6-fields"></div></p><dl>
<dt><code>id</code></dt>
<dd><p>Unique identifier</p></dd><p></p><p>
<dt><code>name</code></dt>
<dd><p>Entity name</p></dd></p><p>
<dt><code>type</code></dt>
<dd><p>Entity type</p></dd></p><p>
<dt><code>description</code></dt>
<dd><p>Description</p></dd></p><p>
<dt><code>source_chunks</code></dt>
<dd><p>Source chunk IDs</p></dd></p><p>
<dt><code>embedding</code></dt>
<dd><p>Vector embedding</p></dd></p><p>
<dt><code>metadata</code></dt>
<dd><p>Additional metadata</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/Entity%24new()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::Entity$new()"><code>Entity$new()</code></a></p></li>
<li><p><a href="/link/Entity%24to_list()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::Entity$to_list()"><code>Entity$to_list()</code></a></p></li>
<li><p><a href="/link/Entity%24clone()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::Entity$clone()"><code>Entity$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Entity-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new Entity</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Entity$new(
  id = NULL,
  name,
  type,
  description = NULL,
  source_chunks = NULL,
  embedding = NULL,
  metadata = NULL
)</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>id</code></dt>
<dd><p>Unique ID</p></dd></dl></div></p><p>
<dt><code>name</code></dt>
<dd><p>Name</p></dd></p><p>
<dt><code>type</code></dt>
<dd><p>Type</p></dd></p><p>
<dt><code>description</code></dt>
<dd><p>Description</p></dd></p><p>
<dt><code>source_chunks</code></dt>
<dd><p>Sources</p></dd></p><p>
<dt><code>embedding</code></dt>
<dd><p>Vector</p></dd></p><p>
<dt><code>metadata</code></dt>
<dd><p>Metadata</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-Entity-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>Entity$to_list()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Entity-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>Entity$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

Entity — Entity

<p><div class="r6-fields"></p><dl>
<dt><code>id</code></dt>
<dd><p>Unique identifier</p></dd>


<dt><code>name</code></dt>
<dd><p>Entity name</p></dd>


<dt><code>type</code></dt>
<dd><p>Entity type</p></dd>


<dt><code>description</code></dt>
<dd><p>Description</p></dd>


<dt><code>source_chunks</code></dt>
<dd><p>Source chunk IDs</p></dd>


<dt><code>embedding</code></dt>
<dd><p>Vector embedding</p></dd>


<dt><code>metadata</code></dt>
<dd><p>Additional metadata</p></dd>


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


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

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

</div><p><hr>
<a id="method-Entity-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new Entity</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Entity$new(
  id = NULL,
  name,
  type,
  description = NULL,
  source_chunks = NULL,
  embedding = NULL,
  metadata = NULL
)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>id</code></dt>
<dd><p>Unique ID</p></dd>


<dt><code>name</code></dt>
<dd><p>Name</p></dd>


<dt><code>type</code></dt>
<dd><p>Type</p></dd>


<dt><code>description</code></dt>
<dd><p>Description</p></dd>


<dt><code>source_chunks</code></dt>
<dd><p>Sources</p></dd>


<dt><code>embedding</code></dt>
<dd><p>Vector</p></dd>


<dt><code>metadata</code></dt>
<dd><p>Metadata</p></dd>


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

</div><p><hr>
<a id="method-Entity-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>Entity$to_list()</code></pre><p></div></p>
</div>


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


Entity: Entity

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `to_list()`

Usage

Method `clone()`

Usage

Arguments

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method to_list()

Usage

Method clone()

Usage

Arguments

Method `new()`

Method `to_list()`

Method `clone()`