GraphRAGPipeline

<p>Complete GraphRAG processing pipeline</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

GraphRAGPipeline function

<p><div class="r6-fields"></div></p><dl>
<dt><code>config</code></dt>
<dd><p>GraphRAGConfig</p></dd><p></p><p>
<dt><code>graph</code></dt>
<dd><p>KnowledgeGraph</p></dd></p><p>
<dt><code>communities</code></dt>
<dd><p>Detected communities</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/GraphRAGPipeline%24new()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::GraphRAGPipeline$new()"><code>GraphRAGPipeline$new()</code></a></p></li>
<li><p><a href="/link/GraphRAGPipeline%24process()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::GraphRAGPipeline$process()"><code>GraphRAGPipeline$process()</code></a></p></li>
<li><p><a href="/link/GraphRAGPipeline%24search()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::GraphRAGPipeline$search()"><code>GraphRAGPipeline$search()</code></a></p></li>
<li><p><a href="/link/GraphRAGPipeline%24stats()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::GraphRAGPipeline$stats()"><code>GraphRAGPipeline$stats()</code></a></p></li>
<li><p><a href="/link/GraphRAGPipeline%24clone()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::GraphRAGPipeline$clone()"><code>GraphRAGPipeline$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-GraphRAGPipeline-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new GraphRAGPipeline</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GraphRAGPipeline$new(config = 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>config</code></dt>
<dd><p>GraphRAGConfig</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-GraphRAGPipeline-process"></a></p><div class="section" id="method-process-">
<h3>Method <code>process()</code></h3>
<p>Process documents</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GraphRAGPipeline$process(texts, document_ids = 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>texts</code></dt>
<dd><p>Character vector of documents</p></dd></dl></div></p><p>
<dt><code>document_ids</code></dt>
<dd><p>Document IDs</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>Self</p>
</div><p></p><p></p><p><hr>
<a id="method-GraphRAGPipeline-search"></a></p><div class="section" id="method-search-">
<h3>Method <code><a href="/link/search()?package=VectrixDB&version=1.1.2" data-mini-rdoc="VectrixDB::search()">search()</a></code></h3>
<p>Search the graph</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GraphRAGPipeline$search(query, search_type = 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>query</code></dt>
<dd><p>Query string</p></dd></dl></div></p><p>
<dt><code>search_type</code></dt>
<dd><p>"local", "global", or "hybrid"</p></dd></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>Search result</p>
</div><p></p><p></p><p><hr>
<a id="method-GraphRAGPipeline-stats"></a></p><div class="section" id="method-stats-">
<h3>Method <code>stats()</code></h3>
<p>Get statistics</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>GraphRAGPipeline$stats()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Named list</p>
</div></p><p></p><p><hr>
<a id="method-GraphRAGPipeline-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>GraphRAGPipeline$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

GraphRAG Pipeline — GraphRAGPipeline

<p><div class="r6-fields"></p><dl>
<dt><code>config</code></dt>
<dd><p>GraphRAGConfig</p></dd>


<dt><code>graph</code></dt>
<dd><p>KnowledgeGraph</p></dd>


<dt><code>communities</code></dt>
<dd><p>Detected communities</p></dd>


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


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

<ul>
<li><p><a href='#method-GraphRAGPipeline-new'><code>GraphRAGPipeline$new()</code></a></p></li>
<li><p><a href='#method-GraphRAGPipeline-process'><code>GraphRAGPipeline$process()</code></a></p></li>
<li><p><a href='#method-GraphRAGPipeline-search'><code>GraphRAGPipeline$search()</code></a></p></li>
<li><p><a href='#method-GraphRAGPipeline-stats'><code>GraphRAGPipeline$stats()</code></a></p></li>
<li><p><a href='#method-GraphRAGPipeline-clone'><code>GraphRAGPipeline$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-GraphRAGPipeline-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new GraphRAGPipeline</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GraphRAGPipeline$new(config = NULL)</code></pre><p></div></p>
</div>

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


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

</div><p><hr>
<a id="method-GraphRAGPipeline-process"></a></p><div class='section' id='method-process-'>
<h3>Method <code>process()</code></h3>
<p>Process documents</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GraphRAGPipeline$process(texts, document_ids = NULL)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>texts</code></dt>
<dd><p>Character vector of documents</p></dd>


<dt><code>document_ids</code></dt>
<dd><p>Document IDs</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>Self</p>
</div>

</div><p><hr>
<a id="method-GraphRAGPipeline-search"></a></p><div class='section' id='method-search-'>
<h3>Method <code><a href='https://rdrr.io/r/base/search.html'>search()</a></code></h3>
<p>Search the graph</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GraphRAGPipeline$search(query, search_type = NULL)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>query</code></dt>
<dd><p>Query string</p></dd>


<dt><code>search_type</code></dt>
<dd><p>"local", "global", or "hybrid"</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>Search result</p>
</div>

</div><p><hr>
<a id="method-GraphRAGPipeline-stats"></a></p><div class='section' id='method-stats-'>
<h3>Method <code>stats()</code></h3>
<p>Get statistics</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>GraphRAGPipeline$stats()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Named list</p>
</div>

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


GraphRAGPipeline: GraphRAG Pipeline

Description

Arguments

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `process()`

Usage

Arguments

Returns

Method `search()`

Usage

Arguments

Returns

Method `stats()`

Usage

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method process()

Usage

Arguments

Returns

Method search()

Usage

Arguments

Returns

Method stats()

Usage

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `process()`

Method `search()`

Method `stats()`

Method `clone()`