Compare commits
No commits in common. "main" and "open-search-health" have entirely different histories.
main
...
open-searc
23 changed files with 83 additions and 605 deletions
155
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
155
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,155 +0,0 @@
|
|||
name: Bug Report
|
||||
description: Report a bug or unexpected behavior in OpenRAG
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue.
|
||||
|
||||
- type: input
|
||||
id: openrag-version
|
||||
attributes:
|
||||
label: OpenRAG Version
|
||||
description: What version of OpenRAG are you using? Run `openrag --version` or check your package version.
|
||||
placeholder: "e.g., 0.1.0"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: deployment-method
|
||||
attributes:
|
||||
label: Deployment Method
|
||||
description: How are you running OpenRAG?
|
||||
options:
|
||||
- uvx (uvx openrag)
|
||||
- uv add (installed in project)
|
||||
- Docker
|
||||
- Podman
|
||||
- Local development (make dev)
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating System
|
||||
description: What operating system are you using?
|
||||
placeholder: "e.g., macOS 14.0, Ubuntu 22.04, Windows 11"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: python-version
|
||||
attributes:
|
||||
label: Python Version
|
||||
description: What Python version are you using? Run `python --version` to check.
|
||||
placeholder: "e.g., 3.13.0"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: affected-area
|
||||
attributes:
|
||||
label: Affected Area
|
||||
description: Which area(s) of OpenRAG does this bug affect? Select all that apply.
|
||||
multiple: true
|
||||
options:
|
||||
- Ingestion (document processing, upload, Docling)
|
||||
- Retrieval (search, OpenSearch, hybrid search)
|
||||
- Chat (chat interface, conversations, AI responses)
|
||||
- Knowledge Filters (partitions, document filtering)
|
||||
- Settings (configuration, model providers)
|
||||
- TUI (Terminal User Interface)
|
||||
- Connectors (Google Drive, OneDrive, SharePoint)
|
||||
- Frontend (Next.js UI, components)
|
||||
- Backend/API (Python/Starlette)
|
||||
- Infrastructure (Docker, OpenSearch, Langflow)
|
||||
- SDK (Python or TypeScript SDK)
|
||||
- Onboarding (setup wizard, initial configuration)
|
||||
- Authentication (OIDC, API keys)
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: bug-description
|
||||
attributes:
|
||||
label: Bug Description
|
||||
description: A clear and concise description of what the bug is.
|
||||
placeholder: Describe the bug...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps-to-reproduce
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Steps to reproduce the behavior.
|
||||
placeholder: |
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. Scroll down to '...'
|
||||
4. See error
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected-behavior
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
placeholder: What should have happened?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual-behavior
|
||||
attributes:
|
||||
label: Actual Behavior
|
||||
description: A clear and concise description of what actually happened.
|
||||
placeholder: What actually happened?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant Logs
|
||||
description: |
|
||||
Please copy and paste any relevant log output.
|
||||
You can get logs using `make logs` for Docker deployments or check the terminal output.
|
||||
This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots
|
||||
description: If applicable, add screenshots to help explain your problem.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context about the problem here (e.g., browser version, specific document types, model provider being used).
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Please confirm the following before submitting.
|
||||
options:
|
||||
- label: I have searched existing issues to ensure this bug hasn't been reported before.
|
||||
required: true
|
||||
- label: I have provided all the requested information.
|
||||
required: true
|
||||
|
||||
15
.github/ISSUE_TEMPLATE/config.yml
vendored
15
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -1,15 +0,0 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: OpenRAG Documentation
|
||||
url: https://docs.openr.ag/
|
||||
about: Learn more about OpenRAG's features, installation, and configuration.
|
||||
- name: Troubleshooting Guide
|
||||
url: https://docs.openr.ag/support/troubleshoot
|
||||
about: Check the troubleshooting guide for common issues and solutions.
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/langflow-ai/openrag/discussions
|
||||
about: Ask questions and discuss ideas with the community.
|
||||
- name: Contributing Guide
|
||||
url: https://github.com/langflow-ai/openrag/blob/main/CONTRIBUTING.md
|
||||
about: Learn how to contribute to OpenRAG development.
|
||||
|
||||
106
.github/ISSUE_TEMPLATE/documentation.yml
vendored
106
.github/ISSUE_TEMPLATE/documentation.yml
vendored
|
|
@ -1,106 +0,0 @@
|
|||
name: Documentation Issue
|
||||
description: Report an issue with documentation or request new documentation
|
||||
title: "[Docs]: "
|
||||
labels: ["documentation"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for helping improve OpenRAG's documentation! Please provide details about the issue or your request.
|
||||
|
||||
- type: dropdown
|
||||
id: issue-type
|
||||
attributes:
|
||||
label: Issue Type
|
||||
description: What type of documentation issue is this?
|
||||
options:
|
||||
- Incorrect information
|
||||
- Missing documentation
|
||||
- Outdated content
|
||||
- Unclear or confusing
|
||||
- Typo or grammatical error
|
||||
- Broken links
|
||||
- Request for new documentation
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: doc-area
|
||||
attributes:
|
||||
label: Documentation Area
|
||||
description: Which area of documentation does this relate to?
|
||||
multiple: true
|
||||
options:
|
||||
- Getting Started / Quickstart
|
||||
- Installation (uvx, Docker, Podman)
|
||||
- Configuration / Settings
|
||||
- Ingestion & Document Processing
|
||||
- Search & Retrieval
|
||||
- Chat Interface
|
||||
- Knowledge Filters
|
||||
- Connectors (Google Drive, OneDrive, SharePoint)
|
||||
- TUI (Terminal User Interface)
|
||||
- API Reference
|
||||
- SDK Documentation (Python/TypeScript)
|
||||
- Troubleshooting
|
||||
- Contributing Guide
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: doc-url
|
||||
attributes:
|
||||
label: Documentation URL
|
||||
description: If applicable, provide a link to the specific documentation page.
|
||||
placeholder: "https://docs.openr.ag/..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: current-content
|
||||
attributes:
|
||||
label: Current Content
|
||||
description: If reporting an issue, what does the documentation currently say?
|
||||
placeholder: Quote or describe the current documentation content.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: issue-description
|
||||
attributes:
|
||||
label: Issue Description
|
||||
description: Describe the problem or what documentation you'd like to see added.
|
||||
placeholder: |
|
||||
For issues: Explain what's wrong or confusing about the current documentation.
|
||||
For requests: Describe what topic you'd like documented and why it would be helpful.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: suggested-content
|
||||
attributes:
|
||||
label: Suggested Content
|
||||
description: If you have suggestions for how to fix or improve the documentation, please share them.
|
||||
placeholder: Provide suggested text, corrections, or an outline for new documentation.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context, screenshots, or examples here.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: contribution
|
||||
attributes:
|
||||
label: Contribution
|
||||
description: Would you be interested in contributing to fix this documentation issue?
|
||||
options:
|
||||
- label: I would be willing to submit a pull request to fix this issue.
|
||||
required: false
|
||||
|
||||
113
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
113
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -1,113 +0,0 @@
|
|||
name: Feature Request
|
||||
description: Suggest a new feature or enhancement for OpenRAG
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for suggesting a feature! Please provide as much detail as possible to help us understand your request.
|
||||
|
||||
- type: dropdown
|
||||
id: feature-area
|
||||
attributes:
|
||||
label: Feature Area
|
||||
description: Which area(s) of OpenRAG does this feature relate to?
|
||||
multiple: true
|
||||
options:
|
||||
- Ingestion (document processing, upload, Docling)
|
||||
- Retrieval (search, OpenSearch, hybrid search)
|
||||
- Chat (chat interface, conversations, AI responses)
|
||||
- Knowledge Filters (partitions, document filtering)
|
||||
- Settings (configuration, model providers)
|
||||
- TUI (Terminal User Interface)
|
||||
- Connectors (Google Drive, OneDrive, SharePoint)
|
||||
- Frontend (Next.js UI, components)
|
||||
- Backend/API (Python/Starlette)
|
||||
- Infrastructure (Docker, OpenSearch, Langflow)
|
||||
- SDK (Python or TypeScript SDK)
|
||||
- Onboarding (setup wizard, initial configuration)
|
||||
- Authentication (OIDC, API keys)
|
||||
- New Area
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem-description
|
||||
attributes:
|
||||
label: Problem Description
|
||||
description: Is your feature request related to a problem? Please describe.
|
||||
placeholder: A clear and concise description of what the problem is. E.g., "I'm always frustrated when..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposed-solution
|
||||
attributes:
|
||||
label: Proposed Solution
|
||||
description: Describe the solution you'd like to see implemented.
|
||||
placeholder: A clear and concise description of what you want to happen.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: use-case
|
||||
attributes:
|
||||
label: Use Case
|
||||
description: Describe your use case and how this feature would benefit you or others.
|
||||
placeholder: |
|
||||
As a [type of user], I want [goal] so that [benefit].
|
||||
|
||||
Example: As a developer, I want to filter documents by custom metadata so that I can organize my knowledge base more effectively.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives Considered
|
||||
description: Describe any alternative solutions or features you've considered.
|
||||
placeholder: What other approaches have you thought about? Why wouldn't they work as well?
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: Priority
|
||||
description: How important is this feature to your workflow?
|
||||
options:
|
||||
- Nice to have
|
||||
- Would improve my workflow
|
||||
- Critical for my use case
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context, mockups, screenshots, or examples about the feature request here.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: contribution
|
||||
attributes:
|
||||
label: Contribution
|
||||
description: Would you be interested in contributing to this feature?
|
||||
options:
|
||||
- label: I would be willing to help implement this feature.
|
||||
required: false
|
||||
- label: I can help test this feature once implemented.
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Please confirm the following before submitting.
|
||||
options:
|
||||
- label: I have searched existing issues and discussions to ensure this feature hasn't been requested before.
|
||||
required: true
|
||||
|
||||
2
.github/workflows/build-multiarch.yml
vendored
2
.github/workflows/build-multiarch.yml
vendored
|
|
@ -206,7 +206,7 @@ jobs:
|
|||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v6
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.13'
|
||||
|
||||
|
|
|
|||
2
.github/workflows/dependency-audit.yml
vendored
2
.github/workflows/dependency-audit.yml
vendored
|
|
@ -45,7 +45,7 @@ jobs:
|
|||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v6
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
|
|
|
|||
2
.github/workflows/publish-sdk-python.yml
vendored
2
.github/workflows/publish-sdk-python.yml
vendored
|
|
@ -21,7 +21,7 @@ jobs:
|
|||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v6
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.12'
|
||||
|
||||
|
|
|
|||
2
.github/workflows/update-uv-lock.yml
vendored
2
.github/workflows/update-uv-lock.yml
vendored
|
|
@ -20,7 +20,7 @@ jobs:
|
|||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v6
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: '3.13'
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
FROM node:20.20.0-slim
|
||||
FROM node:18-slim
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
|
|
|
|||
|
|
@ -97,7 +97,7 @@ services:
|
|||
environment:
|
||||
- OPENRAG_BACKEND_HOST=openrag-backend
|
||||
ports:
|
||||
- "3003:3003"
|
||||
- "3000:3000"
|
||||
|
||||
langflow:
|
||||
volumes:
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
In no-auth mode, all documents are attributed to **Anonymous User** because there is no distinct document ownership or unique JWTs. For more control over document ownership and visibility, use OAuth mode. For more information, see [OpenSearch authentication and document access](/knowledge#auth).
|
||||
|
|
@ -2,4 +2,4 @@ GPU acceleration isn't required for most use cases.
|
|||
OpenRAG's CPU-only deployment doesn't prevent you from using GPU acceleration in external services, such as Ollama servers.
|
||||
|
||||
GPU acceleration is required only for specific use cases, typically involving customization of the ingestion flows or ingestion logic.
|
||||
For example, writing alternate ingest logic in OpenRAG that uses GPUs directly in the container, or customizing the ingestion flows to use Langflow's Docling component with GPU acceleration instead of OpenRAG's Docling Serve service.
|
||||
For example, writing alternate ingest logic in OpenRAG that uses GPUs directly in the container, or customizing the ingestion flows to use Langflow's Docling component with GPU acceleration instead of OpenRAG's `docling serve` service.
|
||||
|
|
@ -2,7 +2,7 @@ import Icon from "@site/src/components/icon/icon";
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
1. Open the **OpenRAG OpenSearch Agent** flow in the Langflow visual editor: Click <Icon name="Settings2" aria-hidden="true"/> **Settings**, click **Edit in Langflow**, and then click **Proceed**.
|
||||
1. Open the **OpenRAG OpenSearch Agent** flow in the Langflow visual editor: From the **Chat** window, click <Icon name="Settings2" aria-hidden="true"/> **Settings**, click **Edit in Langflow**, and then click **Proceed**.
|
||||
|
||||
2. Optional: If you don't want to use the Langflow API key that is generated automatically when you install OpenRAG, you can create a [Langflow API key](https://docs.langflow.org/api-keys-and-authentication).
|
||||
This key doesn't grant access to OpenRAG; it is only for authenticating with the Langflow API.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
import Icon from "@site/src/components/icon/icon";
|
||||
|
||||
When using the OpenRAG **Chat**, click <Icon name="Plus" aria-hidden="true"/> **Add** in the chat input field to upload a file to the current chat session.
|
||||
When using the OpenRAG **Chat**, click <Icon name="Plus" aria-hidden="true"/> in the chat input field to upload a file to the current chat session.
|
||||
Files added this way are processed and made available to the agent for the current conversation only.
|
||||
These files aren't stored in the knowledge base permanently.
|
||||
|
|
@ -20,26 +20,15 @@ You can customize these flows and create your own flows using OpenRAG's embedded
|
|||
|
||||
All OpenRAG flows are designed to be modular, performant, and provider-agnostic.
|
||||
|
||||
To view and modify a flow in OpenRAG, click <Icon name="Settings2" aria-hidden="true"/> **Settings**.
|
||||
From here, you can manage OAuth connectors, model providers, and common parameters for the **Agent** and **Knowledge Ingestion** flows.
|
||||
To modify a flow in OpenRAG, click <Icon name="Settings2" aria-hidden="true"/> **Settings**.
|
||||
From here, you can quickly edit commonly used parameters, such as the **Language model** and **Agent Instructions**.
|
||||
To further explore and edit the flow, click **Edit in Langflow** to launch the embedded [Langflow visual editor](https://docs.langflow.org/concepts-overview) where you can fully [customize the flow](https://docs.langflow.org/concepts-flows) to suit your use case.
|
||||
|
||||
To further explore and edit flows, click **Edit in Langflow** to launch the embedded [Langflow visual editor](https://docs.langflow.org/concepts-overview) where you can fully [customize the flow](https://docs.langflow.org/concepts-flows) to suit your use case.
|
||||
For example, to view and edit the built-in **Chat** flow (the **OpenRAG OpenSearch Agent** flow), do the following:
|
||||
|
||||
:::tip
|
||||
After you click **Edit in Langflow**, you can access and edit all of OpenRAG's built-in flows from the Langflow editor's [**Projects** page](https://docs.langflow.org/concepts-flows#projects).
|
||||
1. In OpenRAG, click <Icon name="MessageSquare" aria-hidden="true"/> **Chat**.
|
||||
|
||||
If you edit any flows other than the **Agent** or **Knowledge Ingestion** flows, it is recommended that you [export the flows](https://docs.langflow.org/concepts-flows-import) before editing so you can revert them to their original state if needed.
|
||||
:::
|
||||
|
||||
For example, the following steps explain how to edit the built-in **Agent** flow, which is the **OpenRAG OpenSearch Agent** flow used for the OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat**:
|
||||
|
||||
1. In OpenRAG, click <Icon name="Settings2" aria-hidden="true"/> **Settings**, and then find the **Agent** section.
|
||||
|
||||
2. If you only need to edit the language model or agent instructions, edit those fields directly on the **Settings** page.
|
||||
Language model changes are saved automatically.
|
||||
To apply new instructions, click **Save Agent Instructions**.
|
||||
|
||||
3. To edit all flow settings and components with full customization capabilities, click **Edit in Langflow** to launch the Langflow visual editor in a new browser tab.
|
||||
2. Click <Icon name="Settings2" aria-hidden="true"/> **Settings**, and then click **Edit in Langflow** to launch the Langflow visual editor in a new browser window.
|
||||
|
||||
If prompted to acknowledge that you are entering Langflow, click **Proceed**.
|
||||
|
||||
|
|
@ -47,21 +36,19 @@ To apply new instructions, click **Save Agent Instructions**.
|
|||
|
||||
|
||||
|
||||
4. Modify the flow as desired, and then press <kbd>Command</kbd>+<kbd>S</kbd> (<kbd>Ctrl</kbd>+<kbd>S</kbd>) to save your changes.
|
||||
3. Modify the flow as desired, and then press <kbd>Command</kbd>+<kbd>S</kbd> (<kbd>Ctrl</kbd>+<kbd>S</kbd>) to save your changes.
|
||||
|
||||
You can close the Langflow browser tab, or leave it open if you want to continue experimenting with the flow editor.
|
||||
You can close the Langflow browser window, or leave it open if you want to continue experimenting with the flow editor.
|
||||
|
||||
5. After you modify any **Agent** flow settings, go to the OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat**, and then click <Icon name="Plus" aria-hidden="true"/> **Start new conversation** in the **Conversations** list.
|
||||
This ensures that the chat doesn't persist any context from the previous conversation with the original flow settings.
|
||||
:::tip
|
||||
If you modify the built-in **Chat** flow, make sure you click <Icon name="Plus" aria-hidden="true"/> in the **Conversations** tab to start a new conversation. This ensures that the chat doesn't persist any context from the previous conversation with the original flow settings.
|
||||
:::
|
||||
|
||||
### Revert a built-in flow to its original configuration {#revert-a-built-in-flow-to-its-original-configuration}
|
||||
|
||||
After you edit the **Agent** or **Knowledge Ingestion** built-in flows, you can click **Restore flow** on the **Settings** page to revert either flow to its original state when you first installed OpenRAG.
|
||||
After you edit a built-in flow, you can click **Restore flow** on the **Settings** page to revert the flow to its original state when you first installed OpenRAG.
|
||||
This is a destructive action that discards all customizations to the flow.
|
||||
|
||||
This option isn't available for other built-in flows such as the **Nudges** flow.
|
||||
To restore these flows to their original state, you must reimport the flow from a backup (if you exported one before editing), or [reset](/manage-services#reset-containers) or [reinstall](/reinstall) OpenRAG.
|
||||
|
||||
## Build custom flows and use other Langflow functionality
|
||||
|
||||
In addition to OpenRAG's built-in flows, all Langflow features are available through OpenRAG, including the ability to [create your own flows](https://docs.langflow.org/concepts-flows) and popular extensibility features such as the following:
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ import PartialTempKnowledge from '@site/docs/_partial-temp-knowledge.mdx';
|
|||
|
||||
After you [upload documents to your knowledge base](/ingestion), you can use the OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat** feature to interact with your knowledge through natural language queries.
|
||||
|
||||
The OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat** uses an LLM-powered agent to understand your queries, retrieve relevant information from your knowledge base, and generate context-aware responses.
|
||||
The OpenRAG **Chat** uses an LLM-powered agent to understand your queries, retrieve relevant information from your knowledge base, and generate context-aware responses.
|
||||
The agent can also fetch information from URLs and new documents that you provide during the chat session.
|
||||
To limit the knowledge available to the agent, use [filters](/knowledge-filters).
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ Try chatting, uploading documents, and modifying chat settings in the [quickstar
|
|||
|
||||
## OpenRAG OpenSearch Agent flow {#flow}
|
||||
|
||||
When you use the OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat**, the **OpenRAG OpenSearch Agent** flow runs in the background to retrieve relevant information from your knowledge base and generate a response.
|
||||
When you use the OpenRAG **Chat**, the **OpenRAG OpenSearch Agent** flow runs in the background to retrieve relevant information from your knowledge base and generate a response.
|
||||
|
||||
If you [inspect the flow in Langflow](/agents#inspect-and-modify-flows), you'll see that it is comprised of eight components that work together to ingest chat messages, retrieve relevant information from your knowledge base, and then generate responses.
|
||||
When you inspect this flow, you can edit the components to customize the agent's behavior.
|
||||
|
|
@ -32,7 +32,7 @@ When you inspect this flow, you can edit the components to customize the agent's
|
|||
|
||||
|
||||
* [**Chat Input** component](https://docs.langflow.org/chat-input-and-output#chat-input): This component starts the flow when it receives a chat message. It is connected to the **Agent** component's **Input** port.
|
||||
When you use the OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat**, your chat messages are passed to the **Chat Input** component, which then sends them to the **Agent** component for processing.
|
||||
When you use the OpenRAG **Chat**, your chat messages are passed to the **Chat Input** component, which then sends them to the **Agent** component for processing.
|
||||
|
||||
* [**Agent** component](https://docs.langflow.org/components-agents): This component orchestrates the entire flow by processing chat messages, searching the knowledge base, and organizing the retrieved information into a cohesive response.
|
||||
The agent's general behavior is defined by the prompt in the **Agent Instructions** field and the model connected to the **Language Model** port.
|
||||
|
|
@ -73,18 +73,12 @@ If no knowledge filter is set, then the `OPENRAG-QUERY-FILTER` variable is empty
|
|||
|
||||
## Nudges {#nudges}
|
||||
|
||||
When you use the OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat**, the **OpenRAG OpenSearch Nudges** flow runs in the background to pull additional context from your knowledge base and chat history.
|
||||
When you use the OpenRAG **Chat**, the **OpenRAG OpenSearch Nudges** flow runs in the background to pull additional context from your knowledge base and chat history.
|
||||
|
||||
Nudges appear as prompts in the chat, and they are based on the contents of your OpenRAG OpenSearch knowledge base.
|
||||
Click a nudge to accept it and start a chat based on the nudge.
|
||||
Nudges appear as prompts in the chat.
|
||||
Click a nudge to accept it and provide the nudge's context to the OpenRAG **Chat** agent (the **OpenRAG OpenSearch Agent** flow).
|
||||
|
||||
Like OpenRAG's other built-in flows, you can [inspect the flow in Langflow](/agents#inspect-and-modify-flows), and you can customize it if you want to change the nudge behavior.
|
||||
However, this flow is specifically designed to work with the OpenRAG chat and knowledge base.
|
||||
Major changes to this flow might break the nudge functionality or produce irrelevant nudges.
|
||||
|
||||
The **Nudges** flow consists of **Embedding model**, **Language model**, **OpenSearch**, **Input/Output*, and other components that browse your knowledge base, identify key themes and possible insights, and then produce prompts based on the findings.
|
||||
|
||||
For example, if your knowledge base contains documents about cybersecurity, possible nudges might include `Explain zero trust architecture principles` or `How to identify a social engineering attack`.
|
||||
|
||||
## Upload documents to the chat
|
||||
|
||||
|
|
|
|||
|
|
@ -171,37 +171,26 @@ The agent can call this component to fetch web content from a given URL, and the
|
|||
Like all OpenRAG flows, you can [inspect the flow in Langflow](/agents#inspect-and-modify-flows), and you can customize it.
|
||||
For more information about MCP in Langflow, see the Langflow documentation on [MCP clients](https://docs.langflow.org/mcp-client) and [MCP servers](https://docs.langflow.org/mcp-tutorial).
|
||||
|
||||
## Monitor ingestion {#monitor-ingestion}
|
||||
## Monitor ingestion
|
||||
|
||||
Depending on the amount of data to ingest, document ingestion can take a few seconds, minutes, or longer.
|
||||
For this reason, document ingestion tasks run in the background.
|
||||
Document ingestion tasks run in the background.
|
||||
|
||||
In the OpenRAG user interface, a badge is shown on <Icon name="Bell" aria-hidden="true"/> **Tasks** when OpenRAG tasks are active.
|
||||
Click <Icon name="Bell" aria-hidden="true"/> **Tasks** to inspect and cancel tasks.
|
||||
Tasks are separated into multiple sections:
|
||||
Click <Icon name="Bell" aria-hidden="true"/> **Tasks** to inspect and cancel tasks:
|
||||
|
||||
* The **Active Tasks** section includes all tasks that are **Pending**, **Running**, or **Processing**:
|
||||
* **Active Tasks**: All tasks that are **Pending**, **Running**, or **Processing**.
|
||||
For each active task, depending on its state, you can find the task ID, start time, duration, number of files processed, and the total files enqueued for processing.
|
||||
|
||||
* **Pending**: The task is queued and waiting to start.
|
||||
* **Running**: The task is actively processing files.
|
||||
* **Processing**: The task is performing ingestion operations.
|
||||
* **Pending**: The task is queued and waiting to start.
|
||||
|
||||
To stop an active task, click <Icon name="X" aria-hidden="true"/> **Cancel**. Canceling a task stops processing immediately and marks the ingestion as failed.
|
||||
* **Running**: The task is actively processing files.
|
||||
|
||||
* The **Recent Tasks** section lists recently finished tasks.
|
||||
* **Processing**: The task is performing ingestion operations.
|
||||
|
||||
:::warning
|
||||
**Completed** doesn't mean success.
|
||||
* **Failed**: Something went wrong during ingestion, or the task was manually canceled.
|
||||
For troubleshooting advice, see [Troubleshoot ingestion](#troubleshoot-ingestion).
|
||||
|
||||
A completed task can report successful ingestions, failed ingestions, or both, depending on the number of files processed.
|
||||
:::
|
||||
|
||||
Check the **Success** and **Failed** counts for each completed task to determine the overall success rate.
|
||||
|
||||
**Failed** means something went wrong during ingestion, or the task was manually canceled.
|
||||
For more information, see [Troubleshoot ingestion](#troubleshoot-ingestion).
|
||||
|
||||
For each task, depending on its state, you can find the task ID, start time, duration, number of files processed successfully, number of files that failed, and the number of files enqueued for processing.
|
||||
To stop an active task, click <Icon name="X" aria-hidden="true"/> **Cancel**. Canceling a task stops processing immediately and marks the task as **Failed**.
|
||||
|
||||
### Ingestion performance expectations
|
||||
|
||||
|
|
@ -258,9 +247,9 @@ The following issues can occur during document ingestion.
|
|||
|
||||
If an ingestion task fails, do the following:
|
||||
|
||||
* Make sure you uploaded only supported file types.
|
||||
* Split very large files into smaller files.
|
||||
* Remove unusual or complex embedded content, such as videos or animations. Although Docling can replace some non-text content with placeholders during ingestion, some embedded content might cause errors.
|
||||
* Make sure you are uploading supported file types.
|
||||
* Split excessively large files into smaller files before uploading.
|
||||
* Remove unusual embedded content, such as videos or animations, before uploading. Although Docling can replace some non-text content with placeholders during ingestion, some embedded content might cause errors.
|
||||
* Make sure your Podman/Docker VM has sufficient memory for the ingestion tasks.
|
||||
The minimum recommendation is 8 GB of RAM.
|
||||
If you regularly upload large files, more RAM is recommended.
|
||||
|
|
@ -272,17 +261,17 @@ For more information, see [Memory issue with Podman on macOS](/support/troublesh
|
|||
If the OpenRAG **Chat** doesn't seem to use your documents correctly, [browse your knowledge base](/knowledge#browse-knowledge) to confirm that the documents are uploaded in full, and the chunks are correct.
|
||||
|
||||
If the documents are present and well-formed, check your [knowledge filters](/knowledge-filters).
|
||||
If you applied a filter to the chat, make sure the expected documents aren't excluded by the filter settings.
|
||||
You can test this by applying the filter when you [browse the knowledge base](/knowledge#browse-knowledge).
|
||||
If the filter excludes any documents, the agent cannot access those documents.
|
||||
Be aware that some settings create dynamic filters that don't always produce the same results, such as a **Search query** combined with a low **Response limit**.
|
||||
If a global filter is applied, make sure the expected documents are included in the global filter.
|
||||
If the global filter excludes any documents, the agent cannot access those documents unless you apply a chat-level filter or change the global filter.
|
||||
|
||||
If the document chunks have missing, incorrect, or unexpected text, you must [delete the documents](/knowledge#delete-knowledge) from your knowledge base, modify the [ingestion parameters](/knowledge#knowledge-ingestion-settings) or the documents themselves, and then reingest the documents.
|
||||
If text is missing or incorrectly processed, you need to reupload the documents after modifying the ingestion parameters or the documents themselves.
|
||||
For example:
|
||||
|
||||
* Break combined documents into separate files for better metadata context.
|
||||
* Make sure scanned documents are legible enough for extraction, and enable the **OCR** option. Poorly scanned documents might require additional preparation or rescanning before ingestion.
|
||||
* Adjust the **Chunk size** and **Chunk overlap** settings to better suit your documents. Larger chunks provide more context but can include irrelevant information, while smaller chunks yield more precise semantic search but can lack context.
|
||||
* Adjust the **Chunk Size** and **Chunk Overlap** settings to better suit your documents. Larger chunks provide more context but can include irrelevant information, while smaller chunks yield more precise semantic search but can lack context.
|
||||
|
||||
For more information about modifying ingestion parameters and flows, see [Knowledge ingestion settings](/knowledge#knowledge-ingestion-settings).
|
||||
|
||||
## See also
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,6 @@ slug: /knowledge-filters
|
|||
---
|
||||
|
||||
import Icon from "@site/src/components/icon/icon";
|
||||
import PartialAnonymousUserOwner from '@site/docs/_partial-anonymous-user-owner.mdx';
|
||||
|
||||
OpenRAG's knowledge filters help you organize and manage your [knowledge base](/knowledge) by creating pre-defined views of your documents.
|
||||
|
||||
|
|
@ -27,61 +26,36 @@ After uploading your own documents, it is recommended that you create your own f
|
|||
|
||||
To create a knowledge filter, do the following:
|
||||
|
||||
1. Click <Icon name="Library" aria-hidden="true"/> **Knowledge**, and then click <Icon name="Plus" aria-hidden="true"/> **Knowledge Filters**.
|
||||
1. Click **Knowledge**, and then click <Icon name="Plus" aria-hidden="true"/> **Knowledge Filters**.
|
||||
|
||||
2. Enter a **Name**.
|
||||
2. Enter a **Name** and **Description**, and then click **Create Filter**.
|
||||
|
||||
3. Optional: Click the filter icon next to the filter name to select a different icon and color for the filter.
|
||||
This is purely cosmetic, but it can help you visually distinguish different sets of filters, such as different projects or sources.
|
||||
By default, new filters match all documents in your knowledge base.
|
||||
Modify the filter to customize it.
|
||||
|
||||
4. Optional: Enter a **Description**.
|
||||
|
||||
5. Customize the filter settings.
|
||||
|
||||
By default, filters match all documents in your knowledge base.
|
||||
Use the filter settings to narrow the scope of documents that the filter captures:
|
||||
|
||||
* **Search Query**: Enter a natural language text string for semantic search.
|
||||
|
||||
When you apply a filter that has a **Search Query**, only documents matching the search query are included.
|
||||
It is recommended that you also use the **Score Threshold** setting to avoid returning irrelevant documents.
|
||||
|
||||
* **Data Sources**: Select specific files and folders to include in the filter.
|
||||
|
||||
This is useful if you want to create a filter for a specific project or topic and you know the specific documents you want to include.
|
||||
Similarly, if you upload a folder of documents or enable an OAuth connector, you might want to create a filter that only includes the documents from that source.
|
||||
3. To modify the filter, click <Icon name="Library" aria-hidden="true"/> **Knowledge**, and then click your new filter. You can edit the following settings:
|
||||
|
||||
* **Search Query**: Enter text for semantic search, such as `financial reports from Q4`.
|
||||
* **Data Sources**: Select specific data sources or folders to include.
|
||||
* **Document Types**: Filter by file type.
|
||||
|
||||
* **Owners**: Filter by the user that uploaded the documents.
|
||||
* **Connectors**: Filter by [upload source](/ingestion), such as the local file system or a Google Drive OAuth connector.
|
||||
* **Response Limit**: Set the maximum number of results to return from the knowledge base. The default is `10`.
|
||||
* **Score Threshold**: Set the minimum relevance score for similarity search. The default score is `0`.
|
||||
|
||||
<PartialAnonymousUserOwner />
|
||||
|
||||
* **Connectors**: Filter by [upload source](/ingestion), such as the local file system or an OAuth connector.
|
||||
|
||||
* **Response Limit**: Set the maximum number of results to return from the knowledge base. The default is `10`, which means the filter returns only the top 10 most relevant documents.
|
||||
|
||||
* **Score Threshold**: Set the minimum relevance score for similarity search. The default score is `0`. A threshold is recommended to avoid returned irrelevant documents.
|
||||
|
||||
6. Click **Create Filter**.
|
||||
|
||||
## Edit a filter
|
||||
|
||||
To modify a filter, click <Icon name="Library" aria-hidden="true"/> **Knowledge**, and then click the filter you want to edit in the **Knowledge Filters** list.
|
||||
On the filter settings pane, edit the filter as desired, and then click **Update Filter**.
|
||||
4. To save your changes, click **Update Filter**.
|
||||
|
||||
## Apply a filter {#apply-a-filter}
|
||||
|
||||
In the OpenRAG <Icon name="MessageSquare" aria-hidden="true"/> **Chat**, click <Icon name="Funnel" aria-hidden="true"/> **Filter**, and then select the filter to apply.
|
||||
Chat filters apply to one chat session only.
|
||||
* **Apply a global filter**: Click <Icon name="Library" aria-hidden="true"/> **Knowledge**, and then enable the toggle next to your preferred filter. Only one filter can be the global filter. The global filter applies to all chat sessions.
|
||||
|
||||
You can also use filters when [browsing your knowledge base](/knowledge#browse-knowledge).
|
||||
This is a helpful way to test filters and manage knowledge bases that have many documents.
|
||||
* **Apply a chat filter**: In the <Icon name="MessageSquare" aria-hidden="true"/> **Chat** window, click <Icon name="Funnel" aria-hidden="true"/> **Filter**, and then select the filter to apply.
|
||||
Chat filters apply to one chat session only.
|
||||
|
||||
## Delete a filter
|
||||
|
||||
1. Click <Icon name="Library" aria-hidden="true"/> **Knowledge**.
|
||||
|
||||
2. In the **Knowledge Filters** list, click the filter that you want to delete.
|
||||
2. Click the filter that you want to delete.
|
||||
|
||||
3. In the filter settings pane, click **Delete Filter**.
|
||||
3. Click **Delete Filter**.
|
||||
|
|
@ -5,7 +5,6 @@ slug: /knowledge
|
|||
|
||||
import Icon from "@site/src/components/icon/icon";
|
||||
import PartialOpenSearchAuthMode from '@site/docs/_partial-opensearch-auth-mode.mdx';
|
||||
import PartialAnonymousUserOwner from '@site/docs/_partial-anonymous-user-owner.mdx';
|
||||
|
||||
OpenRAG includes a built-in [OpenSearch](https://docs.opensearch.org/latest/) instance that serves as the underlying datastore for your _knowledge_ (documents).
|
||||
This specialized database is used to store and retrieve your documents and the associated vector data (embeddings).
|
||||
|
|
@ -24,61 +23,17 @@ You can configure how documents are ingested and how the **Chat** interacts with
|
|||
The **Knowledge** page lists the documents OpenRAG has ingested into your OpenSearch database, specifically in an [OpenSearch index](https://docs.opensearch.org/latest/getting-started/intro/#index) named `documents`.
|
||||
|
||||
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.
|
||||
|
||||
### Inspect knowledge
|
||||
|
||||
For each document, the **Knowledge** page provides the following information:
|
||||
|
||||
* **Source**: Name of the ingested content, such as the file name.
|
||||
|
||||
* **Size**
|
||||
|
||||
* **Type**
|
||||
|
||||
* **Owner**: User that uploaded the document.
|
||||
|
||||
<PartialAnonymousUserOwner />
|
||||
|
||||
* **Chunks**: Number of chunks created by splitting the document during ingestion.
|
||||
|
||||
Click a document to view the individual chunks and technical details related to chunking.
|
||||
If the chunks seem incorrect or incomplete, see [Troubleshoot ingestion](/ingestion#troubleshoot-ingestion).
|
||||
|
||||
* **Avg score**: Average similarity score across all chunks of the document.
|
||||
|
||||
If you [search the knowledge base](#search-knowledge), the **Avg score** column shows the similarity score for your search query or filter.
|
||||
|
||||
* **Embedding model** and **Dimensions**: The embedding model and dimensions used to embed the chunks.
|
||||
|
||||
* **Status**: Status of document ingestion.
|
||||
If ingestion is complete and successful, then the status is **Active**.
|
||||
For more information, see [Monitor ingestion](/ingestion#monitor-ingestion).
|
||||
|
||||
### Search knowledge {#search-knowledge}
|
||||
|
||||
You can use the search field on the **Knowledge** page to find documents using semantic search and knowledge filters:
|
||||
|
||||
To search all documents, enter a search string in the search field, and then press <kbd>Enter</kbd>.
|
||||
|
||||
To apply a [knowledge filter](/knowledge-filters), select the filter from the **Knowledge Filters** list.
|
||||
The filter settings pane opens, and the filter appears in the search field.
|
||||
To remove the filter, close the filter settings pane or clear the filter from the search field.
|
||||
|
||||
You can use the filter alone or in combination with a search string.
|
||||
If a knowledge filter has a **Search Query**, that query is applied in addition to any text string you enter in the search field.
|
||||
|
||||
Only one filter can be applied at a time.
|
||||
Click a document to view the chunks produced from splitting the document during ingestion.
|
||||
|
||||
### Default documents {#default-documents}
|
||||
|
||||
By default, OpenRAG includes some initial documents about OpenRAG.
|
||||
These documents are ingested automatically during the [application onboarding process](/install#application-onboarding).
|
||||
|
||||
You can use these documents to ask OpenRAG about itself, or to test the [**Chat**](/chat) feature before uploading your own documents.
|
||||
You can use these documents to ask OpenRAG about itself, and to test the [**Chat**](/chat) feature before uploading your own documents.
|
||||
|
||||
If you [delete these documents](#delete-knowledge), then you won't be able to ask OpenRAG about itself and it's own functionality.
|
||||
If you [delete](#delete-knowledge) these documents, you won't be able to ask OpenRAG about itself and it's own functionality.
|
||||
It is recommended that you keep these documents, and use [filters](/knowledge-filters) to separate them from your other knowledge.
|
||||
An **OpenRAG Docs** filter is created automatically for these documents.
|
||||
|
||||
## OpenSearch authentication and document access {#auth}
|
||||
|
||||
|
|
@ -94,7 +49,7 @@ An [OpenSearch index](https://docs.opensearch.org/latest/getting-started/intro/#
|
|||
By default, all documents you upload to your OpenRAG knowledge base are stored in an index named `documents`.
|
||||
|
||||
It is possible to change the index name by [editing the ingestion flow](/agents#inspect-and-modify-flows).
|
||||
However, this can impact dependent processes, such as the [filters](/knowledge-filters) and [**Chat**](/chat), that reference the `documents` index by default.
|
||||
However, this can impact dependent processes, such as the [filters](/knowledge-filters) and [**Chat**](/chat) flow, that reference the `documents` index by default.
|
||||
Make sure you edit other flows as needed to ensure all processes use the same index name.
|
||||
|
||||
If you encounter errors or unexpected behavior after changing the index name, you can [revert the flows to their original configuration](/agents#revert-a-built-in-flow-to-its-original-configuration), or [delete knowledge](/knowledge#delete-knowledge) to clear the existing documents from your knowledge base.
|
||||
|
|
@ -126,10 +81,8 @@ The default embedding dimension is `1536`, and the default model is the OpenAI `
|
|||
If you want to use an unsupported model, you must manually set the model in your [OpenRAG `.env` file](/reference/configuration).
|
||||
If you use an unsupported embedding model that doesn't have defined dimensions in `settings.py`, then OpenRAG falls back to the default dimensions (1536) and logs a warning. OpenRAG's OpenSearch instance and flows continue to work, but [similarity search](https://www.ibm.com/think/topics/vector-search) quality can be affected if the actual model dimensions aren't 1536.
|
||||
|
||||
To change the embedding model after onboarding, modify the embedding model configuration on the OpenRAG **Settings** page or in your [OpenRAG `.env` file](/reference/configuration).
|
||||
This ensures that all relevant [OpenRAG flows](/agents) are updated to use the new embedding model configuration.
|
||||
|
||||
If you edit these settings in the `.env` file, you must [stop and restart the OpenRAG containers](/manage-services#stop-and-start-containers) to apply the changes.
|
||||
To change the embedding model after onboarding, it is recommended that you modify the embedding model setting in the OpenRAG **Settings** page or in your [OpenRAG `.env` file](/reference/configuration).
|
||||
This will automatically update all relevant [OpenRAG flows](/agents) to use the new embedding model configuration.
|
||||
|
||||
### Set Docling parameters
|
||||
|
||||
|
|
@ -137,39 +90,32 @@ OpenRAG uses [Docling](https://docling-project.github.io/docling/) for document
|
|||
|
||||
When you [upload documents](/ingestion), Docling processes the files, splits them into chunks, and stores them as separate, structured documents in your OpenSearch knowledge base.
|
||||
|
||||
#### Select a Docling implementation {#select-a-docling-implementation}
|
||||
|
||||
You can use either Docling Serve or OpenRAG's built-in Docling ingestion pipeline to process documents.
|
||||
|
||||
* **Docling Serve ingestion**: By default, OpenRAG uses [Docling Serve](https://github.com/docling-project/docling-serve).
|
||||
It starts a local `docling serve` process, and then runs Docling ingestion through the Docling Serve API.
|
||||
This means that OpenRAG starts a `docling serve` process on your local machine and runs Docling ingestion through an API service.
|
||||
|
||||
To use a remote `docling serve` instance or your own local instance, set `DOCLING_SERVE_URL=http://**HOST_IP**:5001` in your [OpenRAG `.env` file](/reference/configuration#document-processing-settings).
|
||||
The service must run on port 5001.
|
||||
* **Built-in Docling ingestion**: If you want to use OpenRAG's built-in Docling ingestion pipeline instead of the separate Docling Serve service, set `DISABLE_INGEST_WITH_LANGFLOW=true` in your [OpenRAG environment variables](/reference/configuration#document-processing-settings).
|
||||
|
||||
* **Built-in Docling ingestion**: If you want to use OpenRAG's built-in Docling ingestion pipeline instead of the separate Docling Serve service, set `DISABLE_INGEST_WITH_LANGFLOW=true` in your [OpenRAG `.env` file](/reference/configuration#document-processing-settings).
|
||||
The built-in pipeline uses the Docling processor directly instead of through the Docling Serve API.
|
||||
For the underlying functionality, see [`processors.py`](https://github.com/langflow-ai/openrag/blob/main/src/models/processors.py#L58) in the OpenRAG repository.
|
||||
The built-in pipeline uses the Docling processor directly instead of through the Docling Serve API.
|
||||
|
||||
#### Configure Docling ingestion settings
|
||||
For the underlying functionality, see [`processors.py`](https://github.com/langflow-ai/openrag/blob/main/src/models/processors.py#L58) in the OpenRAG repository.
|
||||
|
||||
To modify the Docling document processing and embedding parameters, click <Icon name="Settings2" aria-hidden="true"/> **Settings** in OpenRAG, and then find the **Knowledge Ingest** section.
|
||||
To modify the Docling ingestion and embedding parameters, click <Icon name="Settings2" aria-hidden="true"/> **Settings** in the OpenRAG user interface.
|
||||
|
||||
:::tip
|
||||
The TUI warns you if `docling serve` isn't running.
|
||||
OpenRAG warns you if `docling serve` isn't running.
|
||||
For information about starting and stopping OpenRAG native services, like Docling, see [Manage OpenRAG services](/manage-services).
|
||||
:::
|
||||
|
||||
You can edit the following parameters:
|
||||
|
||||
* **Embedding model**: Select the model to use to generate vector embeddings for your documents.
|
||||
|
||||
This is initially set during installation.
|
||||
The recommended way to change this setting is in the OpenRAG <Icon name="Settings2" aria-hidden="true"/> **Settings** or your [OpenRAG `.env` file](/reference/configuration).
|
||||
This ensures that all relevant [OpenRAG flows](/agents) are updated to use the new embedding model configuration.
|
||||
The recommended way to change this setting is in the OpenRAG **Settings** or your [OpenRAG `.env` file](/reference/configuration).
|
||||
This will automatically update all relevant [OpenRAG flows](/agents) to use the new embedding model configuration.
|
||||
|
||||
If you uploaded documents prior to changing the embedding model, you can [create filters](/knowledge-filters) to separate documents embedded with different models, or you can reupload all documents to regenerate embeddings with the new model.
|
||||
If you want to use multiple embeddings models, similarity search (in the **Chat**) can take longer as it searches each model's embeddings separately.
|
||||
If you want to use multiple embeddings models, similarity search (in the **Chat**) can take longer as it searching each model's embeddings separately.
|
||||
|
||||
* **Chunk size**: Set the number of characters for each text chunk when breaking down a file.
|
||||
Larger chunks yield more context per chunk, but can include irrelevant information. Smaller chunks yield more precise semantic search, but can lack context.
|
||||
|
|
@ -179,7 +125,7 @@ The default value is 1000 characters, which is usually a good balance between co
|
|||
Use larger overlap values for documents where context is most important. Use smaller overlap values for simpler documents or when optimization is most important.
|
||||
The default value is 200 characters, which represents an overlap of 20 percent if the **Chunk size** is 1000. This is suitable for general use. For faster processing, decrease the overlap to approximately 10 percent. For more complex documents where you need to preserve context across chunks, increase it to approximately 40 percent.
|
||||
|
||||
* **Table structure**: Enables Docling's [`DocumentConverter`](https://docling-project.github.io/docling/reference/document_converter/) tool for parsing tables. Instead of treating tables as plain text, tables are output as structured table data with preserved relationships and metadata. This option is enabled by default.
|
||||
* **Table Structure**: Enables Docling's [`DocumentConverter`](https://docling-project.github.io/docling/reference/document_converter/) tool for parsing tables. Instead of treating tables as plain text, tables are output as structured table data with preserved relationships and metadata. This option is enabled by default.
|
||||
|
||||
* **OCR**: Enables Optical Character Recognition (OCR) processing when extracting text from images and ingesting scanned documents. This setting is best suited for processing text-based documents faster with Docling's [`DocumentConverter`](https://docling-project.github.io/docling/reference/document_converter/). Images are ignored and not processed.
|
||||
|
||||
|
|
@ -201,12 +147,7 @@ To change this location, modify the **Documents Paths** variable in either the [
|
|||
This is a destructive operation that cannot be undone.
|
||||
:::
|
||||
|
||||
To delete documents from your knowledge base, click <Icon name="Library" aria-hidden="true"/> **Knowledge**, use the checkboxes to select one or more documents, and then click **Delete**.
|
||||
If you select the checkbox at the top of the list, all documents are selected and your entire knowledge base will be deleted.
|
||||
|
||||
To delete an individual document, you can also click <Icon name="Ellipsis" aria-hidden="true"/> **More** next to that document, and then select **Delete**.
|
||||
|
||||
To completely clear your entire knowledge base and OpenSearch index, [reset your OpenRAG containers](/manage-services#reset-containers) or [reinstall OpenRAG](/reinstall).
|
||||
To clear your entire knowledge base, [reset your OpenRAG containers](/manage-services#reset-containers) or [reinstall OpenRAG](/reinstall).
|
||||
|
||||
## See also
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ The following variables are required or recommended:
|
|||
|
||||
## Start services
|
||||
|
||||
1. To use the default Docling Serve implementation, start `docling serve` on port 5001 on the host machine using the included script:
|
||||
1. Start `docling serve` on port 5001 on the host machine:
|
||||
|
||||
```bash
|
||||
uv run python scripts/docling_ctl.py start --port 5001
|
||||
|
|
@ -97,17 +97,11 @@ The following variables are required or recommended:
|
|||
Docling cannot run inside a Docker container due to system-level dependencies, so you must manage it as a separate service on the host machine.
|
||||
For more information, see [Stop, start, and inspect native services](/manage-services#start-native-services).
|
||||
|
||||
Port 5001 is required to deploy OpenRAG successfully; don't use a different port.
|
||||
This port is required to deploy OpenRAG successfully; don't use a different port.
|
||||
Additionally, this enables the [MLX framework](https://opensource.apple.com/projects/mlx/) for accelerated performance on Apple Silicon Mac machines.
|
||||
|
||||
:::tip
|
||||
If you don't want to use the default Docling Serve implementation, see [Select a Docling implementation](/knowledge#select-a-docling-implementation).
|
||||
:::
|
||||
|
||||
2. Confirm `docling serve` is running.
|
||||
|
||||
The following command checks the status of the default Docling Serve implementation:
|
||||
|
||||
```bash
|
||||
uv run python scripts/docling_ctl.py status
|
||||
```
|
||||
|
|
|
|||
|
|
@ -62,15 +62,12 @@ Some of these variables are immutable and can only be changed by redeploying Ope
|
|||
|
||||
Control how OpenRAG [processes and ingests documents](/ingestion) into your knowledge base.
|
||||
|
||||
Most of these settings can be configured on the OpenRAG **Settings** page or in the `.env` file.
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `CHUNK_OVERLAP` | `200` | Overlap between chunks. |
|
||||
| `CHUNK_SIZE` | `1000` | Text chunk size for document processing. |
|
||||
| `DISABLE_INGEST_WITH_LANGFLOW` | `false` | Disable Langflow ingestion pipeline. |
|
||||
| `DOCLING_OCR_ENGINE` | Set by OS | OCR engine for document processing. For macOS, `ocrmac`. For any other OS, `easyocr`. |
|
||||
| `DOCLING_SERVE_URL` | `http://**HOST_IP**:5001` | URL for the [Docling Serve instance](/knowledge#select-a-docling-implementation). By default, OpenRAG starts a local `docling serve` process and auto-detects the host. To use your own local or remote Docling Serve instance, set this variable to the full path to the target instance. The service must run on port 5001. |
|
||||
| `OCR_ENABLED` | `false` | Enable OCR for image processing. |
|
||||
| `OPENRAG_DOCUMENTS_PATH` | `~/.openrag/documents` | The [local documents path](/knowledge#set-the-local-documents-path) for ingestion. |
|
||||
| `PICTURE_DESCRIPTIONS_ENABLED` | `false` | Enable picture descriptions. |
|
||||
|
|
@ -99,7 +96,7 @@ For better security, it is recommended to set `LANGFLOW_SUPERUSER_PASSWORD` so t
|
|||
| `LANGFLOW_SUPERUSER_PASSWORD` | Not set | Langflow administrator password. If this variable isn't set, then the Langflow server starts _without_ authentication enabled. It is recommended to set `LANGFLOW_SUPERUSER_PASSWORD` so the [Langflow server starts with authentication enabled](https://docs.langflow.org/api-keys-and-authentication#start-a-langflow-server-with-authentication-enabled). |
|
||||
| `LANGFLOW_URL` | `http://localhost:7860` | URL for the Langflow instance. |
|
||||
| `LANGFLOW_CHAT_FLOW_ID`, `LANGFLOW_INGEST_FLOW_ID`, `NUDGES_FLOW_ID` | Built-in flow IDs | These variables are set automatically to the IDs of the chat, ingestion, and nudges [flows](/agents). The default values are found in [`.env.example`](https://github.com/langflow-ai/openrag/blob/main/.env.example). Only change these values if you want to replace a built-in flow with your own custom flow. The flow JSON must be present in your version of the OpenRAG codebase. For example, if you [deploy self-managed services](/docker), you can add the flow JSON to your local clone of the OpenRAG repository before deploying OpenRAG. |
|
||||
| `SYSTEM_PROMPT` | `You are a helpful AI assistant with access to a knowledge base. Answer questions based on the provided context.` | System prompt instructions for the agent driving the **Agent** flow (OpenRAG **Chat**). |
|
||||
| `SYSTEM_PROMPT` | `You are a helpful AI assistant with access to a knowledge base. Answer questions based on the provided context.` | System prompt instructions for the agent driving the **Chat** flow. |
|
||||
|
||||
## OAuth provider settings
|
||||
|
||||
|
|
|
|||
|
|
@ -82,11 +82,6 @@ const sidebars = {
|
|||
},
|
||||
"support/contribute",
|
||||
"support/troubleshoot",
|
||||
{
|
||||
type: "link",
|
||||
label: "Changelog",
|
||||
href: "https://github.com/langflow-ai/openrag/releases",
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,6 @@
|
|||
"name": "frontend",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"engines": {
|
||||
"node": ">=20.20.0"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "next dev",
|
||||
"build": "next build",
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue