deploy: a4a8331d8c
This commit is contained in:
mendonk
parent
b6c9cf96e5
commit
add1396c67
22 changed files with 48 additions and 26 deletions
2
404.html
2
404.html
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">OpenRAG</title><meta data-rh="true" property="og:title" content="OpenRAG"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/404.html"><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"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/404.html"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/404.html" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Langflow Agents | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/agents"><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="Langflow Agents | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow."><meta data-rh="true" property="og:description" content="OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/agents"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/agents" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Langflow Agents","item":"https://docs.openr.ag/agents"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -16,13 +16,13 @@ Development is ongoing, and the features and functionality are subject to change
|
|||
<p>OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow.</p>
|
||||
<p><a href="https://docs.langflow.org/concepts-overview" target="_blank" rel="noopener noreferrer">Flows</a> in Langflow are functional representations of application workflows, with multiple <a href="https://docs.langflow.org/concepts-components" target="_blank" rel="noopener noreferrer">component</a> nodes connected as single steps in a workflow.</p>
|
||||
<p>In the OpenRAG OpenSearch Agent flow, components like the Langflow <a href="https://docs.langflow.org/agents" target="_blank" rel="noopener noreferrer"><strong>Agent</strong> component</a> and <a href="https://docs.langflow.org/bundles-elastic#opensearch" target="_blank" rel="noopener noreferrer"><strong>OpenSearch</strong> component</a> are connected to intelligently chat with your knowledge by embedding your query, comparing it the vector database embeddings, and generating a response with the LLM.</p>
|
||||
<p><img decoding="async" loading="lazy" alt="OpenRAG Open Search Agent Flow" src="/assets/images/opensearch-agent-flow-a3c183a9f2d5ec513819aba1f1b49c39.png" width="4108" height="2250" class="img_ev3q"></p>
|
||||
<p><img decoding="async" loading="lazy" alt="OpenRAG Open Search Agent Flow" src="/assets/images/opensearch-agent-flow-a759d00657f2fdb62e64c84c643e8896.png" width="4086" height="2240" class="img_ev3q"></p>
|
||||
<p>The Agent component shines here in its ability to make decisions on not only what query should be sent, but when a query is necessary to solve the problem at hand.</p>
|
||||
<details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>How do agents work?</summary><div><div class="collapsibleContent_i85q"><p>Agents extend Large Language Models (LLMs) by integrating tools, which are functions that provide additional context and enable autonomous task execution. These integrations make agents more specialized and powerful than standalone LLMs.</p><p>Whereas an LLM might generate acceptable, inert responses to general queries and tasks, an agent can leverage the integrated context and tools to provide more relevant responses and even take action. For example, you might create an agent that can access your company's documentation, repositories, and other resources to help your team with tasks that require knowledge of your specific products, customers, and code.</p><p>Agents use LLMs as a reasoning engine to process input, determine which actions to take to address the query, and then generate a response. The response could be a typical text-based LLM response, or it could involve an action, like editing a file, running a script, or calling an external API.</p><p>In an agentic context, tools are functions that the agent can run to perform tasks or access external resources. A function is wrapped as a Tool object with a common interface that the agent understands. Agents become aware of tools through tool registration, which is when the agent is provided a list of available tools typically at agent initialization. The Tool object's description tells the agent what the tool can do so that it can decide whether the tool is appropriate for a given request.</p></div></div></details>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="use-the-openrag-opensearch-agent-flow">Use the OpenRAG OpenSearch Agent flow<a href="#use-the-openrag-opensearch-agent-flow" class="hash-link" aria-label="Direct link to Use the OpenRAG OpenSearch Agent flow" title="Direct link to Use the OpenRAG OpenSearch Agent flow"></a></h2>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="flow">Use the OpenRAG OpenSearch Agent flow<a href="#flow" class="hash-link" aria-label="Direct link to Use the OpenRAG OpenSearch Agent flow" title="Direct link to Use the OpenRAG OpenSearch Agent flow"></a></h2>
|
||||
<p>If you've chatted with your knowledge in OpenRAG, you've already experienced the OpenRAG OpenSearch Agent chat flow.
|
||||
To switch OpenRAG over to the <a href="https://docs.langflow.org/concepts-overview" target="_blank" rel="noopener noreferrer">Langflow visual editor</a> and view the OpenRAG OpenSearch Agentflow, 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 then click <strong>Edit in Langflow</strong>.
|
||||
This flow contains seven components connected together to chat with your data:</p>
|
||||
This flow contains eight components connected together to chat with your data:</p>
|
||||
<ul>
|
||||
<li>The <a href="https://docs.langflow.org/agents" target="_blank" rel="noopener noreferrer"><strong>Agent</strong> component</a> orchestrates the entire flow by deciding when to search the knowledge base, how to formulate search queries, and how to combine retrieved information with the user's question to generate a comprehensive response.
|
||||
The <strong>Agent</strong> behaves according to the prompt in the <strong>Agent Instructions</strong> field.</li>
|
||||
|
|
@ -33,6 +33,7 @@ The <strong>Agent</strong> behaves according to the prompt in the <strong>Agent
|
|||
<li>The <a href="https://docs.langflow.org/components-io" target="_blank" rel="noopener noreferrer"><strong>Text Input</strong> component</a> is populated with the global variable <code>OPENRAG-QUERY-FILTER</code>.
|
||||
This filter is the <a href="/knowledge#create-knowledge-filters">Knowledge filter</a>, and filters which knowledge sources to search through.</li>
|
||||
<li>The <strong>Agent</strong> component's Output port is connected to the <a href="https://docs.langflow.org/components-io" target="_blank" rel="noopener noreferrer"><strong>Chat Output</strong> component</a>, which returns the final response to the user or application.</li>
|
||||
<li>An <a href="https://docs.langflow.org/mcp-client" target="_blank" rel="noopener noreferrer"><strong>MCP Tools</strong> component</a> is connected to the Agent's <strong>Tools</strong> port. This component calls the <a href="/ingestion#url-flow">OpenSearch URL Ingestion flow</a>, which Langflow uses as an MCP server to fetch content from URLs and store in OpenSearch.</li>
|
||||
</ul>
|
||||
<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>.
|
||||
|
|
@ -52,7 +53,7 @@ OpenRAG warns you that this discards all custom settings. Click <strong>Restore<
|
|||
<li>
|
||||
<p>Langflow offers component <a href="https://docs.langflow.org/components-bundle-components" target="_blank" rel="noopener noreferrer">bundles</a> to integrate with many popular vector stores, AI/ML providers, and search APIs.</p>
|
||||
</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/core-components/agents.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="/get-started/tui"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Terminal User Interface (TUI)</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/knowledge"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">OpenSearch Knowledge</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="#use-the-openrag-opensearch-agent-flow" class="table-of-contents__link toc-highlight">Use the OpenRAG OpenSearch Agent flow</a></li><li><a href="#additional-langflow-functionality" class="table-of-contents__link toc-highlight">Additional Langflow functionality</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">
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/core-components/agents.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="/get-started/tui"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Terminal User Interface (TUI)</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/knowledge"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">OpenSearch Knowledge</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="#flow" class="table-of-contents__link toc-highlight">Use the OpenRAG OpenSearch Agent flow</a></li><li><a href="#additional-langflow-functionality" class="table-of-contents__link toc-highlight">Additional Langflow functionality</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>
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 951 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1,004 KiB |
File diff suppressed because one or more lines are too long
1
assets/js/0ba6a408.8ade4b0f.js
Normal file
1
assets/js/0ba6a408.8ade4b0f.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
assets/js/33362219.e124ffd1.js
Normal file
1
assets/js/33362219.e124ffd1.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
assets/js/ca2c3c0c.956b2d03.js
Normal file
1
assets/js/ca2c3c0c.956b2d03.js
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -1 +1 @@
|
|||
(()=>{"use strict";var e,t,r,a,o,n={},c={};function f(e){var t=c[e];if(void 0!==t)return t.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,f),r.loaded=!0,r.exports}f.m=n,f.c=c,e=[],f.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u<e.length;u++){r=e[u][0],a=e[u][1],o=e[u][2];for(var c=!0,d=0;d<r.length;d++)(!1&o||n>=o)&&Object.keys(f.O).every(e=>f.O[e](r[d]))?r.splice(d--,1):(c=!1,o<n&&(n=o));if(c){e.splice(u--,1);var i=a();void 0!==i&&(t=i)}}return t}o=o||0;for(var u=e.length;u>0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},f.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return f.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,f.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);f.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var c=2&a&&e;("object"==typeof c||"function"==typeof c)&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach(t=>n[t]=()=>e[t]);return n.default=()=>e,f.d(o,n),o},f.d=(e,t)=>{for(var r in t)f.o(t,r)&&!f.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},f.f={},f.e=e=>Promise.all(Object.keys(f.f).reduce((t,r)=>(f.f[r](e,t),t),[])),f.u=e=>"assets/js/"+({26:"c8078f0a",48:"a94703ab",98:"a7bd4aaa",172:"e633a5ea",272:"749371cc",401:"17896441",532:"33362219",567:"22dd74f7",571:"0ba6a408",647:"5e95c892",668:"eb5b356a",717:"af920ffe",742:"aba21aa0",750:"d0314b07",919:"ca2c3c0c",961:"21afe7ac"}[e]||e)+"."+{26:"b5cf5e75",48:"37079d87",98:"5b195d0f",172:"e372590c",237:"4f1a14e7",272:"7ba8f9a8",401:"3584c216",532:"8aeb5835",567:"5a552cfa",571:"143d35a8",647:"a118483c",668:"9a4c40f8",717:"d761f3d0",742:"ff196c6d",750:"e9b84520",758:"382c453d",919:"69c485a8",961:"c654afca"}[e]+".js",f.miniCssF=e=>{},f.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),f.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="openrag-docs:",f.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var c,d;if(void 0!==r)for(var i=document.getElementsByTagName("script"),u=0;u<i.length;u++){var l=i[u];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){c=l;break}}c||(d=!0,(c=document.createElement("script")).charset="utf-8",c.timeout=120,f.nc&&c.setAttribute("nonce",f.nc),c.setAttribute("data-webpack",o+r),c.src=e),a[e]=[t];var b=(t,r)=>{c.onerror=c.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach(e=>e(r)),t)return t(r)},s=setTimeout(b.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=b.bind(null,c.onerror),c.onload=b.bind(null,c.onload),d&&document.head.appendChild(c)}},f.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},f.p="/",f.gca=function(e){return e={17896441:"401",33362219:"532",c8078f0a:"26",a94703ab:"48",a7bd4aaa:"98",e633a5ea:"172","749371cc":"272","22dd74f7":"567","0ba6a408":"571","5e95c892":"647",eb5b356a:"668",af920ffe:"717",aba21aa0:"742",d0314b07:"750",ca2c3c0c:"919","21afe7ac":"961"}[e]||e,f.p+f.u(e)},(()=>{var e={354:0,869:0};f.f.j=(t,r)=>{var a=f.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(354|869)$/.test(t))e[t]=0;else{var o=new Promise((r,o)=>a=e[t]=[r,o]);r.push(a[2]=o);var n=f.p+f.u(t),c=new Error;f.l(n,r=>{if(f.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",c.name="ChunkLoadError",c.type=o,c.request=n,a[1](c)}},"chunk-"+t,t)}},f.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],c=r[1],d=r[2],i=0;if(n.some(t=>0!==e[t])){for(a in c)f.o(c,a)&&(f.m[a]=c[a]);if(d)var u=d(f)}for(t&&t(r);i<n.length;i++)o=n[i],f.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return f.O(u)},r=self.webpackChunkopenrag_docs=self.webpackChunkopenrag_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();
|
||||
(()=>{"use strict";var e,t,r,a,o,n={},c={};function f(e){var t=c[e];if(void 0!==t)return t.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,f),r.loaded=!0,r.exports}f.m=n,f.c=c,e=[],f.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u<e.length;u++){r=e[u][0],a=e[u][1],o=e[u][2];for(var c=!0,d=0;d<r.length;d++)(!1&o||n>=o)&&Object.keys(f.O).every(e=>f.O[e](r[d]))?r.splice(d--,1):(c=!1,o<n&&(n=o));if(c){e.splice(u--,1);var i=a();void 0!==i&&(t=i)}}return t}o=o||0;for(var u=e.length;u>0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},f.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return f.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,f.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);f.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var c=2&a&&e;("object"==typeof c||"function"==typeof c)&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach(t=>n[t]=()=>e[t]);return n.default=()=>e,f.d(o,n),o},f.d=(e,t)=>{for(var r in t)f.o(t,r)&&!f.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},f.f={},f.e=e=>Promise.all(Object.keys(f.f).reduce((t,r)=>(f.f[r](e,t),t),[])),f.u=e=>"assets/js/"+({26:"c8078f0a",48:"a94703ab",98:"a7bd4aaa",172:"e633a5ea",272:"749371cc",401:"17896441",532:"33362219",567:"22dd74f7",571:"0ba6a408",647:"5e95c892",668:"eb5b356a",717:"af920ffe",742:"aba21aa0",750:"d0314b07",919:"ca2c3c0c",961:"21afe7ac"}[e]||e)+"."+{26:"b5cf5e75",48:"37079d87",98:"5b195d0f",172:"e372590c",237:"4f1a14e7",272:"7ba8f9a8",401:"3584c216",532:"e124ffd1",567:"5a552cfa",571:"8ade4b0f",647:"a118483c",668:"9a4c40f8",717:"610d6519",742:"ff196c6d",750:"e9b84520",758:"382c453d",919:"956b2d03",961:"c654afca"}[e]+".js",f.miniCssF=e=>{},f.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),f.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="openrag-docs:",f.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var c,d;if(void 0!==r)for(var i=document.getElementsByTagName("script"),u=0;u<i.length;u++){var l=i[u];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){c=l;break}}c||(d=!0,(c=document.createElement("script")).charset="utf-8",c.timeout=120,f.nc&&c.setAttribute("nonce",f.nc),c.setAttribute("data-webpack",o+r),c.src=e),a[e]=[t];var s=(t,r)=>{c.onerror=c.onload=null,clearTimeout(b);var o=a[e];if(delete a[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach(e=>e(r)),t)return t(r)},b=setTimeout(s.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=s.bind(null,c.onerror),c.onload=s.bind(null,c.onload),d&&document.head.appendChild(c)}},f.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},f.p="/",f.gca=function(e){return e={17896441:"401",33362219:"532",c8078f0a:"26",a94703ab:"48",a7bd4aaa:"98",e633a5ea:"172","749371cc":"272","22dd74f7":"567","0ba6a408":"571","5e95c892":"647",eb5b356a:"668",af920ffe:"717",aba21aa0:"742",d0314b07:"750",ca2c3c0c:"919","21afe7ac":"961"}[e]||e,f.p+f.u(e)},(()=>{var e={354:0,869:0};f.f.j=(t,r)=>{var a=f.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(354|869)$/.test(t))e[t]=0;else{var o=new Promise((r,o)=>a=e[t]=[r,o]);r.push(a[2]=o);var n=f.p+f.u(t),c=new Error;f.l(n,r=>{if(f.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;c.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",c.name="ChunkLoadError",c.type=o,c.request=n,a[1](c)}},"chunk-"+t,t)}},f.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],c=r[1],d=r[2],i=0;if(n.some(t=>0!==e[t])){for(a in c)f.o(c,a)&&(f.m[a]=c[a]);if(d)var u=d(f)}for(t&&t(r);i<n.length;i++)o=n[i],f.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return f.O(u)},r=self.webpackChunkopenrag_docs=self.webpackChunkopenrag_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Deploy with Docker | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/get-started/docker"><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="Deploy with Docker | OpenRAG"><meta data-rh="true" name="description" content="There are two different Docker Compose files."><meta data-rh="true" property="og:description" content="There are two different Docker Compose files."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/get-started/docker"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/docker" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/docker" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Deploy with Docker","item":"https://docs.openr.ag/get-started/docker"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Terminal User Interface (TUI) commands | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/get-started/tui"><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="Terminal User Interface (TUI) commands | OpenRAG"><meta data-rh="true" name="description" content="The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system."><meta data-rh="true" property="og:description" content="The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/get-started/tui"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/tui" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/get-started/tui" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Terminal User Interface (TUI)","item":"https://docs.openr.ag/get-started/tui"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 951 KiB After Width: | Height: | Size: 1,004 KiB |
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">What is OpenRAG? | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/"><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="What is OpenRAG? | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG is an open-source package for building agentic RAG systems."><meta data-rh="true" property="og:description" content="OpenRAG is an open-source package for building agentic RAG systems."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()})</script><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"About OpenRAG","item":"https://docs.openr.ag/"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Docling Ingestion | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/ingestion"><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="Docling Ingestion | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG uses Docling for its document ingestion pipeline."><meta data-rh="true" property="og:description" content="OpenRAG uses Docling for its document ingestion pipeline."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/ingestion"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/ingestion" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Docling Ingestion","item":"https://docs.openr.ag/ingestion"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -36,7 +36,29 @@ OCR is disabled by default. This setting is best suited for processing text-base
|
|||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="use-openrag-default-ingestion-instead-of-docling-serve">Use OpenRAG default ingestion instead of Docling serve<a href="#use-openrag-default-ingestion-instead-of-docling-serve" class="hash-link" aria-label="Direct link to Use OpenRAG default ingestion instead of Docling serve" title="Direct link to Use OpenRAG default ingestion instead of Docling serve"></a></h2>
|
||||
<p>If you want to use OpenRAG's built-in pipeline instead of Docling serve, set <code>DISABLE_INGEST_WITH_LANGFLOW=true</code> in <a href="/reference/configuration#document-processing">Environment variables</a>.</p>
|
||||
<p>The built-in pipeline still uses the Docling processor, but uses it directly without the Docling Serve API.</p>
|
||||
<p>For more information, see <a href="https://github.com/langflow-ai/openrag/blob/main/src/models/processors.py#L58" target="_blank" rel="noopener noreferrer"><code>processors.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"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/core-components/ingestion.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="/knowledge"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OpenSearch Knowledge</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reference/configuration"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Environment variables</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="#docling-ingestion-settings" class="table-of-contents__link toc-highlight">Docling ingestion settings</a></li><li><a href="#use-openrag-default-ingestion-instead-of-docling-serve" class="table-of-contents__link toc-highlight">Use OpenRAG default ingestion instead of Docling serve</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">
|
||||
<p>For more information, see <a href="https://github.com/langflow-ai/openrag/blob/main/src/models/processors.py#L58" target="_blank" rel="noopener noreferrer"><code>processors.py</code> in the OpenRAG repository</a>.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="knowledge-ingestion-flows">Knowledge ingestion flows<a href="#knowledge-ingestion-flows" class="hash-link" aria-label="Direct link to Knowledge ingestion flows" title="Direct link to Knowledge ingestion flows"></a></h2>
|
||||
<p><a href="https://docs.langflow.org/concepts-overview" target="_blank" rel="noopener noreferrer">Flows</a> in Langflow are functional representations of application workflows, with multiple <a href="https://docs.langflow.org/concepts-components" target="_blank" rel="noopener noreferrer">component</a> nodes connected as single steps in a workflow.</p>
|
||||
<p>The <strong>OpenSearch Ingestion</strong> flow is the default knowledge ingestion flow in OpenRAG: when you <strong>Add Knowledge</strong> in OpenRAG, you run the OpenSearch Ingestion flow in the background. The flow ingests documents using <strong>Docling Serve</strong> to import and process documents.</p>
|
||||
<p>This flow contains ten components connected together to process and store documents in your knowledge base.</p>
|
||||
<ul>
|
||||
<li>The <a href="https://docs.langflow.org/bundles-docling" target="_blank" rel="noopener noreferrer"><strong>Docling Serve</strong> component</a> processes input documents by connecting to your instance of Docling Serve.</li>
|
||||
<li>The <a href="https://docs.langflow.org/components-docling" target="_blank" rel="noopener noreferrer"><strong>Export DoclingDocument</strong> component</a> exports the processed DoclingDocument to markdown format with image export mode set to placeholder. This conversion makes the structured document data into a standardized format for further processing.</li>
|
||||
<li>Three <a href="https://docs.langflow.org/components-processing#dataframe-operations" target="_blank" rel="noopener noreferrer"><strong>DataFrame Operations</strong> components</a> sequentially add metadata columns to the document data of <code>filename</code>, <code>file_size</code>, and <code>mimetype</code>.</li>
|
||||
<li>The <a href="https://docs.langflow.org/components-processing#split-text" target="_blank" rel="noopener noreferrer"><strong>Split Text</strong> component</a> splits the processed text into chunks with a chunk size of 1000 characters and an overlap of 200 characters.</li>
|
||||
<li>Four <strong>Secret Input</strong> components provide secure access to configuration variables: <code>CONNECTOR_TYPE</code>, <code>OWNER</code>, <code>OWNER_EMAIL</code>, and <code>OWNER_NAME</code>. These are runtime variables populated from OAuth login.</li>
|
||||
<li>The <strong>Create Data</strong> component combines the secret inputs into a structured data object that will be associated with the document embeddings.</li>
|
||||
<li>The <a href="https://docs.langflow.org/components-embedding-models" target="_blank" rel="noopener noreferrer"><strong>Embedding Model</strong> component</a> generates vector embeddings using OpenAI's <code>text-embedding-3-small</code> model. The embedding model is selected at [Application onboarding] and cannot be changed.</li>
|
||||
<li>The <a href="https://docs.langflow.org/bundles-elastic#opensearch" target="_blank" rel="noopener noreferrer"><strong>OpenSearch</strong> component</a> stores the processed documents and their embeddings in the <code>documents</code> index at <code>https://opensearch:9200</code>. By default, the component is authenticated with a JWT token, but you can also select <code>basic</code> auth mode, and enter your OpenSearch admin username and password.</li>
|
||||
</ul>
|
||||
<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">Langflow visual editor</a>, so you can edit your flows to match your specific use case.</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="url-flow">OpenSearch URL Ingestion flow<a href="#url-flow" class="hash-link" aria-label="Direct link to OpenSearch URL Ingestion flow" title="Direct link to OpenSearch URL Ingestion flow"></a></h3>
|
||||
<p>An additional knowledge ingestion flow is included in OpenRAG, where it is used as an MCP tool by the <a href="/agents#flow"><strong>Open Search Agent flow</strong></a>.
|
||||
The agent calls this component to fetch web content, and the results are ingested into OpenSearch.</p>
|
||||
<p>For more on using MCP clients in Langflow, see <a href="https://docs.langflow.org/mcp-client" target="_blank" rel="noopener noreferrer">MCP clients</a>.<br>
|
||||
<!-- -->To connect additional MCP servers to the MCP client, see <a href="https://docs.langflow.org/mcp-tutorial" target="_blank" rel="noopener noreferrer">Connect to MCP servers from your application</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"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/core-components/ingestion.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="/knowledge"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OpenSearch Knowledge</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/reference/configuration"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Environment variables</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="#docling-ingestion-settings" class="table-of-contents__link toc-highlight">Docling ingestion settings</a></li><li><a href="#use-openrag-default-ingestion-instead-of-docling-serve" class="table-of-contents__link toc-highlight">Use OpenRAG default ingestion instead of Docling serve</a></li><li><a href="#knowledge-ingestion-flows" class="table-of-contents__link toc-highlight">Knowledge ingestion flows</a><ul><li><a href="#url-flow" class="table-of-contents__link toc-highlight">OpenSearch URL Ingestion flow</a></li></ul></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>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Install OpenRAG | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/install"><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="Install OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="Install the OpenRAG Python wheel, and then run the OpenRAG Terminal User Interface(TUI) to start your OpenRAG deployment with a guided setup process."><meta data-rh="true" property="og:description" content="Install the OpenRAG Python wheel, and then run the OpenRAG Terminal User Interface(TUI) to start your OpenRAG deployment with a guided setup process."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/install"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/install" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Install OpenRAG","item":"https://docs.openr.ag/install"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">OpenSearch Knowledge | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><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 Knowledge | 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 Knowledge","item":"https://docs.openr.ag/knowledge"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -17,7 +17,8 @@ Development is ongoing, and the features and functionality are subject to change
|
|||
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 anchorWithStickyNavbar_LWe7" 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"></a></h2>
|
||||
<p>OpenRAG supports knowledge ingestion through direct file uploads and OAuth connectors.</p>
|
||||
<p>OpenRAG supports knowledge ingestion through direct file uploads and OAuth connectors.
|
||||
To configure the knowledge ingestion pipeline parameters, see <a href="/ingestion">Docling Ingestion</a>.</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" 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"></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"><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 href="/install#setup">Advanced Setup</a> menu or in the <code>.env</code> used by Docker Compose.</p>
|
||||
|
|
@ -73,8 +74,6 @@ Click on a document to display the chunks derived from splitting the default doc
|
|||
<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">Langflow visual editor</a>, so you can edit your flows to match your specific use case.</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="knowledge-ingestion-settings">Knowledge ingestion settings<a href="#knowledge-ingestion-settings" class="hash-link" aria-label="Direct link to Knowledge ingestion settings" title="Direct link to Knowledge ingestion settings"></a></h3>
|
||||
<p>To configure the knowledge ingestion pipeline parameters, see <a href="/ingestion">Docling Ingestion</a>.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" 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"></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>
|
||||
|
|
@ -116,7 +115,7 @@ A new filter is created with default settings that match everything.</p>
|
|||
<p>You can use custom embedding models by specifying them in your configuration.</p>
|
||||
<p>If you use an unknown embedding model, OpenRAG will automatically fall back to <code>1536</code> dimensions and log a warning. The system will continue to work, but search quality may 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"><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"><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 Agents</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 Ingestion</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="#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><li><a href="#sync-cloud-connectors" class="table-of-contents__link toc-highlight">Sync cloud connectors</a></li></ul></li><li><a href="#explore-knowledge" class="table-of-contents__link toc-highlight">Explore knowledge</a><ul><li><a href="#knowledge-ingestion-settings" class="table-of-contents__link toc-highlight">Knowledge ingestion settings</a></li></ul></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">
|
||||
<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"><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"><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 Agents</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 Ingestion</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="#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><li><a href="#sync-cloud-connectors" class="table-of-contents__link toc-highlight">Sync cloud connectors</a></li></ul></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>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Quickstart | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/quickstart"><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="Quickstart | OpenRAG"><meta data-rh="true" name="description" content="Get started with OpenRAG by loading your knowledge, swapping out your language model, and then chatting with the OpenRAG API."><meta data-rh="true" property="og:description" content="Get started with OpenRAG by loading your knowledge, swapping out your language model, and then chatting with the OpenRAG API."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/quickstart"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/quickstart" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Quickstart","item":"https://docs.openr.ag/quickstart"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
@ -62,7 +62,7 @@ You can more quickly access the <strong>Language Model</strong> and <strong>Agen
|
|||
</li>
|
||||
<li>
|
||||
<p>The OpenRAG OpenSearch Agent flow appears.
|
||||
<img decoding="async" loading="lazy" alt="OpenRAG Open Search Agent Flow" src="/assets/images/opensearch-agent-flow-a3c183a9f2d5ec513819aba1f1b49c39.png" width="4108" height="2250" class="img_ev3q"></p>
|
||||
<img decoding="async" loading="lazy" alt="OpenRAG Open Search Agent Flow" src="/assets/images/opensearch-agent-flow-a759d00657f2fdb62e64c84c643e8896.png" width="4086" height="2240" class="img_ev3q"></p>
|
||||
</li>
|
||||
<li>
|
||||
<p>In the <strong>Language Model</strong> component, under <strong>Model</strong>, select a different OpenAI model.</p>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Environment variables | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/reference/configuration"><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="Environment variables | OpenRAG"><meta data-rh="true" name="description" content="OpenRAG recognizes supported environment variables from the following sources:"><meta data-rh="true" property="og:description" content="OpenRAG recognizes supported environment variables from the following sources:"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/reference/configuration"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/reference/configuration" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Environment variables","item":"https://docs.openr.ag/reference/configuration"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
<meta charset="UTF-8">
|
||||
<meta name="generator" content="Docusaurus v3.8.1">
|
||||
<title data-rh="true">Troubleshoot | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/support/troubleshoot"><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="Troubleshoot | OpenRAG"><meta data-rh="true" name="description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><meta data-rh="true" property="og:description" content="This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/support/troubleshoot"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/troubleshoot" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Troubleshoot","item":"https://docs.openr.ag/support/troubleshoot"}]}</script><link rel="stylesheet" href="/assets/css/styles.1847d619.css">
|
||||
<script src="/assets/js/runtime~main.875d0f51.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.7216ebbe.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.692561be.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue