writinwaters
commited on
Commit
·
1944669
1
Parent(s):
454aa85
[doc] Minor editorial updates. (#1115)
Browse files### What problem does this PR solve?
_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._
### Type of change
- [x] Documentation Update
docs/guides/llm_api_key_setup.md
CHANGED
@@ -9,7 +9,7 @@ An API key is required for RAGFlow to interact with an online AI model. This gui
|
|
9 |
|
10 |
## Get your API key
|
11 |
|
12 |
-
For now, RAGFlow supports the following online LLMs.
|
13 |
|
14 |
- [OpenAI](https://platform.openai.com/login?launch),
|
15 |
- [Tongyi-Qianwen](https://dashscope.console.aliyun.com/model),
|
@@ -39,7 +39,8 @@ You have two options for configuring your API key:
|
|
39 |
- Update `base_url` if you use a proxy to connect to the remote service.
|
40 |
3. Reboot your system for your changes to take effect.
|
41 |
4. Log into RAGFlow.
|
42 |
-
|
|
|
43 |
|
44 |
### Configure API key after logging into RAGFlow
|
45 |
|
@@ -47,14 +48,14 @@ You have two options for configuring your API key:
|
|
47 |
After logging into RAGFlow, configuring API key through the **service_conf.yaml** file will no longer take effect.
|
48 |
:::
|
49 |
|
50 |
-
After logging into RAGFlow, you
|
51 |
|
52 |
1. Click on your logo on the top right of the page **>** **Model Providers**.
|
53 |
2. Find your model card under **Models to be added** and click **Add the model**:
|
54 |

|
55 |
3. Paste your API key.
|
56 |
4. Fill in your base URL if you use a proxy to connect to the remote service.
|
57 |
-
5. Click OK to confirm your changes.
|
58 |
|
59 |
:::note
|
60 |
If you wish to update an existing API key at a later point:
|
|
|
9 |
|
10 |
## Get your API key
|
11 |
|
12 |
+
For now, RAGFlow supports the following online LLMs. Click the corresponding link to apply for your API key. Most LLM providers grant newly-created accounts trial credit, which will expire in a couple of months, or a promotional amount of free quota.
|
13 |
|
14 |
- [OpenAI](https://platform.openai.com/login?launch),
|
15 |
- [Tongyi-Qianwen](https://dashscope.console.aliyun.com/model),
|
|
|
39 |
- Update `base_url` if you use a proxy to connect to the remote service.
|
40 |
3. Reboot your system for your changes to take effect.
|
41 |
4. Log into RAGFlow.
|
42 |
+
|
43 |
+
*After logging into RAGFlow, you will find your chosen model appears under **Added models** on the **Model Providers** page.*
|
44 |
|
45 |
### Configure API key after logging into RAGFlow
|
46 |
|
|
|
48 |
After logging into RAGFlow, configuring API key through the **service_conf.yaml** file will no longer take effect.
|
49 |
:::
|
50 |
|
51 |
+
After logging into RAGFlow, you can *only* configure API Key on the **Model Providers** page:
|
52 |
|
53 |
1. Click on your logo on the top right of the page **>** **Model Providers**.
|
54 |
2. Find your model card under **Models to be added** and click **Add the model**:
|
55 |

|
56 |
3. Paste your API key.
|
57 |
4. Fill in your base URL if you use a proxy to connect to the remote service.
|
58 |
+
5. Click **OK** to confirm your changes.
|
59 |
|
60 |
:::note
|
61 |
If you wish to update an existing API key at a later point:
|