From 18a41f2eadeb4d297d3a5f9f22c717b1b453369f Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Fri, 26 Sep 2025 17:11:14 -0400 Subject: [PATCH] more-on-local-models --- docs/docs/get-started/install.mdx | 5 ++-- docs/docs/get-started/quickstart.mdx | 41 ++++++++++++++++++++++++++-- 2 files changed, 41 insertions(+), 5 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 68a935fa..d96edf8b 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -83,11 +83,12 @@ For more information on virtual environments, see [uv](https://docs.astral.sh/uv The application opens. 8. Select your language model and embedding model provider, and complete the required fields. **Your provider can only be selected once, and you must use the same provider for your language model and embedding model. - To change your selection, you must restart OpenRAG.** + To change your provider selection, you must restart OpenRAG and delete the `config.yml` file.** + **Your language model can be changed, but your embeddings model cannot be changed.** - 9. You already entered a value for `OPENAI_API_KEY` in the TUI in Step 5, so enable **Get API key from environment variable**. + 9. If you already entered a value for `OPENAI_API_KEY` in the TUI in Step 5, enable **Get API key from environment variable**. 10. Under **Advanced settings**, select your **Embedding Model** and **Language Model**. 11. To load 2 sample PDFs, enable **Sample dataset**. This is recommended, but not required. diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx index 27361200..90fb1eaf 100644 --- a/docs/docs/get-started/quickstart.mdx +++ b/docs/docs/get-started/quickstart.mdx @@ -12,7 +12,40 @@ Get started with OpenRAG by loading your knowledge, swapping out your language m ## Prerequisites - [Install and start OpenRAG](/install) -- [Langflow API key](/) +- Create a [Langflow API key](https://docs.langflow.org/api-keys-and-authentication) +
+ Create a Langflow API key + + A Langflow API key is a user-specific token you can use with Langflow. + It is **only** used for sending requests to the Langflow server. + It does **not** access to OpenRAG. + + To create a Langflow API key, do the following: + + 1. In Langflow, click your user icon, and then select **Settings**. + 2. Click **Langflow API Keys**, and then click
## Find your way around @@ -44,12 +77,14 @@ If you aren't getting the results you need, you can further tune the knowledge i To modify the knowledge ingestion or Agent behavior, click