129 lines
No EOL
31 KiB
HTML
129 lines
No EOL
31 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-core-components/knowledge" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">OpenSearch in OpenRAG | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="robots" content="noindex, nofollow"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/knowledge"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="OpenSearch in OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG uses OpenSearch for its vector-backed knowledge store."><meta data-rh="true" property="og:description" content="OpenRAG uses OpenSearch for its vector-backed knowledge store."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/knowledge"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/knowledge" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"OpenSearch in OpenRAG","item":"https://docs.openr.ag/knowledge"}]}</script><link rel="stylesheet" href="/assets/css/styles.66669ecc.css">
|
||
<script src="/assets/js/runtime~main.503e7250.js" defer="defer"></script>
|
||
<script src="/assets/js/main.179a52a2.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/logo-openrag-light.svg"><link rel="preload" as="image" href="/img/logo-openrag-dark.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo-openrag-light.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo-openrag-dark.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/openrag" target="_blank" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="About OpenRAG" class="linkLabel_WmDU">About OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/quickstart"><span title="Quickstart" class="linkLabel_WmDU">Quickstart</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/install"><span title="Install OpenRAG with TUI" class="linkLabel_WmDU">Install OpenRAG with TUI</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docker"><span title="Install OpenRAG containers" class="linkLabel_WmDU">Install OpenRAG containers</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/agents"><span title="Langflow in OpenRAG" class="linkLabel_WmDU">Langflow in OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/knowledge"><span title="OpenSearch in OpenRAG" class="linkLabel_WmDU">OpenSearch in OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/ingestion"><span title="Docling in OpenRAG" class="linkLabel_WmDU">Docling in OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/reference/configuration"><span title="Environment variables" class="linkLabel_WmDU">Environment variables</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/support/troubleshoot"><span title="Troubleshoot OpenRAG" class="linkLabel_WmDU">Troubleshoot OpenRAG</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">OpenSearch in OpenRAG</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>OpenSearch in OpenRAG</h1></header><p>OpenRAG uses <a href="https://docs.opensearch.org/latest/" target="_blank" rel="noopener noreferrer" class="">OpenSearch</a> for its vector-backed knowledge store.
|
||
This is a specialized database for storing and retrieving embeddings, which helps your Agent efficiently find relevant information.
|
||
OpenSearch provides powerful hybrid search capabilities with enterprise-grade security and multi-tenancy support.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="auth">Authentication and document access<a href="#auth" class="hash-link" aria-label="Direct link to Authentication and document access" title="Direct link to Authentication and document access" translate="no"></a></h2>
|
||
<p>OpenRAG supports two authentication modes based on how you <a class="" href="/install">install OpenRAG</a>, and which mode you choose affects document access.</p>
|
||
<p><strong>No-auth mode (Basic Setup)</strong>: This mode uses a single anonymous JWT token for OpenSearch authentication, so documents uploaded to the <code>documents</code> index by one user are visible to all other users on the OpenRAG server.</p>
|
||
<p><strong>OAuth mode (Advanced Setup)</strong>: Each OpenRAG user is granted a JWT token, and each document is tagged with user ownership. Documents are filtered by user ownership, ensuring users only see documents they uploaded or have access to.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="ingest-knowledge">Ingest knowledge<a href="#ingest-knowledge" class="hash-link" aria-label="Direct link to Ingest knowledge" title="Direct link to Ingest knowledge" translate="no"></a></h2>
|
||
<p>OpenRAG supports knowledge ingestion through direct file uploads and OAuth connectors.
|
||
To configure the knowledge ingestion pipeline parameters, see <a class="" href="/ingestion">Docling Ingestion</a>.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="direct-file-ingestion">Direct file ingestion<a href="#direct-file-ingestion" class="hash-link" aria-label="Direct link to Direct file ingestion" title="Direct link to Direct file ingestion" translate="no"></a></h3>
|
||
<p>The <strong>Knowledge Ingest</strong> flow uses Langflow's <a href="https://docs.langflow.org/components-data#file" target="_blank" rel="noopener noreferrer" class=""><strong>File</strong> component</a> to split and embed files loaded from your local machine into the OpenSearch database.</p>
|
||
<p>The default path to your local folder is mounted from the <code>./documents</code> folder in your OpenRAG project directory to the <code>/app/documents/</code> directory inside the Docker container. Files added to the host or the container will be visible in both locations. To configure this location, modify the <strong>Documents Paths</strong> variable in either the TUI's <a class="" href="/install#setup">Advanced Setup</a> menu or in the <code>.env</code> used by Docker Compose.</p>
|
||
<p>To load and process a single file from the mapped location, click <strong>Add Knowledge</strong>, and then click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-file" aria-hidden="true"><path d="M15 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7Z"></path><path d="M14 2v4a2 2 0 0 0 2 2h4"></path></svg> <strong>File</strong>.
|
||
The file is loaded into your OpenSearch database, and appears in the Knowledge page.</p>
|
||
<p>To load and process a directory from the mapped location, click <strong>Add Knowledge</strong>, and then click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-folder" aria-hidden="true"><path d="M20 20a2 2 0 0 0 2-2V8a2 2 0 0 0-2-2h-7.9a2 2 0 0 1-1.69-.9L9.6 3.9A2 2 0 0 0 7.93 3H4a2 2 0 0 0-2 2v13a2 2 0 0 0 2 2Z"></path></svg> <strong>Folder</strong>.
|
||
The files are loaded into your OpenSearch database, and appear in the Knowledge page.</p>
|
||
<p>To add files directly to a chat session, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-plus" aria-hidden="true"><path d="M5 12h14"></path><path d="M12 5v14"></path></svg> in the chat input and select the files you want to include. Files added this way are processed and made available to the agent for the current conversation, and are not permanently added to the knowledge base.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="oauth-ingestion">Ingest files through OAuth connectors<a href="#oauth-ingestion" class="hash-link" aria-label="Direct link to Ingest files through OAuth connectors" title="Direct link to Ingest files through OAuth connectors" translate="no"></a></h3>
|
||
<p>OpenRAG supports Google Drive, OneDrive, and Sharepoint as OAuth connectors for seamless document synchronization.</p>
|
||
<p>OAuth integration allows individual users to connect their personal cloud storage accounts to OpenRAG. Each user must separately authorize OpenRAG to access their own cloud storage files. When a user connects a cloud service, they are redirected to authenticate with that service provider and grant OpenRAG permission to sync documents from their personal cloud storage.</p>
|
||
<p>Before users can connect their cloud storage accounts, you must configure OAuth credentials in OpenRAG. This requires registering OpenRAG as an OAuth application with a cloud provider and obtaining client ID and secret keys for each service you want to support.</p>
|
||
<p>To add an OAuth connector to OpenRAG, do the following.
|
||
This example uses Google OAuth.
|
||
If you wish to use another provider, add the secrets to another provider.</p>
|
||
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role="tablist" aria-orientation="horizontal" class="tabs"><li role="tab" tabindex="0" aria-selected="true" class="tabs__item tabItem_LNqP tabs__item--active">TUI</li><li role="tab" tabindex="-1" aria-selected="false" class="tabs__item tabItem_LNqP">.env</li></ul><div class="margin-top--md"><div role="tabpanel" class="tabItem_Ymn6"><ol>
|
||
<li class="">If OpenRAG is running, stop it with <strong>Status</strong> > <strong>Stop Services</strong>.</li>
|
||
<li class="">Click <strong>Advanced Setup</strong>.</li>
|
||
<li class="">Add the OAuth provider's client and secret key in the <a class="" href="/install#setup">Advanced Setup</a> menu.</li>
|
||
<li class="">Click <strong>Save Configuration</strong>.
|
||
The TUI generates a new <code>.env</code> file with your OAuth values.</li>
|
||
<li class="">Click <strong>Start Container Services</strong>.</li>
|
||
</ol></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><ol>
|
||
<li class="">Stop the Docker deployment.</li>
|
||
<li class="">Add the OAuth provider's client and secret key in the <code>.env</code> file for Docker Compose.<!-- -->
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">GOOGLE_OAUTH_CLIENT_ID='YOUR_OAUTH_CLIENT_ID'</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">GOOGLE_OAUTH_CLIENT_SECRET='YOUR_OAUTH_CLIENT_SECRET'</span><br></span></code></pre></div></div>
|
||
</li>
|
||
<li class="">Save your <code>.env</code> file.</li>
|
||
<li class="">Start the Docker deployment.</li>
|
||
</ol></div></div></div>
|
||
<p>The OpenRAG frontend at <code>http://localhost:3000</code> now redirects to an OAuth callback login page for your OAuth provider.
|
||
A successful authentication opens OpenRAG with the required scopes for your connected storage.</p>
|
||
<p>To add knowledge from an OAuth-connected storage provider, do the following:</p>
|
||
<ol>
|
||
<li class="">Click <strong>Add Knowledge</strong>, and then select the storage provider, for example, <strong>Google Drive</strong>.
|
||
The <strong>Add Cloud Knowledge</strong> page opens.</li>
|
||
<li class="">To add files or folders from the connected storage, click <strong>Add Files</strong>.
|
||
Select the files or folders you want and click <strong>Select</strong>.
|
||
You can select multiple files.</li>
|
||
<li class="">When your files are selected, click <strong>Ingest Files</strong>.
|
||
The ingestion process can take some time depending on the size of your documents.</li>
|
||
<li class="">When ingestion is complete, your documents are available in the Knowledge screen.</li>
|
||
</ol>
|
||
<p>If ingestion fails, click <strong>Status</strong> to view the logged error.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="monitor-ingestion-tasks">Monitor ingestion tasks<a href="#monitor-ingestion-tasks" class="hash-link" aria-label="Direct link to Monitor ingestion tasks" title="Direct link to Monitor ingestion tasks" translate="no"></a></h2>
|
||
<p>When you upload files, process folders, or sync documents, OpenRAG processes them as background tasks.
|
||
A badge appears on the <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-bell" aria-hidden="true"><path d="M10.268 21a2 2 0 0 0 3.464 0"></path><path d="M3.262 15.326A1 1 0 0 0 4 17h16a1 1 0 0 0 .74-1.673C19.41 13.956 18 12.499 18 8A6 6 0 0 0 6 8c0 4.499-1.411 5.956-2.738 7.326"></path></svg> <strong>Tasks</strong> icon when there are active tasks running.
|
||
To open the Tasks menu, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-bell" aria-hidden="true"><path d="M10.268 21a2 2 0 0 0 3.464 0"></path><path d="M3.262 15.326A1 1 0 0 0 4 17h16a1 1 0 0 0 .74-1.673C19.41 13.956 18 12.499 18 8A6 6 0 0 0 6 8c0 4.499-1.411 5.956-2.738 7.326"></path></svg> <strong>Tasks</strong>.</p>
|
||
<p><strong>Active Tasks</strong> shows tasks that are currently processing.
|
||
A <strong>Pending</strong> task is queued and waiting to start, a <strong>Running</strong> task is actively processing files, and a <strong>Processing</strong> task is performing ingestion operations. For each active task, you can find the task ID, start time, duration, the number of files processed so far, and the total files.</p>
|
||
<p>You can cancel active tasks by clicking <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-x" aria-hidden="true"><path d="M18 6 6 18"></path><path d="m6 6 12 12"></path></svg> <strong>Cancel</strong>. Canceling a task stops processing immediately and marks the task as failed.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="explore-knowledge">Explore knowledge<a href="#explore-knowledge" class="hash-link" aria-label="Direct link to Explore knowledge" title="Direct link to Explore knowledge" translate="no"></a></h2>
|
||
<p>The <strong>Knowledge</strong> page lists the documents OpenRAG has ingested into the OpenSearch vector database's <code>documents</code> index.</p>
|
||
<p>To explore your current knowledge, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-library" aria-hidden="true"><path d="m16 6 4 14"></path><path d="M12 6v14"></path><path d="M8 8v12"></path><path d="M4 4v16"></path></svg> <strong>Knowledge</strong>.
|
||
Click on a document to display the chunks derived from splitting the default documents into the vector database.</p>
|
||
<p>Documents are processed with the default <strong>Knowledge Ingest</strong> flow, so if you want to split your documents differently, edit the <strong>Knowledge Ingest</strong> flow.</p>
|
||
<p>All flows included with OpenRAG are designed to be modular, performant, and provider-agnostic.
|
||
To modify a flow, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-settings2 lucide-settings-2" aria-hidden="true"><path d="M14 17H5"></path><path d="M19 7h-9"></path><circle cx="17" cy="17" r="3"></circle><circle cx="7" cy="7" r="3"></circle></svg> <strong>Settings</strong>, and click <strong>Edit in Langflow</strong>.
|
||
OpenRAG's visual editor is based on the <a href="https://docs.langflow.org/concepts-overview" target="_blank" rel="noopener noreferrer" class="">Langflow visual editor</a>, so you can edit your flows to match your specific use case.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="create-knowledge-filters">Create knowledge filters<a href="#create-knowledge-filters" class="hash-link" aria-label="Direct link to Create knowledge filters" title="Direct link to Create knowledge filters" translate="no"></a></h2>
|
||
<p>OpenRAG includes a knowledge filter system for organizing and managing document collections.
|
||
Knowledge filters are saved search configurations that allow you to create custom views of your document collection. They store search queries, filter criteria, and display settings that can be reused across different parts of OpenRAG.</p>
|
||
<p>Knowledge filters help agents work more efficiently with large document collections by focusing their context within relevant documents sets.</p>
|
||
<p>To create a knowledge filter, do the following:</p>
|
||
<ol>
|
||
<li class="">
|
||
<p>Click <strong>Knowledge</strong>, and then click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-plus" aria-hidden="true"><path d="M5 12h14"></path><path d="M12 5v14"></path></svg> <strong>Knowledge Filters</strong>.
|
||
The <strong>Knowledge Filter</strong> pane appears.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Enter a <strong>Name</strong> and <strong>Description</strong>, and then click <strong>Create Filter</strong>.
|
||
A new filter is created with default settings that match all documents.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>To modify the filter, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-library" aria-hidden="true"><path d="m16 6 4 14"></path><path d="M12 6v14"></path><path d="M8 8v12"></path><path d="M4 4v16"></path></svg> <strong>Knowledge</strong>, and then click your new filter to edit it in the <strong>Knowledge Filter</strong> pane.</p>
|
||
<p>The following filter options are configurable.</p>
|
||
<ul>
|
||
<li class=""><strong>Search Query</strong>: Enter text for semantic search, such as "financial reports from Q4".</li>
|
||
<li class=""><strong>Data Sources</strong>: Select specific data sources or folders to include.</li>
|
||
<li class=""><strong>Document Types</strong>: Filter by file type.</li>
|
||
<li class=""><strong>Owners</strong>: Filter by who uploaded the documents.</li>
|
||
<li class=""><strong>Connectors</strong>: Filter by connector types, such as local upload or Google Drive.</li>
|
||
<li class=""><strong>Response Limit</strong>: Set maximum number of results. The default is <code>10</code>.</li>
|
||
<li class=""><strong>Score Threshold</strong>: Set minimum relevance score. The default score is <code>0</code>.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>When you're done editing the filter, click <strong>Update Filter</strong>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>To apply the filter to OpenRAG globally, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-library" aria-hidden="true"><path d="m16 6 4 14"></path><path d="M12 6v14"></path><path d="M8 8v12"></path><path d="M4 4v16"></path></svg> <strong>Knowledge</strong>, and then select the filter to apply. One filter can be enabled at a time.</p>
|
||
<p>To apply the filter to a single chat session, in the <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-message-square" aria-hidden="true"><path d="M22 17a2 2 0 0 1-2 2H6.828a2 2 0 0 0-1.414.586l-2.202 2.202A.71.71 0 0 1 2 21.286V5a2 2 0 0 1 2-2h16a2 2 0 0 1 2 2z"></path></svg> <strong>Chat</strong> window, click <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-funnel" aria-hidden="true"><path d="M10 20a1 1 0 0 0 .553.895l2 1A1 1 0 0 0 14 21v-7a2 2 0 0 1 .517-1.341L21.74 4.67A1 1 0 0 0 21 3H3a1 1 0 0 0-.742 1.67l7.225 7.989A2 2 0 0 1 10 14z"></path></svg>, and then select the filter to apply.</p>
|
||
<p>To delete the filter, in the <strong>Knowledge Filter</strong> pane, click <strong>Delete Filter</strong>.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="openrag-default-configuration">OpenRAG default configuration<a href="#openrag-default-configuration" class="hash-link" aria-label="Direct link to OpenRAG default configuration" title="Direct link to OpenRAG default configuration" translate="no"></a></h2>
|
||
<p>OpenRAG automatically detects and configures the correct vector dimensions for embedding models, ensuring optimal search performance and compatibility.</p>
|
||
<p>The complete list of supported models is available at <a href="https://github.com/langflow-ai/openrag/blob/main/src/services/models_service.py" target="_blank" rel="noopener noreferrer" class=""><code>models_service.py</code> in the OpenRAG repository</a>.</p>
|
||
<p>You can use custom embedding models by specifying them in your configuration.</p>
|
||
<p>If you use an unknown embedding model, OpenRAG automatically falls back to <code>1536</code> dimensions and logs a warning. The system continues to work, but search quality can be affected if the actual model dimensions differ from <code>1536</code>.</p>
|
||
<p>The default embedding dimension is <code>1536</code> and the default model is <code>text-embedding-3-small</code>.</p>
|
||
<p>For models with known vector dimensions, see <a href="https://github.com/langflow-ai/openrag/blob/main/src/config/settings.py" target="_blank" rel="noopener noreferrer" class=""><code>settings.py</code> in the OpenRAG repository</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/core-components/knowledge.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/agents"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Langflow in OpenRAG</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/ingestion"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Docling in OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#auth" class="table-of-contents__link toc-highlight">Authentication and document access</a></li><li><a href="#ingest-knowledge" class="table-of-contents__link toc-highlight">Ingest knowledge</a><ul><li><a href="#direct-file-ingestion" class="table-of-contents__link toc-highlight">Direct file ingestion</a></li><li><a href="#oauth-ingestion" class="table-of-contents__link toc-highlight">Ingest files through OAuth connectors</a></li></ul></li><li><a href="#monitor-ingestion-tasks" class="table-of-contents__link toc-highlight">Monitor ingestion tasks</a></li><li><a href="#explore-knowledge" class="table-of-contents__link toc-highlight">Explore knowledge</a></li><li><a href="#create-knowledge-filters" class="table-of-contents__link toc-highlight">Create knowledge filters</a></li><li><a href="#openrag-default-configuration" class="table-of-contents__link toc-highlight">OpenRAG default configuration</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||
<span>© 2025 OpenRAG</span>
|
||
</div></li></ul></div></div></div></footer></div>
|
||
</body>
|
||
</html> |