notes and prep
This commit is contained in:
parent
b00e6e9c98
commit
c93cf42f88
2 changed files with 35 additions and 7 deletions
|
|
@ -26,6 +26,8 @@ To configure the knowledge ingestion pipeline parameters, see [Docling Ingestion
|
|||
|
||||
### Direct file ingestion
|
||||
|
||||
<!-- is this a separate flow or same as the OpenSearch Ingestion flow? -->
|
||||
|
||||
The **Knowledge Ingest** flow uses Langflow's [**File** component](https://docs.langflow.org/components-data#file) to split and embed files loaded from your local machine into the OpenSearch database.
|
||||
|
||||
The default path to your local folder is mounted from the `./documents` folder in your OpenRAG project directory to the `/app/documents/` 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 **Documents Paths** variable in either the TUI's [Advanced Setup](/install#setup) menu or in the `.env` used by Docker Compose.
|
||||
|
|
@ -38,6 +40,8 @@ The files are loaded into your OpenSearch database, and appear in the Knowledge
|
|||
|
||||
To add files directly to a chat session, click <Icon name="Plus" aria-hidden="true"/> 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.
|
||||
|
||||
<!-- missing URL ingestion -->
|
||||
|
||||
### Ingest files through OAuth connectors {#oauth-ingestion}
|
||||
|
||||
OpenRAG supports Google Drive, OneDrive, and Sharepoint as OAuth connectors for seamless document synchronization.
|
||||
|
|
@ -87,7 +91,7 @@ The ingestion process can take some time depending on the size of your documents
|
|||
|
||||
If ingestion fails, click **Status** to view the logged error.
|
||||
|
||||
## Monitor ingestion tasks
|
||||
### Monitor ingestion tasks
|
||||
|
||||
When you upload files, process folders, or sync documents, OpenRAG processes them as background tasks.
|
||||
A badge appears on the <Icon name="Bell" aria-hidden="true"/> **Tasks** icon when there are active tasks running.
|
||||
|
|
@ -98,15 +102,21 @@ A **Pending** task is queued and waiting to start, a **Running** task is activel
|
|||
|
||||
You can cancel active tasks by clicking <Icon name="X" aria-hidden="true"/> **Cancel**. Canceling a task stops processing immediately and marks the task as failed.
|
||||
|
||||
## Explore knowledge
|
||||
## Browse knowledge
|
||||
|
||||
The **Knowledge** page lists the documents OpenRAG has ingested into the OpenSearch vector database's `documents` index.
|
||||
|
||||
To explore your current knowledge, click <Icon name="Library" aria-hidden="true"/> **Knowledge**.
|
||||
Click on a document to display the chunks derived from splitting the default documents into the vector database.
|
||||
To explore the raw contents of your knowledge base, click <Icon name="Library" aria-hidden="true"/> **Knowledge** to get a list of all ingested documents.
|
||||
Click a document to view the chunks produced from splitting the documents during ingestion into the vector database.
|
||||
|
||||
Documents are processed with the default **Knowledge Ingest** flow. If you want to split your documents differently, edit the **Knowledge Ingest** flow, as explained in [Inspect and modify flows](/agents#inspect-and-modify-flows).
|
||||
|
||||
## Chat with knowledge
|
||||
|
||||
<!-- move content from /agents -->
|
||||
|
||||
<!-- can also ingest while chatting -->
|
||||
|
||||
## Create knowledge filters
|
||||
|
||||
OpenRAG includes a knowledge filter system for organizing and managing document collections.
|
||||
|
|
|
|||
|
|
@ -24,9 +24,27 @@ const sidebars = {
|
|||
"get-started/quickstart",
|
||||
"get-started/install",
|
||||
"get-started/docker",
|
||||
"core-components/agents",
|
||||
"core-components/knowledge",
|
||||
"core-components/ingestion",
|
||||
{
|
||||
type: "category",
|
||||
label: "Langflow in OpenRAG",
|
||||
items: [
|
||||
"core-components/agents",
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "OpenSearch in OpenRAG",
|
||||
items: [
|
||||
"core-components/knowledge",
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Docling in OpenRAG",
|
||||
items: [
|
||||
"core-components/ingestion",
|
||||
],
|
||||
},
|
||||
"reference/configuration",
|
||||
"support/troubleshoot",
|
||||
],
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue