OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
finish browse knowledge, add back partial
April Me1b1172133c3
diff --git a/docs/docs/_partial-anonymous-user-owner.mdx b/docs/docs/_partial-anonymous-user-owner.mdxnew file mode 100644index 000000000..35544305e--- /dev/null+++ b/docs/docs/_partial-anonymous-user-owner.mdx@@ -0,0 +1 @@+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).\ No newline at end of filediff --git a/docs/docs/_partial-ingestion-flow.mdx b/docs/docs/_partial-ingestion-flow.mdxindex 24a874753..5c32304d9 100644--- a/docs/docs/_partial-ingestion-flow.mdx+++ b/docs/docs/_partial-ingestion-flow.mdx@@ -17,7 +17,7 @@ The **OpenSearch Ingestion** flow is comprised of several components that work t* [**Embedding Model** component](https://docs.langflow.org/components-embedding-models): Generates vector embeddings using your selected [embedding model](/ingestion-configure#set-the-embedding-model-and-dimensions).* [**OpenSearch** component](https://docs.langflow.org/bundles-elastic#opensearch): Stores the processed documents and their embeddings in your OpenRAG [OpenSearch knowledge base](/knowledge).- The default address for the OpenSearch knowledge base is `https://opensearch:9200`. To change this address, edit the `OPENSEARCH_PORT` [environment variable](/reference/configuration#opensearch-settings).+ The default address for the OpenSearch knowledge base is `https://localhost:9200`. To change this address, edit the `OPENSEARCH_PORT` [environment variable](/reference/configuration#opensearch-settings).The default authentication method is JSON Web Token (JWT) authentication. If you [edit the flow](/agents#inspect-and-modify-flows), you can select `basic` auth mode, which uses the `OPENSEARCH_USERNAME` and `OPENSEARCH_PASSWORD` [environment variables](/reference/configuration#opensearch-settings) for authentication instead of JWT.diff --git a/docs/docs/core-components/knowledge-browse.mdx b/docs/docs/core-components/knowledge-browse.mdxindex 40f800b9d..a318f0182 100644--- a/docs/docs/core-components/knowledge-browse.mdx+++ b/docs/docs/core-components/knowledge-browse.mdx@@ -4,10 +4,11 @@ slug: /knowledge-browse---import Icon from "@site/src/components/icon/icon";+import PartialAnonymousUserOwner from '@site/docs/_partial-anonymous-user-owner.mdx';-The **Knowledge** page lists the documents OpenRAG has ingested into your [OpenSearch knowledge base](/knowledge), specifically in an [OpenSearch index](/knowledge#index) named `documents`.+The **Knowledge** page lists the documents that have been [ingested](/ingestion) into your [OpenSearch knowledge base](/knowledge), specifically in an [OpenSearch index](/knowledge#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.+To explore the contents of your knowledge base, click <Icon name="Library" aria-hidden="true"/> **Knowledge** to get a list of all ingested documents.## Inspect knowledge@@ -33,6 +34,7 @@ For each document, the **Knowledge** page provides the following information: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.+The embedding model, dimensions, chunks, and other ingestion behaviors are determined by the [knowledge ingestion settings](/ingestion-configure) that you set before uploading a document.* **Status**: Status of document ingestion.If ingestion is complete and successful, then the status is **Active**.@@ -56,14 +58,18 @@ Only one filter can be applied at a time.## 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).+These documents are ingested automatically during the [application onboarding process](/install#application-onboarding) if you use the [default local documents path](/ingestion-configure#set-the-local-documents-path).You can use these documents to ask OpenRAG about itself, or 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 these documents](#delete-knowledge), then you won't be able to ask OpenRAG about itself and its own functionality unless you re-ingest those documents.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.+## Add knowledge++Add knowledge to your knowledge base by [ingesting documents](/ingestion).+## Delete knowledge {#delete-knowledge}:::warningdiff --git a/docs/docs/core-components/knowledge-connectors.mdx b/docs/docs/core-components/knowledge-connectors.mdxindex 8ad4cf156..5d8f4c725 100644--- a/docs/docs/core-components/knowledge-connectors.mdx+++ b/docs/docs/core-components/knowledge-connectors.mdx@@ -21,14 +21,6 @@ Knowledge ingestion settings (reorg/cleanup)Don't recommend unsupported models. Enable models thru the settings page only.See also: Configure connectors-Browse and manage knowledge (new page)-Browse knowledge-Inspect-Search-Default docs-Delete-See also: Local doc path setting, filter knowledge, ingest knowledge-Configure connectors (new page)Oauth modeCloud storage connector setupdiff --git a/docs/docs/core-components/knowledge-filters.mdx b/docs/docs/core-components/knowledge-filters.mdxindex 0b7c04023..ac059216d 100644--- a/docs/docs/core-components/knowledge-filters.mdx+++ b/docs/docs/core-components/knowledge-filters.mdx@@ -4,6 +4,7 @@ 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.@@ -54,7 +55,7 @@ This is purely cosmetic, but it can help you visually distinguish different sets* **Owners**: Filter by the user that uploaded the documents.- 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).+ <PartialAnonymousUserOwner />* **Connectors**: Filter by [upload source](/ingestion), such as the local file system or a cloud storage connector.diff --git a/docs/docs/core-components/knowledge.mdx b/docs/docs/core-components/knowledge.mdxindex 986525eab..565dfc29e 100644--- a/docs/docs/core-components/knowledge.mdx+++ b/docs/docs/core-components/knowledge.mdx@@ -35,6 +35,12 @@ Make sure you edit other flows as needed to ensure all processes use the same inIf 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-browse#delete-knowledge) to clear the existing documents from your knowledge base.+## OpenSearch service port++You can access your OpenRAG OpenSearch dashboard directly at `https://localhost:9200`.++To change the port used by the OpenSearch service, edit the `OPENSEARCH_PORT` [environment variable](/reference/configuration#opensearch-settings).+## See also* [Ingest knowledge](/ingestion)diff --git a/docs/docs/reference/configuration.mdx b/docs/docs/reference/configuration.mdxindex 561674cf8..75ea18b7c 100644--- a/docs/docs/reference/configuration.mdx+++ b/docs/docs/reference/configuration.mdx@@ -142,7 +142,7 @@ Configure OpenSearch database authentication.| `OPENSEARCH_PASSWORD` | Must be set during setup or in the Dockerfile. | Required. OpenSearch administrator password. Must adhere to the [OpenSearch password complexity requirements](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). You must set this directly in the `.env` or in the TUI's [**Basic/Advanced Setup**](/install#setup). |<!-- | `OPENSEARCH_HOST` | `localhost` | OpenSearch service host. | -->-<!-- | `OPENSEARCH_PORT` | `9200` | OpenSearch service port. | -->+<!-- | `OPENSEARCH_PORT` | `9200` | OpenSearch service port. | [if not configurable, edit other instances of OPENSEARCH_PORT in the docs] --><!-- | `OPENSEARCH_USERNAME` | `admin` | OpenSearch administrator username. | -->## System settings